SLNG Voice Agents API

Agents

Endpointhttps://api.slng.ai

List Agents

GET

https://api.slng.ai

/v1/agents

List all voice agents for your organisation.

List Agents › 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.

List Agents › Responses

List of agents

object[]

id

string · uuid

Agent UUID

organisation_id

string · uuid

Organisation UUID

name

string

Agent name

system_prompt

string

System prompt

greeting

string

Initial greeting message

language

string

Language code

object

enable_interruptions

boolean

Whether the agent can be interrupted

object[]

Tools with secrets redacted

livekit_deployment

string

LiveKit deployment name

object

Template variables extracted from system_prompt with their metadata

created_at

string · date-time

Creation timestamp

updated_at

string · date-time

Last update timestamp

deleted_at

string · date-time

Deletion timestamp (null if not deleted)

GET/v1/agents

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

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "system_prompt": "system_prompt",
    "greeting": "greeting",
    "language": "language",
    "models": {
      "stt": "deepgram/nova-2",
      "llm": "openai/gpt-4o",
      "tts": "deepgram/aura:2",
      "tts_voice": "aura-2-andromeda-en",
      "stt_kwargs": {},
      "llm_kwargs": {
        "temperature": 0.7
      },
      "tts_kwargs": {}
    },
    "enable_interruptions": true,
    "tools": [
      {
        "type": "template",
        "template": "template",
        "prompt": "prompt",
        "name": "name",
        "description": "description",
        "url": "url",
        "parameters": {},
        "auth_type": "auth_type",
        "timeout_seconds": 0,
        "wait_for_response": true
      }
    ],
    "livekit_deployment": "livekit_deployment",
    "template_variables": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z",
    "deleted_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Create Agent

POST

https://api.slng.ai

/v1/agents

Create a new voice agent for your organisation.

Create Agent › 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.

Create Agent › Request Body

name

string · maxLength: 255 · required

Agent name (must be unique within organisation)

system_prompt

string · required

System prompt for the agent (supports Handlebars templates with {{variable}} syntax)

greeting

string · required

Initial greeting message spoken by the agent

language

string · maxLength: 10 · required

Language code

object · required

slng_api_key

string · required

SLNG API key for the agent to use when making API calls

livekit_deployment

string · required

LiveKit deployment name

enable_interruptions

boolean

Whether the agent can be interrupted while speaking

Default: true

array

Tools available to the agent

object

Default values for template variables in system_prompt

Create Agent › Responses

Agent created successfully

id

string · uuid

Agent UUID

organisation_id

string · uuid

Organisation UUID

name

string

Agent name

system_prompt

string

System prompt

greeting

string

Initial greeting message

language

string

Language code

object

enable_interruptions

boolean

Whether the agent can be interrupted

object[]

Tools with secrets redacted

livekit_deployment

string

LiveKit deployment name

object

Template variables extracted from system_prompt with their metadata

created_at

string · date-time

Creation timestamp

updated_at

string · date-time

Last update timestamp

deleted_at

string · date-time

Deletion timestamp (null if not deleted)

POST/v1/agents

curl --request POST \
  --url https://api.slng.ai/v1/agents \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Customer Support Agent",
  "system_prompt": "You are a helpful customer support agent for {{company_name}}. Be polite and concise.",
  "greeting": "Hello! Thank you for calling. How can I help you today?",
  "language": "en",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "hangup",
      "prompt": "prompt"
    }
  ],
  "slng_api_key": "slng_api_key",
  "livekit_deployment": "production",
  "template_defaults": {
    "company_name": "Acme Corp"
  }
}
'

shell

Example Request Body

{
  "name": "Customer Support Agent",
  "system_prompt": "You are a helpful customer support agent for {{company_name}}. Be polite and concise.",
  "greeting": "Hello! Thank you for calling. How can I help you today?",
  "language": "en",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "hangup",
      "prompt": "prompt"
    }
  ],
  "slng_api_key": "slng_api_key",
  "livekit_deployment": "production",
  "template_defaults": {
    "company_name": "Acme Corp"
  }
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organisation_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "system_prompt": "system_prompt",
  "greeting": "greeting",
  "language": "language",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "template",
      "prompt": "prompt",
      "name": "name",
      "description": "description",
      "url": "url",
      "parameters": {},
      "auth_type": "auth_type",
      "timeout_seconds": 0,
      "wait_for_response": true
    }
  ],
  "livekit_deployment": "livekit_deployment",
  "template_variables": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "deleted_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get Agent

GET

https://api.slng.ai

/v1/agents/{agent_id}

Get a specific voice agent by ID.

Get Agent › path Parameters

agent_id

string · uuid · required

Agent UUID

Get Agent › 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 Agent › Responses

Agent details

id

string · uuid

Agent UUID

organisation_id

string · uuid

Organisation UUID

name

string

Agent name

system_prompt

string

System prompt

greeting

string

Initial greeting message

language

string

Language code

object

enable_interruptions

boolean

Whether the agent can be interrupted

object[]

Tools with secrets redacted

livekit_deployment

string

LiveKit deployment name

object

Template variables extracted from system_prompt with their metadata

created_at

string · date-time

Creation timestamp

updated_at

string · date-time

Last update timestamp

deleted_at

string · date-time

Deletion timestamp (null if not deleted)

GET/v1/agents/{agent_id}

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

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organisation_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "system_prompt": "system_prompt",
  "greeting": "greeting",
  "language": "language",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "template",
      "prompt": "prompt",
      "name": "name",
      "description": "description",
      "url": "url",
      "parameters": {},
      "auth_type": "auth_type",
      "timeout_seconds": 0,
      "wait_for_response": true
    }
  ],
  "livekit_deployment": "livekit_deployment",
  "template_variables": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "deleted_at": "2024-08-25T15:00:00Z"
}

json

application/json

Replace Agent

PUT

https://api.slng.ai

/v1/agents/{agent_id}

Fully replace a voice agent. All required fields must be provided.

Replace Agent › path Parameters

agent_id

string · uuid · required

Agent UUID

Replace Agent › 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.

Replace Agent › Request Body

name

string · maxLength: 255 · required

Agent name (must be unique within organisation)

system_prompt

string · required

System prompt for the agent (supports Handlebars templates with {{variable}} syntax)

greeting

string · required

Initial greeting message spoken by the agent

language

string · maxLength: 10 · required

Language code

object · required

slng_api_key

string · required

SLNG API key for the agent to use when making API calls

livekit_deployment

string · required

LiveKit deployment name

enable_interruptions

boolean

Whether the agent can be interrupted while speaking

Default: true

array

Tools available to the agent

object

Default values for template variables in system_prompt

Replace Agent › Responses

Agent replaced successfully

id

string · uuid

Agent UUID

organisation_id

string · uuid

Organisation UUID

name

string

Agent name

system_prompt

string

System prompt

greeting

string

Initial greeting message

language

string

Language code

object

enable_interruptions

boolean

Whether the agent can be interrupted

object[]

Tools with secrets redacted

livekit_deployment

string

LiveKit deployment name

object

Template variables extracted from system_prompt with their metadata

created_at

string · date-time

Creation timestamp

updated_at

string · date-time

Last update timestamp

deleted_at

string · date-time

Deletion timestamp (null if not deleted)

PUT/v1/agents/{agent_id}

curl --request PUT \
  --url https://api.slng.ai/v1/agents/:agent_id \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Customer Support Agent",
  "system_prompt": "You are a helpful customer support agent for {{company_name}}. Be polite and concise.",
  "greeting": "Hello! Thank you for calling. How can I help you today?",
  "language": "en",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "hangup",
      "prompt": "prompt"
    }
  ],
  "slng_api_key": "slng_api_key",
  "livekit_deployment": "production",
  "template_defaults": {
    "company_name": "Acme Corp"
  }
}
'

shell

Example Request Body

{
  "name": "Customer Support Agent",
  "system_prompt": "You are a helpful customer support agent for {{company_name}}. Be polite and concise.",
  "greeting": "Hello! Thank you for calling. How can I help you today?",
  "language": "en",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "hangup",
      "prompt": "prompt"
    }
  ],
  "slng_api_key": "slng_api_key",
  "livekit_deployment": "production",
  "template_defaults": {
    "company_name": "Acme Corp"
  }
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organisation_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "system_prompt": "system_prompt",
  "greeting": "greeting",
  "language": "language",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "template",
      "prompt": "prompt",
      "name": "name",
      "description": "description",
      "url": "url",
      "parameters": {},
      "auth_type": "auth_type",
      "timeout_seconds": 0,
      "wait_for_response": true
    }
  ],
  "livekit_deployment": "livekit_deployment",
  "template_variables": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "deleted_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete Agent

DELETE

https://api.slng.ai

/v1/agents/{agent_id}

Delete a voice agent (soft delete).

Delete Agent › path Parameters

agent_id

string · uuid · required

Agent UUID

Delete Agent › 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.

Delete Agent › Responses

Agent deleted successfully

No data returned

DELETE/v1/agents/{agent_id}

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

shell

Example Responses

No example specified for this content type

Update Agent

PATCH

https://api.slng.ai

/v1/agents/{agent_id}

Partially update a voice agent. Only provided fields will be updated.

Update Agent › path Parameters

agent_id

string · uuid · required

Agent UUID

Update Agent › 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.

Update Agent › Request Body

name

string · maxLength: 255

Agent name (must be unique within organisation)

system_prompt

string

System prompt for the agent (supports Handlebars templates)

greeting

string

Initial greeting message

language

string · maxLength: 10

Language code

object

enable_interruptions

boolean

Whether the agent can be interrupted while speaking

array

Tools available to the agent

slng_api_key

string

SLNG API key for the agent

livekit_deployment

string

LiveKit deployment name

object

Default values for template variables

Update Agent › Responses

Agent updated successfully

id

string · uuid

Agent UUID

organisation_id

string · uuid

Organisation UUID

name

string

Agent name

system_prompt

string

System prompt

greeting

string

Initial greeting message

language

string

Language code

object

enable_interruptions

boolean

Whether the agent can be interrupted

object[]

Tools with secrets redacted

livekit_deployment

string

LiveKit deployment name

object

Template variables extracted from system_prompt with their metadata

created_at

string · date-time

Creation timestamp

updated_at

string · date-time

Last update timestamp

deleted_at

string · date-time

Deletion timestamp (null if not deleted)

PATCH/v1/agents/{agent_id}

curl --request PATCH \
  --url https://api.slng.ai/v1/agents/:agent_id \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "system_prompt": "system_prompt",
  "greeting": "greeting",
  "language": "language",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "hangup",
      "prompt": "prompt"
    }
  ],
  "slng_api_key": "slng_api_key",
  "livekit_deployment": "livekit_deployment",
  "template_defaults": {}
}
'

shell

Example Request Body

{
  "name": "name",
  "system_prompt": "system_prompt",
  "greeting": "greeting",
  "language": "language",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "hangup",
      "prompt": "prompt"
    }
  ],
  "slng_api_key": "slng_api_key",
  "livekit_deployment": "livekit_deployment",
  "template_defaults": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organisation_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "system_prompt": "system_prompt",
  "greeting": "greeting",
  "language": "language",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "template",
      "prompt": "prompt",
      "name": "name",
      "description": "description",
      "url": "url",
      "parameters": {},
      "auth_type": "auth_type",
      "timeout_seconds": 0,
      "wait_for_response": true
    }
  ],
  "livekit_deployment": "livekit_deployment",
  "template_variables": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "deleted_at": "2024-08-25T15:00:00Z"
}

json

application/json

Calls

SLNG Voice Agents API

Agents

Endpointhttps://api.slng.ai

List Agents

GET

https://api.slng.ai

/v1/agents

List all voice agents for your organisation.

List Agents › 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.

List Agents › Responses

List of agents

object[]

id

string · uuid

Agent UUID

organisation_id

string · uuid

Organisation UUID

name

string

Agent name

system_prompt

string

System prompt

greeting

string

Initial greeting message

language

string

Language code

object

enable_interruptions

boolean

Whether the agent can be interrupted

object[]

Tools with secrets redacted

livekit_deployment

string

LiveKit deployment name

object

Template variables extracted from system_prompt with their metadata

created_at

string · date-time

Creation timestamp

updated_at

string · date-time

Last update timestamp

deleted_at

string · date-time

Deletion timestamp (null if not deleted)

GET/v1/agents

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

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "system_prompt": "system_prompt",
    "greeting": "greeting",
    "language": "language",
    "models": {
      "stt": "deepgram/nova-2",
      "llm": "openai/gpt-4o",
      "tts": "deepgram/aura:2",
      "tts_voice": "aura-2-andromeda-en",
      "stt_kwargs": {},
      "llm_kwargs": {
        "temperature": 0.7
      },
      "tts_kwargs": {}
    },
    "enable_interruptions": true,
    "tools": [
      {
        "type": "template",
        "template": "template",
        "prompt": "prompt",
        "name": "name",
        "description": "description",
        "url": "url",
        "parameters": {},
        "auth_type": "auth_type",
        "timeout_seconds": 0,
        "wait_for_response": true
      }
    ],
    "livekit_deployment": "livekit_deployment",
    "template_variables": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z",
    "deleted_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Create Agent

POST

https://api.slng.ai

/v1/agents

Create a new voice agent for your organisation.

Create Agent › 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.

Create Agent › Request Body

name

string · maxLength: 255 · required

Agent name (must be unique within organisation)

system_prompt

string · required

System prompt for the agent (supports Handlebars templates with {{variable}} syntax)

greeting

string · required

Initial greeting message spoken by the agent

language

string · maxLength: 10 · required

Language code

object · required

slng_api_key

string · required

SLNG API key for the agent to use when making API calls

livekit_deployment

string · required

LiveKit deployment name

enable_interruptions

boolean

Whether the agent can be interrupted while speaking

Default: true

array

Tools available to the agent

object

Default values for template variables in system_prompt

Create Agent › Responses

Agent created successfully

id

string · uuid

Agent UUID

organisation_id

string · uuid

Organisation UUID

name

string

Agent name

system_prompt

string

System prompt

greeting

string

Initial greeting message

language

string

Language code

object

enable_interruptions

boolean

Whether the agent can be interrupted

object[]

Tools with secrets redacted

livekit_deployment

string

LiveKit deployment name

object

Template variables extracted from system_prompt with their metadata

created_at

string · date-time

Creation timestamp

updated_at

string · date-time

Last update timestamp

deleted_at

string · date-time

Deletion timestamp (null if not deleted)

POST/v1/agents

curl --request POST \
  --url https://api.slng.ai/v1/agents \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Customer Support Agent",
  "system_prompt": "You are a helpful customer support agent for {{company_name}}. Be polite and concise.",
  "greeting": "Hello! Thank you for calling. How can I help you today?",
  "language": "en",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "hangup",
      "prompt": "prompt"
    }
  ],
  "slng_api_key": "slng_api_key",
  "livekit_deployment": "production",
  "template_defaults": {
    "company_name": "Acme Corp"
  }
}
'

shell

Example Request Body

{
  "name": "Customer Support Agent",
  "system_prompt": "You are a helpful customer support agent for {{company_name}}. Be polite and concise.",
  "greeting": "Hello! Thank you for calling. How can I help you today?",
  "language": "en",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "hangup",
      "prompt": "prompt"
    }
  ],
  "slng_api_key": "slng_api_key",
  "livekit_deployment": "production",
  "template_defaults": {
    "company_name": "Acme Corp"
  }
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organisation_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "system_prompt": "system_prompt",
  "greeting": "greeting",
  "language": "language",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "template",
      "prompt": "prompt",
      "name": "name",
      "description": "description",
      "url": "url",
      "parameters": {},
      "auth_type": "auth_type",
      "timeout_seconds": 0,
      "wait_for_response": true
    }
  ],
  "livekit_deployment": "livekit_deployment",
  "template_variables": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "deleted_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get Agent

GET

https://api.slng.ai

/v1/agents/{agent_id}

Get a specific voice agent by ID.

Get Agent › path Parameters

agent_id

string · uuid · required

Agent UUID

Get Agent › 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 Agent › Responses

Agent details

id

string · uuid

Agent UUID

organisation_id

string · uuid

Organisation UUID

name

string

Agent name

system_prompt

string

System prompt

greeting

string

Initial greeting message

language

string

Language code

object

enable_interruptions

boolean

Whether the agent can be interrupted

object[]

Tools with secrets redacted

livekit_deployment

string

LiveKit deployment name

object

Template variables extracted from system_prompt with their metadata

created_at

string · date-time

Creation timestamp

updated_at

string · date-time

Last update timestamp

deleted_at

string · date-time

Deletion timestamp (null if not deleted)

GET/v1/agents/{agent_id}

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

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organisation_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "system_prompt": "system_prompt",
  "greeting": "greeting",
  "language": "language",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "template",
      "prompt": "prompt",
      "name": "name",
      "description": "description",
      "url": "url",
      "parameters": {},
      "auth_type": "auth_type",
      "timeout_seconds": 0,
      "wait_for_response": true
    }
  ],
  "livekit_deployment": "livekit_deployment",
  "template_variables": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "deleted_at": "2024-08-25T15:00:00Z"
}

json

application/json

Replace Agent

PUT

https://api.slng.ai

/v1/agents/{agent_id}

Fully replace a voice agent. All required fields must be provided.

Replace Agent › path Parameters

agent_id

string · uuid · required

Agent UUID

Replace Agent › 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.

Replace Agent › Request Body

name

string · maxLength: 255 · required

Agent name (must be unique within organisation)

system_prompt

string · required

System prompt for the agent (supports Handlebars templates with {{variable}} syntax)

greeting

string · required

Initial greeting message spoken by the agent

language

string · maxLength: 10 · required

Language code

object · required

slng_api_key

string · required

SLNG API key for the agent to use when making API calls

livekit_deployment

string · required

LiveKit deployment name

enable_interruptions

boolean

Whether the agent can be interrupted while speaking

Default: true

array

Tools available to the agent

object

Default values for template variables in system_prompt

Replace Agent › Responses

Agent replaced successfully

id

string · uuid

Agent UUID

organisation_id

string · uuid

Organisation UUID

name

string

Agent name

system_prompt

string

System prompt

greeting

string

Initial greeting message

language

string

Language code

object

enable_interruptions

boolean

Whether the agent can be interrupted

object[]

Tools with secrets redacted

livekit_deployment

string

LiveKit deployment name

object

Template variables extracted from system_prompt with their metadata

created_at

string · date-time

Creation timestamp

updated_at

string · date-time

Last update timestamp

deleted_at

string · date-time

Deletion timestamp (null if not deleted)

PUT/v1/agents/{agent_id}

curl --request PUT \
  --url https://api.slng.ai/v1/agents/:agent_id \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Customer Support Agent",
  "system_prompt": "You are a helpful customer support agent for {{company_name}}. Be polite and concise.",
  "greeting": "Hello! Thank you for calling. How can I help you today?",
  "language": "en",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "hangup",
      "prompt": "prompt"
    }
  ],
  "slng_api_key": "slng_api_key",
  "livekit_deployment": "production",
  "template_defaults": {
    "company_name": "Acme Corp"
  }
}
'

shell

Example Request Body

{
  "name": "Customer Support Agent",
  "system_prompt": "You are a helpful customer support agent for {{company_name}}. Be polite and concise.",
  "greeting": "Hello! Thank you for calling. How can I help you today?",
  "language": "en",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "hangup",
      "prompt": "prompt"
    }
  ],
  "slng_api_key": "slng_api_key",
  "livekit_deployment": "production",
  "template_defaults": {
    "company_name": "Acme Corp"
  }
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organisation_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "system_prompt": "system_prompt",
  "greeting": "greeting",
  "language": "language",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "template",
      "prompt": "prompt",
      "name": "name",
      "description": "description",
      "url": "url",
      "parameters": {},
      "auth_type": "auth_type",
      "timeout_seconds": 0,
      "wait_for_response": true
    }
  ],
  "livekit_deployment": "livekit_deployment",
  "template_variables": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "deleted_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete Agent

DELETE

https://api.slng.ai

/v1/agents/{agent_id}

Delete a voice agent (soft delete).

Delete Agent › path Parameters

agent_id

string · uuid · required

Agent UUID

Delete Agent › 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.

Delete Agent › Responses

Agent deleted successfully

No data returned

DELETE/v1/agents/{agent_id}

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

shell

Example Responses

No example specified for this content type

Update Agent

PATCH

https://api.slng.ai

/v1/agents/{agent_id}

Partially update a voice agent. Only provided fields will be updated.

Update Agent › path Parameters

agent_id

string · uuid · required

Agent UUID

Update Agent › 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.

Update Agent › Request Body

name

string · maxLength: 255

Agent name (must be unique within organisation)

system_prompt

string

System prompt for the agent (supports Handlebars templates)

greeting

string

Initial greeting message

language

string · maxLength: 10

Language code

object

enable_interruptions

boolean

Whether the agent can be interrupted while speaking

array

Tools available to the agent

slng_api_key

string

SLNG API key for the agent

livekit_deployment

string

LiveKit deployment name

object

Default values for template variables

Update Agent › Responses

Agent updated successfully

id

string · uuid

Agent UUID

organisation_id

string · uuid

Organisation UUID

name

string

Agent name

system_prompt

string

System prompt

greeting

string

Initial greeting message

language

string

Language code

object

enable_interruptions

boolean

Whether the agent can be interrupted

object[]

Tools with secrets redacted

livekit_deployment

string

LiveKit deployment name

object

Template variables extracted from system_prompt with their metadata

created_at

string · date-time

Creation timestamp

updated_at

string · date-time

Last update timestamp

deleted_at

string · date-time

Deletion timestamp (null if not deleted)

PATCH/v1/agents/{agent_id}

curl --request PATCH \
  --url https://api.slng.ai/v1/agents/:agent_id \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "system_prompt": "system_prompt",
  "greeting": "greeting",
  "language": "language",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "hangup",
      "prompt": "prompt"
    }
  ],
  "slng_api_key": "slng_api_key",
  "livekit_deployment": "livekit_deployment",
  "template_defaults": {}
}
'

shell

Example Request Body

{
  "name": "name",
  "system_prompt": "system_prompt",
  "greeting": "greeting",
  "language": "language",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "hangup",
      "prompt": "prompt"
    }
  ],
  "slng_api_key": "slng_api_key",
  "livekit_deployment": "livekit_deployment",
  "template_defaults": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organisation_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "system_prompt": "system_prompt",
  "greeting": "greeting",
  "language": "language",
  "models": {
    "stt": "deepgram/nova-2",
    "llm": "openai/gpt-4o",
    "tts": "deepgram/aura:2",
    "tts_voice": "aura-2-andromeda-en",
    "stt_kwargs": {},
    "llm_kwargs": {
      "temperature": 0.7
    },
    "tts_kwargs": {}
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "template": "template",
      "prompt": "prompt",
      "name": "name",
      "description": "description",
      "url": "url",
      "parameters": {},
      "auth_type": "auth_type",
      "timeout_seconds": 0,
      "wait_for_response": true
    }
  ],
  "livekit_deployment": "livekit_deployment",
  "template_variables": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "deleted_at": "2024-08-25T15:00:00Z"
}

json

application/json

Calls