Interact with an agent (sync) | Scout API & SDK Reference

Authentication

AuthorizationBearer

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

Path parameters

agent_idstringRequired

Query parameters

session_idstring or nullOptionalformat: "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)

variablesmap from strings to anyOptional

Optional interaction-local variables for tool input interpolation. Keys are variable names; values may be any JSON.

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

$	curl -X POST https://api.scoutos.com/world/agent_id/_interact_sync \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"messages": [
>	{
>	"content": {
>	"text": "Hello, can you provide the current weather update for New York City?"
>	}
>	}
>	]
>	}'