SLNG Voice Agents API

Calls

Endpointhttps://api.slng.ai

Get Call

GET

https://api.slng.ai

/v1/agents/{agent_id}/calls/{call_id}

Get details of a specific call including status and transcript.

Get Call › path Parameters

agent_id

string · uuid · required

Agent UUID

call_id

string · uuid · required

Call UUID

Get Call › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Call › Responses

Call details

id

string · uuid

Call UUID

agent_id

string · uuid

Agent UUID

phone_number

string

Phone number in E.164 format

object

Template arguments provided for the call

rendered_prompt

string

The system prompt with template variables rendered

livekit_room_name

string

LiveKit room name for the call

livekit_dispatch_id

string

LiveKit dispatch ID

livekit_response

object

Raw response from LiveKit dispatch

livekit_session_report

object

Session report/transcript submitted after call completion

status

string

Call status (e.g., pending, dispatched, completed, failed)

error_message

string

Error message if call failed

created_at

string · date-time

When the call was created

updated_at

string · date-time

When the call was last updated

GET/v1/agents/{agent_id}/calls/{call_id}

curl --request GET \
  --url https://api.slng.ai/v1/agents/:agent_id/calls/:call_id \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "agent_id": "00000000-0000-0000-0000-000000000000",
  "phone_number": "phone_number",
  "arguments": {},
  "rendered_prompt": "rendered_prompt",
  "livekit_room_name": "livekit_room_name",
  "livekit_dispatch_id": "livekit_dispatch_id",
  "livekit_response": {},
  "livekit_session_report": {},
  "status": "completed",
  "error_message": "error_message",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Dispatch Call

POST

https://api.slng.ai

/v1/agents/{agent_id}/calls

Dispatch an outbound call using a voice agent.

Dispatch Call › path Parameters

agent_id

string · uuid · required

Agent UUID

Dispatch Call › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Dispatch Call › Request Body

phone_number

string · pattern: ^\+[1-9]\d{1,14}$ · required

Phone number in E.164 format

object

Values for template variables in the system_prompt

Dispatch Call › Responses

Call dispatched successfully

call_id

string · uuid

Call UUID

message

string

Status message

POST/v1/agents/{agent_id}/calls

curl --request POST \
  --url https://api.slng.ai/v1/agents/:agent_id/calls \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "+14155551234",
  "arguments": {
    "customer_name": "John Doe",
    "order_id": "12345"
  }
}
'

shell

Example Request Body

{
  "phone_number": "+14155551234",
  "arguments": {
    "customer_name": "John Doe",
    "order_id": "12345"
  }
}

json

Example Responses

{
  "call_id": "00000000-0000-0000-0000-000000000000",
  "message": "Call dispatched successfully"
}

json

application/json

Submit Call Transcript

POST

https://api.slng.ai

/v1/agents/{agent_id}/calls/{call_id}/transcript

Submit a session report/transcript for a completed call. Used by LiveKit workers to store call transcripts and metrics.

Submit Call Transcript › path Parameters

agent_id

string · uuid · required

Agent UUID

call_id

string · uuid · required

Call UUID

Submit Call Transcript › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Submit Call Transcript › Request Body

object · required

Raw LiveKit session report including events, chat history, and metrics

Submit Call Transcript › Responses

Transcript saved successfully

call_id

string · uuid

Call UUID

message

string

Status message

POST/v1/agents/{agent_id}/calls/{call_id}/transcript

curl --request POST \
  --url https://api.slng.ai/v1/agents/:agent_id/calls/:call_id/transcript \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_report": {}
}
'

shell

Example Request Body

{
  "session_report": {}
}

json

Example Responses

{
  "call_id": "00000000-0000-0000-0000-000000000000",
  "message": "Session report saved successfully"
}

json

application/json

Agents Other endpoints

Get Call

GET

https://api.slng.ai

/v1/agents/{agent_id}/calls/{call_id}

Get details of a specific call including status and transcript.

Get Call › path Parameters

agent_id

string · uuid · required

Agent UUID

call_id

string · uuid · required

Call UUID

Get Call › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Call › Responses

Call details

id

string · uuid

Call UUID

agent_id

string · uuid

Agent UUID

phone_number

string

Phone number in E.164 format

object

Template arguments provided for the call

rendered_prompt

string

The system prompt with template variables rendered

livekit_room_name

string

LiveKit room name for the call

livekit_dispatch_id

string

LiveKit dispatch ID

livekit_response

object

Raw response from LiveKit dispatch

livekit_session_report

object

Session report/transcript submitted after call completion

status

string

Call status (e.g., pending, dispatched, completed, failed)

error_message

string

Error message if call failed

created_at

string · date-time

When the call was created

updated_at

string · date-time

When the call was last updated

Dispatch Call

POST

https://api.slng.ai

/v1/agents/{agent_id}/calls

Dispatch an outbound call using a voice agent.

Dispatch Call › path Parameters

agent_id

string · uuid · required

Agent UUID

Dispatch Call › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Dispatch Call › Request Body

phone_number

string · pattern: ^\+[1-9]\d{1,14}$ · required

Phone number in E.164 format

object

Values for template variables in the system_prompt

Dispatch Call › Responses

Call dispatched successfully

call_id

string · uuid

Call UUID

message

string

Status message

Submit Call Transcript

POST

https://api.slng.ai

/v1/agents/{agent_id}/calls/{call_id}/transcript

Submit a session report/transcript for a completed call. Used by LiveKit workers to store call transcripts and metrics.

Submit Call Transcript › path Parameters

agent_id

string · uuid · required

Agent UUID

call_id

string · uuid · required

Call UUID

Submit Call Transcript › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Submit Call Transcript › Request Body

object · required

Raw LiveKit session report including events, chat history, and metrics

Submit Call Transcript › Responses

Transcript saved successfully

call_id

string · uuid

Call UUID

message

string

Status message