List all agents. | Scout API & SDK Reference

[
  {
    "created_by": {
      "type": "organization",
      "id": "org-12345"
    },
    "updated_by": {
      "type": "organization",
      "id": "org-12345"
    },
    "name": "Customer Support Bot",
    "parent": "root-agent",
    "visibility": {
      "type": "organization",
      "id": "org-12345"
    },
    "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
    "doc_type": "agent",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-04-10T11:45:00Z",
    "is_seed": true,
    "description": "An AI agent designed to handle customer inquiries and support tickets.",
    "profile_icon_fill": "#4A90E2",
    "profile_asset_url": "https://assets.example.com/agents/customer-support-bot.png",
    "active_revision": "rev-20240410-001",
    "from_persona": "support-specialist"
  }
]

Authentication

AuthorizationBearer

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

Response

Successful Response

created_byobject

updated_byobject

namestring

parentstring

visibilityobject

idstringOptional

doc_type"agent"Optional

created_atdatetimeOptional

updated_atdatetimeOptional

is_seedboolean or nullOptional

descriptionstring or nullOptional

profile_icon_fillstring or nullOptional

profile_asset_urlstring or nullOptional

active_revisionstring or nullOptional

from_personastring or nullOptional

$	curl https://api.scoutos.com/agents \
>	-H "Authorization: Bearer <token>"