List prompts | Hume API

{
  "page_number": 0,
  "page_size": 2,
  "prompts_page": [
    {
      "created_on": 1715267200693,
      "id": "af699d45-2985-42cc-91b9-af9e5da3bac5",
      "modified_on": 1715267200693,
      "name": "Weather Assistant Prompt",
      "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>",
      "version": 0,
      "version_type": "FIXED",
      "version_description": ""
    },
    {
      "created_on": 1715267200693,
      "id": "616b2b4c-a096-4445-9c23-64058b564fc2",
      "modified_on": 1715267200693,
      "name": "Web Search Assistant Prompt",
      "text": "<role>You are an AI web search assistant designed to help users find accurate and relevant information on the web. Respond to user queries promptly, using the built-in web search tool to retrieve up-to-date results. Present information clearly and concisely, summarizing key points where necessary. Use simple language and avoid technical jargon. If needed, provide helpful tips for refining search queries to obtain better results.</role>",
      "version": 0,
      "version_type": "FIXED",
      "version_description": ""
    }
  ],
  "total_pages": 1
}

Fetches a paginated list of Prompts.

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

Authentication

X-Hume-Api-Keystring

API Key authentication via header

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.

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.

namestringOptional

Filter to only include prompts with name.

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.

created_onlong

Time at which the Prompt was created. Measured in seconds since the Unix epoch.

idstring

Identifier for a Prompt. Formatted as a UUID.

modified_onlong

Time at which the Prompt was last modified. Measured in seconds since the Unix epoch.

namestring

Name applied to all versions of a particular Prompt.

textstring

Instructions used to shape EVI’s behavior, responses, and style.

You can use the Prompt to define a specific goal or role for EVI, specifying how it should act or what it should focus on during the conversation. For example, EVI can be instructed to act as a customer support representative, a fitness coach, or a travel advisor, each with its own set of behaviors and response styles. For help writing a system prompt, see our Prompting Guide.

versioninteger

Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique.

version_typeenum

Allowed values:

version_descriptionstring or nullOptional

An optional description of the Prompt version.

total_pagesinteger

The total number of pages in the collection.