{
  "opencollection": "1.0.0",
  "info": {
    "name": "Speech-to-speech (EVI) subpackage_prompts API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_prompts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List prompts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hume.ai/v0/evi/prompts",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page_number",
                "value": "",
                "type": "query",
                "description": "Specifies the page number to retrieve, enabling pagination.\n\nThis parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.\n\nFor example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10."
              },
              {
                "name": "restrict_to_most_recent",
                "value": "",
                "type": "query",
                "description": "By default, `restrict_to_most_recent` is set to true, returning only the latest version of each prompt. To include all versions of each prompt in the list, set `restrict_to_most_recent` to false."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Filter to only include prompts with name."
              }
            ]
          },
          "docs": "Fetches a paginated list of **Prompts**.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt."
        },
        {
          "info": {
            "name": "Create prompt",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hume.ai/v0/evi/prompts",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt."
        },
        {
          "info": {
            "name": "List prompt versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hume.ai/v0/evi/prompts/:id",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "page_number",
                "value": "",
                "type": "query",
                "description": "Specifies the page number to retrieve, enabling pagination.\n\nThis parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.\n\nFor example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10."
              },
              {
                "name": "restrict_to_most_recent",
                "value": "",
                "type": "query",
                "description": "By default, `restrict_to_most_recent` is set to true, returning only the latest version of each prompt. To include all versions of each prompt in the list, set `restrict_to_most_recent` to false."
              }
            ]
          },
          "docs": "Fetches a list of a **Prompt's** versions.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt."
        },
        {
          "info": {
            "name": "Create prompt version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hume.ai/v0/evi/prompts/:id",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier for a Prompt. Formatted as a UUID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a **Prompt** by creating a new version of the **Prompt**.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt."
        },
        {
          "info": {
            "name": "Update prompt name",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.hume.ai/v0/evi/prompts/:id",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier for a Prompt. Formatted as a UUID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the name of a **Prompt**.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt."
        },
        {
          "info": {
            "name": "Delete prompt",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.hume.ai/v0/evi/prompts/:id",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier for a Prompt. Formatted as a UUID."
              }
            ]
          },
          "docs": "Deletes a **Prompt** and its versions.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt."
        },
        {
          "info": {
            "name": "Get prompt version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hume.ai/v0/evi/prompts/:id/version/:version",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier for a Prompt. Formatted as a UUID."
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "Version number for a Prompt.\n\nPrompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.\n\nVersion numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number."
              }
            ]
          },
          "docs": "Fetches a specified version of a **Prompt**.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt."
        },
        {
          "info": {
            "name": "Update prompt description",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.hume.ai/v0/evi/prompts/:id/version/:version",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier for a Prompt. Formatted as a UUID."
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "Version number for a Prompt.\n\nPrompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.\n\nVersion numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the description of a **Prompt**.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt."
        },
        {
          "info": {
            "name": "Delete prompt version",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.hume.ai/v0/evi/prompts/:id/version/:version",
            "headers": [
              {
                "name": "X-Hume-Api-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier for a Prompt. Formatted as a UUID."
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "Version number for a Prompt.\n\nPrompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.\n\nVersion numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number."
              }
            ]
          },
          "docs": "Deletes a specified version of a **Prompt**.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt."
        }
      ]
    }
  ],
  "bundled": true
}