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

Start an async agent interaction with a callback URL within a session.

POST
https://api.scoutos.com/world/:agent_id/:session_id/_interact_async
POST
/world/:agent_id/:session_id/_interact_async
$curl -X POST https://api.scoutos.com/world/agent_id/string/_interact_async \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "messages": [
>    {
>      "content": "Hello, can you provide the latest status update on the project?"
>    }
>  ],
>  "callback_url": "https://clientapp.example.com/api/agent-callback"
>}'
1{
2  "session_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3  "events_url": "https://api.example.com/world/agent_id/a1b2c3d4-e5f6-7890-ab12-cd34ef567890/events"
4}

Dedicated handler for async agent interactions exposed via the SDK.

Requires callback_url and always returns 202 with session_id + events_url.

Was this page helpful?
Previous

List all agents.

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

agent_idstringRequired
session_idstring or nullRequiredformat: "uuid"

Request

This endpoint expects an object.
messageslist of objectsRequired
List of incoming user messages and drive file references.
callback_urlstringRequired

Callback URL that Scout will POST to when the interaction completes. The request is signed with HMAC-SHA256 using the organization’s secret key.

metadatamap from strings to anyOptional

Optional metadata (e.g., salesforce_session)

tagslist of strings or nullOptional

Optional tags for categorizing this interaction in observability history. Max 20 tags, each up to 32 lowercase alphanumeric characters plus ’:’, ’_’, ’-’.

Response

Successful Response
session_idstring
The session ID for the interaction.
events_urlstring
URL to replay the interaction's event stream.

Errors

422
Unprocessable Entity Error