COcooper-square-technologies
Agents

Get an agent

Changed on

Retrieve an agent and its schema details.

Agents can have both a live published version and a draft version with newer unpublished changes. Use the version parameter to choose which state to return.

get/v1/agents/{agent_id}

Request

Path parameters

agent_idstring uuid required

The ID of the agent to retrieve.

Query parameters

version'published' | 'draft'

Version selector for retrieving a specific agent.

Version of the agent to retrieve. Use published for the live version, or draft for the latest unpublished changes for the same agent. Defaults to published.

Response

Successful Response

idstring uuid required

Unique ID for the agent.

organization_idstring uuid required

Unique ID of the organization that owns the agent.

namestring required

Display name of the agent.

status'draft' | 'published' | 'unknown' required

Current availability status for an agent.

created_atstring date-time required

When the agent was created.

descriptionstring nullable

Short description of the agent, if provided.

Changes

  • 56d428ca479fRevision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added subschema #2 to the response property anyOf list for the response status

  • c55c2a1636c3Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API