Prompts

Get Agent Version By Label

Changed on

retrieve a single prompt by label under /agents/{agent_id}/prompts?label=... .

  • if label is missing -> 400
  • if label resolves to 0 -> 404; >1 -> 400 ambiguous (except latest which should be unique)
get/v1/agents/{agent_id}/prompts

Request

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

Path parameters

agent_idinteger required

Query parameters

labelstring nullable

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

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 get_prompt_by_label_agent_scoped_v1_agents__agent_id__prompts_get removed and replaced with get_agent_version_by_label_v1_agents__agent_id__prompts_get

    • info

      endpoint deprecated

  • aa501502e1fcRevision changes
    • info

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