Sign in

v2

latestOpenAPI 3.1.02026-07-262937191.0 MB
beta.agents

Retrieve an agent entity.

Given an agent, retrieve an agent entity with its attributes. The agent_version parameter can be an integer version number or a string alias.

get/v1/agents/{agent_id}

Path parameters

agent_idstring required

Query parameters

integer
OR
string

Response

Successful Response

instructionsstring nullable

Instruction prompt the model will follow during the conversation.

modelstring required
namestring required
descriptionstring nullable
handoffsstring[] nullable
metadataMetadataDict

Custom type for metadata with embedded validation.

object'agent'
idstring required
versioninteger required
versionsinteger[] required
created_atstring date-time required
updated_atstring date-time required
deployment_chatboolean required
sourcestring required
version_messagestring nullable

Example response

{
  "completion_args": {
    "response_format": {
      "type": "text"
    }
  }
}