List agents

List agents

cURL

curl --request GET \
  --url https://agentgateway.atlan.engineering/agent/v1/agents \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "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
          }
        ]
      }
    }
  ],
  "page": {
    "limit": 1,
    "offset": 1,
    "total": 1
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

limit · integer<int32>

Required range: x >= 0

offset · integer<int32>

Required range: x >= 0

agent_framework_id · string

model_id · string

agent_provider_id · string

sort · string

Response

200

application/json

HTTP 200 response.

items · object[] · required

Show child attributes

page · object · required

Show child attributes