v2

latestOpenAPI 3.1.02026-07-262937191.0 MB

beta.agents

Update an agent entity.

Update an agent attributes and create a new version.

patch/v1/agents/{agent_id}

agent_idstring required

instructionsstring nullable

Instruction prompt the model will follow during the conversation.

modelstring nullable

namestring nullable

descriptionstring nullable

handoffsstring[] nullable

deployment_chatboolean nullable

metadataMetadataDict

Custom type for metadata with embedded validation.

version_messagestring nullable

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

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

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