Prompts

Create Agent Version

Changed on

create a new prompt version under /agents/{agent_id}/prompts/versions.

post/v1/agents/{agent_id}/prompts/versions

Request

  • Base URL
    https://api.getbluejay.ai
  • URL
    https://api.getbluejay.ai/v1/agents/{agent_id}/prompts/versions
  • Auth
    HTTPBearer (a scheme the document does not define)

Path parameters

agent_idinteger required

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

Request body

prompt_textstring nullable

Prompt content. Omit to copy the current latest version (MAX(version) / latest label) and increment. An empty string stores a blank prompt.

commit_messagestring nullable
labelsstring[] nullable
override_labelboolean nullable

When true, a label that already points at another version (including production) moves here.

metadataobject nullable

Response

Successful Response

idstring uuid nullable

the id of the prompt

prompt_textstring required

the prompt content

commit_messagestring nullable
labelsstring[] nullable

labels associated with the prompt

metadataobject nullable

arbitrary JSON metadata

versioninteger required

the version number of the prompt

agent_idinteger required

id of the agent that owns this prompt

Changes

  • 547d989af0efRevision changes
    • info

      api operation id create_prompt_version_agent_scoped_v1_agents__agent_id__prompts_versions_post removed and replaced with create_agent_version_v1_agents__agent_id__prompts_versions_post

    • info

      endpoint deprecated

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      request property list-of-types was widened by adding types null to media type application/json

  • aa501502e1fcRevision changes
    • info

      added the new optional header request parameter X-Organization-Id