Sign in
Agents

Update agent

Update an agent's mutable fields; a slug renames the handle and can never be cleared

patch/agents/{agentId}

Path parameters

agentIdstring required

Agent ID (agt_*).

Headers

Idempotency-Keystring required

Unique key for safely retrying a request without creating duplicates.

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Request body

Response

Successful Response

Changes

Changed in 4 of the 28 revisions of this API.324

  • 359d267dca881See the full diff
    • ○

      deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

  • b1ad79e918ac1See the full diff
    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

  • ba1fb54c59392See the full diff
    • ○

      added the new optional request property data/attributes/tags

      new-optional-request-property

    • ○

      added the required property data/attributes/tags to the response with the 200 status

      response-required-property-added

  • 270e233e401c32See the full diff
    • ▲

      request property data/attributes/slug list-of-types was narrowed by removing types null from media type application/json

      request-property-list-of-types-narrowed

    • ▲

      the data/attributes/name/anyOf[subschema #1]/ request property's maxLength was decreased to 32

      request-property-max-length-decreased

    • ▲

      added the pattern ^[a-z0-9][a-z0-9._]{1,28}[a-z0-9]$ to the request property data/attributes/slug

      request-property-pattern-added

    • ●

      for the header request parameter Idempotency-Key, the maxLength was set to 255

      request-parameter-max-length-set

    • ●

      the data/attributes/description/anyOf[subschema #1]/ request property's maxLength was set to 100

      request-property-max-length-set