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

Send messages to an agent within a session and receive a streaming response.

POST
https://api.scoutos.com/world/:agent_id/:session_id/_interact
POST
/world/:agent_id/:session_id/_interact
$curl -X POST https://api.scoutos.com/world/agent_id/string/_interact \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "messages": [
> {
> "content": {
> "text": "Hello, can you provide the current status of the mission?"
> }
> }
> ]
>}'
Was this page helpful?
Previous

Send messages to an agent within a session and receive a synchronous response.

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.
metadatamap from strings to anyOptional

Optional metadata (e.g., salesforce_session)

callback_urlstring or nullOptional

Optional callback URL. If provided, the interaction runs asynchronously and the response returns 202 with session_id + events_url.

revision_idstring or nullOptional
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

Errors

422
Unprocessable Entity Error