WayloAIWaylo Docs
APIReferenceSessions

Get session

GET
/sessions/{id}

One session with its transcript and the configuration it ran on, by id, within the caller’s tenant. Tools, documents, providers, models and the voice carry their current names. For a key, transcript is null without transcripts:read and config is null without agents:read.

Access: workspace_viewer · API key sessions:read

Authorization

api-key
headerAuthorizationBearer <sk_waylo_<lookup><secret><checksum>>

Path Parameters

id*string

Header Parameters

Authorization*string

Your API key.

Response Body

Success

application/json
  1. response
id*string
Formatuuid
workspaceId*string
Formatuuid
agentId*string
Formatuuid
agentVersion*number
isDraft*boolean
createdByUserId*|
Formatuuid
createdByApiKeyId*|
Formatuuid
endUser*
spokenNumber*
channel*string
Value in"web""telephony"
direction*|
Value in"inbound""outbound"null
phoneNumberId*|
Formatuuid
fromAddress*string|null
toAddress*string|null
provider*string|null
providerCallId*string|null
status*string
Value in"pending""active""completed""failed"
endReason*|
Value in"caller_hangup""caller_inactive""caller_goodbye""agent_end""busy""no_answer""rejected""cancelled""provider_error""provider_key_failed""worker_error""max_duration""timeout"null
failureCode*|
Value in"invalid_dispatch""config_fetch_failed""provider_keys_fetch_failed""unsupported_option""unbuildable_model""start_failed"null
roomName*string|null
roomSid*string|null
livekitSipParticipantSid*string|null
clientRequestId*string|null
metadata?
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
startedAt*|
Formatdate-time
endedAt*|
Formatdate-time
agentName*string
createdByUserName*string|null
itemCount*number
configSummary*
transcript*array<>|null
config*
eventCount*number

Number of session events, for gating the admin-only events view.

Example Request
curl -X GET 'https://api.poc.app.waylovoice.ai/sessions/string' \  -H 'Authorization: Bearer sk_waylo_...'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",  "agentId": "bc309ecf-5f66-4057-93c5-6611cc9cb7b2",  "agentVersion": 0,  "isDraft": true,  "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",  "createdByApiKeyId": "353906ab-73e3-4c9b-814b-174af6419ced",  "endUser": {    "externalId": "string",    "name": "string",    "phone": "string",    "metadata": {}  },  "spokenNumber": {    "value": "+15745550123",    "national": "(574) 555-0123",    "raw": "574 555 0123",    "confirmation": "not_requested"  },  "channel": "web",  "direction": "inbound",  "phoneNumberId": "8e9ce3fb-4d22-4fe3-baa7-b7892dd942d7",  "fromAddress": "string",  "toAddress": "string",  "provider": "string",  "providerCallId": "string",  "status": "pending",  "endReason": "caller_hangup",  "failureCode": "invalid_dispatch",  "roomName": "string",  "roomSid": "string",  "livekitSipParticipantSid": "string",  "clientRequestId": "string",  "metadata": {},  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "startedAt": "2019-08-24T14:15:22Z",  "endedAt": "2019-08-24T14:15:22Z",  "agentName": "string",  "createdByUserName": "string",  "itemCount": 0,  "configSummary": {    "name": "string",    "llm": {      "provider": "string",      "model": "string",      "providerName": "string",      "modelName": "string"    },    "stt": {      "provider": "string",      "model": "string",      "providerName": "string",      "modelName": "string"    },    "tts": {      "provider": "string",      "model": "string",      "providerName": "string",      "modelName": "string",      "voiceId": "string",      "voiceName": "string"    }  },  "transcript": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "seq": 0,      "idempotencyKey": "0c14c6a6-6f50-4d1e-b0c4-b46ff43ba6a1",      "role": "user",      "text": "string",      "startedAt": "2019-08-24T14:15:22Z",      "confidence": 0    }  ],  "config": {    "name": "string",    "language": "string",    "greeting": "string",    "systemPrompt": "string",    "llm": {      "provider": "string",      "model": "string",      "options": {        "property1": "string",        "property2": "string"      },      "providerName": "string",      "modelName": "string"    },    "stt": {      "provider": "string",      "model": "string",      "options": {        "property1": "string",        "property2": "string"      },      "providerName": "string",      "modelName": "string"    },    "tts": {      "provider": "string",      "model": "string",      "options": {        "property1": "string",        "property2": "string"      },      "providerName": "string",      "modelName": "string",      "voiceId": "string",      "voiceName": "string"    },    "runtimeConfig": {      "silenceTimeoutMs": 0,      "silenceRetryAttempts": 0,      "vad": {        "activationThreshold": 0,        "minSpeechDurationMs": 0,        "minSilenceDurationMs": 0      },      "endpointing": {        "mode": "fixed",        "minDelayMs": 0,        "maxDelayMs": 0,        "alpha": 0      },      "backgroundAudio": {        "id": "office_quiet",        "volume": 0.1047,        "delaySeconds": 0,        "fadeInSeconds": 1,        "fadeOutSeconds": 0      },      "thinkingSound": {        "id": "office_quiet",        "volume": 0.1047,        "delaySeconds": 0,        "fadeInSeconds": 1,        "fadeOutSeconds": 0      }    },    "presetId": "string",    "catalogId": "string",    "catalogContentHash": "string",    "tools": [      {        "id": "string",        "name": "string",        "type": "api_request"      }    ],    "documents": [      {        "id": "string",        "name": "string",        "deleted": true      }    ]  },  "eventCount": 0}

Start a web session POST

Creates the session, its LiveKit room and the agent dispatch, and returns what a browser connects with. The participant token is short-lived and reaches one room only. **Access:** workspace_member · API key `sessions:write`

List sessions GET

Sessions in one workspace, newest first, offset-paginated. Filters are exact matches, plus a createdAt range and `hasItems`; `search` matches the caller (end-user name, phone, external id, from-address). `configSummary` carries the agent name when the session started, and the provider, model and voice of each stage by id and current name; it is null for a key without agents:read. **Access:** workspace_viewer · API key `sessions:read`