Update an agent

Update an agent

cURL

curl --request PATCH \
  --url https://agentgateway.atlan.engineering/agent/v1/agents/{agent_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

200

{
  "artifact_status": "<string>",
  "commit_ts": "<string>",
  "content_hash_hex": "<string>",
  "created_at": "<string>",
  "created_by": "<string>",
  "extension": "<string>",
  "id": "<string>",
  "is_latest": true,
  "kind": "<string>",
  "name": "<string>",
  "source_type": "<string>",
  "updated_at": "<string>",
  "updated_by": "<string>",
  "version_ordinal": 123,
  "workspace_id": "<string>",
  "display_name": "<string>",
  "identity": {
    "client_id": "<string>",
    "credential_kind": "<string>",
    "api_key": "<string>",
    "expires_at": "<string>"
  },
  "oidc_client_id": "<string>",
  "owner_id": "<string>",
  "project_id": "<string>",
  "repo_id": "<string>",
  "source_created_at": "<string>",
  "source_created_by": "<string>",
  "source_digest": "<string>",
  "source_id": "<string>",
  "source_last_modified_at": "<string>",
  "source_last_modified_by": "<string>",
  "source_metadata": "<unknown>",
  "source_synced_at": "<string>",
  "source_uri": "<string>",
  "source_version": "<string>",
  "version_label": "<string>",
  "agent_framework_id": "<string>",
  "agent_provider_id": "<string>",
  "instructions": "<string>",
  "is_system": true,
  "max_step_count": 1,
  "model_id": "<string>",
  "tools": [
    {
      "kind": "builtin",
      "name": "<string>"
    }
  ],
  "permissions": {},
  "profile_image_url": "<string>",
  "relationships": {
    "count": 1,
    "incoming": [
      {
        "direction": "<string>",
        "provenance": "<string>",
        "rel_type": "<string>",
        "relationship_status": "<string>",
        "attributes": {},
        "confidence": 123,
        "from": {
          "id": "<string>",
          "kind": "<string>"
        },
        "label": "<string>",
        "role": "<string>",
        "to": {
          "id": "<string>",
          "kind": "<string>"
        },
        "weight": 123
      }
    ],
    "outgoing": [
      {
        "direction": "<string>",
        "provenance": "<string>",
        "rel_type": "<string>",
        "relationship_status": "<string>",
        "attributes": {},
        "confidence": 123,
        "from": {
          "id": "<string>",
          "kind": "<string>"
        },
        "label": "<string>",
        "role": "<string>",
        "to": {
          "id": "<string>",
          "kind": "<string>"
        },
        "weight": 123
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id · string · required

Body

application/json

agent_framework_id · string | null

agent_provider_id · string | null

display_name · string | null

instructions · string | null

max_step_count · integer<int32> | null

Required range: x >= 0

model_id · string | null

name · string | null

tools · object[] | null

Option 1

Option 2

Show child attributes

Response

200

application/json

HTTP 200 response.

artifact_status · string · required

commit_ts · string · required

content_hash_hex · string · required

created_at · string · required

created_by · string · required

extension · string · required

id · string · required

is_latest · boolean · required

kind · string · required

name · string · required

source_type · string · required

updated_at · string · required

updated_by · string · required

version_ordinal · integer<int64> · required

workspace_id · string · required

display_name · string

identity · null | object

Show child attributes

oidc_client_id · string | null

owner_id · string | null

project_id · string | null

repo_id · string | null

source_created_at · string | null

source_created_by · string | null

source_digest · string | null

source_id · string | null

source_last_modified_at · string | null

source_last_modified_by · string | null

source_metadata · any

source_synced_at · string | null

source_uri · string | null

source_version · string | null

version_label · string | null

agent_framework_id · string | null

agent_provider_id · string | null

instructions · string | null

is_system · boolean

max_step_count · integer<int32>

Required range: x >= 0

model_id · string | null

tools · object[]

Option 1

Option 2

Show child attributes

permissions · null | object

Show child attributes

profile_image_url · string | null

relationships · null | object

Show child attributes