Create a session

​

Starts analysis on a single live call: taps the call audio, applies the given configuration, starts its operators, and waits for the session to establish before responding (201). The target call must already be known to the platform, identified by call_id; an unknown one, or one belonging to another account, returns 404. Pass customer_metadata to have an opaque object echoed back on every webhook this session triggers. Returns 502 if the session cannot be established, or 504 if establishment times out.

Required scope: intelligence:write

Body·
required
application/json

Request body for starting a session on a live call.

  • call_id
    Type: string · Call Id
    required

    Identifier of the live call to analyse. It must already be known to the platform.

  • configuration_id
    Type: string · Configuration Id
    required

    UUID of the configuration to apply. Must be one of your account's active configurations.

  • customer_metadata
    Type: object · Customer Metadatanullable

    Opaque object stored with the session and echoed back, verbatim, on every webhook this session triggers. Use it to carry your own correlation reference (e.g. a CRM id).

  • transcript_events
    Type: boolean · Transcript Eventsnullable

    When true, transcript turns are emitted on the session's event stream alongside operator results.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/sessions
curl https://api.simwood.com/intelligence/v1/sessions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "call_id": "",
  "configuration_id": "",
  "customer_metadata": {
    "additionalProperty": "anything"
  },
  "transcript_events": true
}'

{
  "session_id": "string"
}

Successful Response

Simwood API Documentation