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

Get an agent and its active revision.

GET
https://api.scoutos.com/agents/:agent_id/active
GET
/agents/:agent_id/active
$curl https://api.scoutos.com/agents/agent_id/active \
>     -H "Authorization: Bearer <token>"
1{
2  "agent": {
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://cdn.example.com/assets/agent-icons/support-bot.png",
25    "active_revision": "rev-98765",
26    "from_persona": "support_specialist"
27  },
28  "revision": {
29    "created_by": {
30      "type": "organization",
31      "id": "org-12345"
32    },
33    "updated_by": {
34      "type": "organization",
35      "id": "org-12345"
36    },
37    "parent": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
38    "organization_id": "org-12345",
39    "model": "gpt-4",
40    "system": "You are a helpful customer support assistant.",
41    "id": "rev-98765",
42    "doc_type": "agent_revision",
43    "created_at": "2024-04-01T08:00:00Z",
44    "updated_at": "2024-04-10T11:45:00Z",
45    "is_seed": true,
46    "model_provider": "open_ai",
47    "temperature": 0.7,
48    "response_style": "precise",
49    "max_tokens": 150,
50    "max_turns": 10,
51    "tool_config": {},
52    "conversation_starters": [
53      "Hello! How can I assist you today?"
54    ],
55    "dynamic_fallbacks": [
56      {
57        "model": "gpt-3.5-turbo",
58        "model_provider": "open_ai"
59      }
60    ]
61  }
62}

Retrieve an agent and its active revision by agent_id. Verifies that the agent belongs to the actor’s organization.

Was this page helpful?
Previous

Delete an agent.

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

agent_idstringRequired

Response

Successful Response
agentobject
revisionobject

Errors

422
Unprocessable Entity Error