For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scout DocsAccess Scout
API & SDK
API & SDK
  • Endpoints
      • STREAMSend messages to an agent and receive a streaming response.
      • POSTSend messages to an agent and receive a synchronous response.
      • STREAMSend messages to an agent within a session and receive a streaming response.
      • POSTSend messages to an agent within a session and receive a synchronous response.
      • POSTStart an async agent interaction with a callback URL.
      • POSTStart an async agent interaction with a callback URL within a session.
      • GETList all agents.
      • POSTCreate or update an agent.
      • GETGet an agent and its active revision.
      • DELDelete an agent.
LogoLogo
Scout DocsAccess Scout
EndpointsAgents

List all agents.

GET
https://api.scoutos.com/agents
GET
/agents
$curl https://api.scoutos.com/agents \
>     -H "Authorization: Bearer <token>"
200Retrieved
1[
2  {
3    "created_by": {
4      "type": "organization",
5      "id": "org-12345"
6    },
7    "updated_by": {
8      "type": "organization",
9      "id": "org-12345"
10    },
11    "name": "Customer Support Bot",
12    "parent": "root-agent",
13    "visibility": {
14      "type": "organization",
15      "id": "org-12345"
16    },
17    "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
18    "doc_type": "agent",
19    "created_at": "2024-01-15T09:30:00Z",
20    "updated_at": "2024-04-10T11:45:00Z",
21    "is_seed": true,
22    "description": "An AI agent designed to handle customer inquiries and support tickets.",
23    "profile_icon_fill": "#4A90E2",
24    "profile_asset_url": "https://assets.example.com/agents/customer-support-bot.png",
25    "active_revision": "rev-20240410-001",
26    "from_persona": "support-specialist"
27  }
28]
Was this page helpful?
Previous

Create or update an agent.

Next
Built with

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
idstring
doc_type"agent"
created_atdatetime
updated_atdatetime
is_seedboolean or null
descriptionstring or null
profile_icon_fillstring or null
profile_asset_urlstring or null
active_revisionstring or null
from_personastring or null