Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
ai-prompt

Get a prompt

get/v1/ai-prompt/{id}

Path parameters

idstring required

Prompt identifier

Response

successful operation

idstring required

globally unique id

orgIdstring

org id, or null if this is a global prompt

namestring required

unique name

type'AUTO_CHAT' | 'CHAT' | 'CHAT_SHOULD_RESPOND' | 'CHAT_SUMMARY' | 'FORM_RESPONSE_SUMMARY' | 'REPORT_RESULT_SUMMARY' | 'SCENARIO_PLANNING' | 'CQL' | 'CQL_TRANSLATE' | 'PROMPT_SUGGEST' | 'JOB_CODE_MATCH' required

usecase for this prompt

parentAiPromptIdstring

cascading parent prompt

modelIdstring

comma-separated list of preferred models in priority order. When a ModelTier is provided, the list is interpreted as: 3 entries -> [HIGH, MEDIUM, LOW]; 2 entries -> [HIGH/MEDIUM, LOW]; 1 entry -> always that model. With no tier, the first entry is used.

systemPromptstring

the value of the system prompt that will provide model context. System prompts can use CQL, and will automatically be chained together with parent prompts' system prompts

userPromptstring

the value of the user prompt. User prompts can use CQL, and by convention will use {{content}} to refer to the inner content or data provided by the end user.

maxTokensinteger

Maximum number of tokens that the model can generate in response to the user prompt. This is a soft limit, and the model may generate fewer tokens.

maxStringLengthinteger

Maximum length of a string that the model can generate in response to the user prompt. This is a soft limit, and the model may generate shorter strings.

temperaturenumber double

Parameter that controls the randomness of the model's output. A value of 0.0 means the model will always choose the most likely next token, while a value of 1.0 means the model will choose tokens more randomly.

topPnumber double

An alternative to temperature, called nucleus sampling. This parameter controls the number of tokens that the model considers when generating a response. A value of 1.0 means the model will consider all tokens, while a value of 0.0 means the model will only consider the most likely token.

stopSequencesstring[]

An optional list of stop sequences that will cause the model to stop generating tokens when encountered. This can be useful for preventing the model from generating unwanted content or going off-topic.

usageCountinteger

The number of times this prompt has been used

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "parentAiPromptId": "588f7ee98f138b19220041a7",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}