API reference

API reference · Prompts

One prompt with every version

GET/api/account/prompts/{id}Signed in session

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredstringpmpt_ id.

Answer 200

Versions newest first.

Fields of the 200 answer
FieldTypeWhat it is
promptobject
prompt.idstring
prompt.namestring
prompt.descriptionstring or null
prompt.latestVersioninteger
prompt.labelsobjectLabel to version.
prompt.createdAtinteger
prompt.updatedAtinteger
versionsarray of object
versions[].versioninteger
versions[].messagesarray of object
versions[].messages[].rolerequiredstringOne of "system", "developer", "user", "assistant".
versions[].messages[].contentrequiredstringText with {{variables}}: two braces, a name, two braces. At most 64000 characters.
versions[].variablesarray of string
versions[].modelstring or null
versions[].notestring or null
versions[].createdAtintegerEpoch ms.

Errors

  • 401OpenAI shaped error.
  • 404OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter