Labels

List Labels

Changed on

list all free-standing labels for an agent; filter by substring with q.

get/v1/agents/{agent_id}/labels

Request

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

Path parameters

agent_idinteger required

Query parameters

qstring nullable

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

idstring uuid nullable
created_atstring date-time nullable
agent_idinteger required
label_textstring required
agent_version_idstring uuid nullable
knowledge_base_idstring uuid nullable
colorstring nullable
prompt_idstring uuid nullable

Deprecated alias of agent_version_id

Changes

  • 547d989af0efRevision changes
    • info

      added the optional property / to the response with the status

    • info

      response property items/prompt_id deprecated

  • aa501502e1fcRevision changes
    • info

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