Handle Message | Scout | Documentation

1 import requests 2 3 url = "https://api-prod.scoutos.com/inbox/session_id/messages" 4 5 payload = { 6 "messages": [ 7 { 8 "content": "content", 9 "content_type": "text/plain" 10 } 11 ], 12 "participants": [ 13 { 14 "id": "id", 15 "type": "scout_user" 16 } 17 ], 18 "history": [ 19 { 20 "content": "content", 21 "content_type": "text/plain" 22 } 23 ], 24 "files": [ 25 { 26 "url": "url", 27 "name": "name" 28 } 29 ], 30 "ephemeral_agent_revision": { 31 "id": "id", 32 "doc_type": "agent_revision", 33 "created_by": { 34 "type": "organization", 35 "id": "id" 36 }, 37 "updated_by": { 38 "type": "organization", 39 "id": "id" 40 }, 41 "created_at": "created_at", 42 "updated_at": "updated_at", 43 "is_seed": False, 44 "parent": "parent", 45 "organization_id": "organization_id", 46 "model_provider": "open_ai", 47 "model": "_dynamic", 48 "system": "system", 49 "temperature": 0, 50 "response_style": "precise", 51 "max_tokens": 0, 52 "max_turns": 0, 53 "tool_config": {}, 54 "conversation_starters": ["conversation_starters"] 55 } 56 } 57 headers = { 58 "Authorization": "Bearer <apiKey>", 59 "Content-Type": "application/json" 60 } 61 62 response = requests.post(url, json=payload, headers=headers) 63 64 print(response.json())

Process an interaction request through the environment.

Args: request: The FastAPI request session_id: The ID of the session interaction_request: The interaction request data

Returns: Span with the results of the interaction attached to its attributes

Path parameters

session_idstringRequired

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.

messageslist of objectsRequired

participantslist of objectsRequired

historylist of objects or nullOptional

fileslist of objectsOptional

ephemeral_agent_revisionobject or nullOptional

Response

Successful Response

Path parameters

Headers

Request

Response

Errors