For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Start buildingGet support
DocumentationAPI ReferenceChangelogDiscord
  • Voices
    • POSTCreate voice
    • GETList voices
    • DELDelete voice
  • Text-to-Speech (TTS)
    • WSSStream Input
    • STREAMText-to-Speech (Streamed JSON)
    • POSTText-to-Speech (Streamed File)
    • POSTText-to-Speech (Json)
    • POSTText-to-Speech (File)
    • POSTVoice Conversion (Streamed File)
    • STREAMVoice Conversion (Streamed JSON)
  • Speech-to-speech (EVI)
    • WSSChat
      • POSTCreate prompt
      • GETList prompts
      • GETList prompt versions
      • GETGet prompt version
      • POSTCreate prompt version
      • PATCHUpdate prompt name
      • PATCHUpdate prompt description
      • DELDelete prompt
      • DELDelete prompt version
  • Expression Measurement API
Start buildingGet support
LogoLogo
LogoLogo
Speech-to-speech (EVI)Prompts

List prompt versions

GET
https://api.hume.ai/v0/evi/prompts/:id
GET
/v0/evi/prompts/:id
$curl https://api.hume.ai/v0/evi/prompts/your-prompt-id \
>     -H "X-Hume-Api-Key: <apiKey>" \
>     -H "Content-Type: application/json"
200Retrieved
1{
2  "page_number": 0,
3  "page_size": 10,
4  "prompts_page": [
5    {
6      "created_on": 1704067200,
7      "id": "af699d45-2985-42cc-91b9-af9e5da3bac5",
8      "modified_on": 1704067200,
9      "name": "Weather Assistant Prompt",
10      "text": "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
11      "version": 0,
12      "version_type": "FIXED",
13      "version_description": "Initial release of the weather assistant prompt"
14    }
15  ],
16  "total_pages": 1
17}

Fetches a list of a Prompt’s versions.

See our prompting guide for tips on crafting your system prompt.

Was this page helpful?
Previous

Get prompt version

Next
Built with

Authentication

X-Hume-Api-Keystring
API Key authentication via header

Path parameters

idstringRequiredformat: "uuid"

Query parameters

page_numberintegerOptionalDefaults to 0

Specifies the page number to retrieve, enabling pagination.

This 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.

page_sizeintegerOptional

Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.

For example, if page_size is set to 10, each page will include up to 10 items. Defaults to 10.

restrict_to_most_recentbooleanOptional

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.

Response

Success
page_numberinteger

The page number of the returned list.

This value corresponds to the page_number parameter specified in the request. Pagination uses zero-based indexing.

page_sizeinteger

The maximum number of items returned per page.

This value corresponds to the page_size parameter specified in the request.

prompts_pagelist of objects

List of prompts returned for the specified page_number and page_size.

total_pagesinteger
The total number of pages in the collection.