agents

Update Agent

Update an agent's name, description, or serving model assignment.

patch/api/v1/agents/{agent_id}

Path parameters

agent_idstring required

Request body

namestring

New human-readable agent name. Omit to leave unchanged.

descriptionstring nullable

New agent description. Set to null to clear it; omit to leave unchanged.

model_slugstring nullable

Existing serving model slug in this organization. Set null to unassign it.

Response

Successful Response

agent_idstring required

Stable identifier for the agent.

organization_idstring required

Organization that owns the agent.

namestring required

Human-readable agent name.

descriptionstring nullable

Optional description of the agent's purpose.

created_atstring date-time required

Time the agent was created.

updated_atstring date-time required

Time the agent was last updated.

benchmark_idsstring[] required

Benchmarks owned by the agent.

model_slugstring nullable required

The agent's stable serving model slug.

Changes

Changed in 2 of the 26 revisions of this API.4

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      endpoint added

      endpoint-added