prompts

Get Prompt By Id

Changed on

Get a prompt by ID

get/api/v1/prompts/{prompt_id}

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/prompts/{prompt_id}
  • Auth
    API key in header Syllable-API-Key

Path parameters

prompt_idinteger required

Response

Successful Response

namestring required

The prompt name

descriptionstring nullable

The description of the prompt

labelsstring[] nullable

The prompt labels

typestring required

The type of the prompt

contextstring nullable

The prompt text that will be sent to the LLM at the beginning of the conversation

toolsstring[]

Names of the tools to which the prompt has access (DEPRECATED - use information from full tools field instead)

session_end_enabledboolean

Whether session end functionality is enabled for this prompt

session_end_tool_idinteger nullable

ID of the optional session end tool associated with the prompt

edit_commentsstring nullable

The comments for the most recent edit to the prompt

idinteger required

The internal ID of the prompt

last_updatedstring nullable required

The last updated date of the prompt

last_updated_bystring nullable

Email address of the user who most recently updated the prompt

agent_countinteger nullable

The number of agents using the prompt

version_numberinteger nullable

The version number of the current version of the prompt

Changes