Connect Conversation

Connect conversation

curl --request POST \
  --url https://akapulu.com/api/conversations/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scenario_id": "11111111-2222-3333-4444-555555555555",
  "avatar_id": "66666666-7777-8888-9999-000000000000",
  "runtime_vars": {
    "user_name": "Alex",
    "company_name": "Acme Corp",
    "support_ticket_id": "TICK-1024"
  },
  "stt_keywords": [
    "Akapulu",
    "Alex",
    "Acme"
  ],
  "record_conversation": false
}
'

import requests

url = "https://akapulu.com/api/conversations/connect"

payload = {
    "scenario_id": "11111111-2222-3333-4444-555555555555",
    "avatar_id": "66666666-7777-8888-9999-000000000000",
    "runtime_vars": {
        "user_name": "Alex",
        "company_name": "Acme Corp",
        "support_ticket_id": "TICK-1024"
    },
    "stt_keywords": ["Akapulu", "Alex", "Acme"],
    "record_conversation": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    scenario_id: '11111111-2222-3333-4444-555555555555',
    avatar_id: '66666666-7777-8888-9999-000000000000',
    runtime_vars: {user_name: 'Alex', company_name: 'Acme Corp', support_ticket_id: 'TICK-1024'},
    stt_keywords: ['Akapulu', 'Alex', 'Acme'],
    record_conversation: false
  })
};

fetch('https://akapulu.com/api/conversations/connect', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://akapulu.com/api/conversations/connect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'scenario_id' => '11111111-2222-3333-4444-555555555555',
    'avatar_id' => '66666666-7777-8888-9999-000000000000',
    'runtime_vars' => [
        'user_name' => 'Alex',
        'company_name' => 'Acme Corp',
        'support_ticket_id' => 'TICK-1024'
    ],
    'stt_keywords' => [
        'Akapulu',
        'Alex',
        'Acme'
    ],
    'record_conversation' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://akapulu.com/api/conversations/connect"

	payload := strings.NewReader("{\n  \"scenario_id\": \"11111111-2222-3333-4444-555555555555\",\n  \"avatar_id\": \"66666666-7777-8888-9999-000000000000\",\n  \"runtime_vars\": {\n    \"user_name\": \"Alex\",\n    \"company_name\": \"Acme Corp\",\n    \"support_ticket_id\": \"TICK-1024\"\n  },\n  \"stt_keywords\": [\n    \"Akapulu\",\n    \"Alex\",\n    \"Acme\"\n  ],\n  \"record_conversation\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://akapulu.com/api/conversations/connect")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scenario_id\": \"11111111-2222-3333-4444-555555555555\",\n  \"avatar_id\": \"66666666-7777-8888-9999-000000000000\",\n  \"runtime_vars\": {\n    \"user_name\": \"Alex\",\n    \"company_name\": \"Acme Corp\",\n    \"support_ticket_id\": \"TICK-1024\"\n  },\n  \"stt_keywords\": [\n    \"Akapulu\",\n    \"Alex\",\n    \"Acme\"\n  ],\n  \"record_conversation\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://akapulu.com/api/conversations/connect")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scenario_id\": \"11111111-2222-3333-4444-555555555555\",\n  \"avatar_id\": \"66666666-7777-8888-9999-000000000000\",\n  \"runtime_vars\": {\n    \"user_name\": \"Alex\",\n    \"company_name\": \"Acme Corp\",\n    \"support_ticket_id\": \"TICK-1024\"\n  },\n  \"stt_keywords\": [\n    \"Akapulu\",\n    \"Alex\",\n    \"Acme\"\n  ],\n  \"record_conversation\": false\n}"

response = http.request(request)
puts response.read_body

{
  "room_url": "https://your-team.daily.co/room-name",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "conversation_session_id": "7f1e7f76-b38d-4d03-b8f8-2570ce8d4e6d"
}

POST

conversations

connect

Connect conversation

curl --request POST \
  --url https://akapulu.com/api/conversations/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scenario_id": "11111111-2222-3333-4444-555555555555",
  "avatar_id": "66666666-7777-8888-9999-000000000000",
  "runtime_vars": {
    "user_name": "Alex",
    "company_name": "Acme Corp",
    "support_ticket_id": "TICK-1024"
  },
  "stt_keywords": [
    "Akapulu",
    "Alex",
    "Acme"
  ],
  "record_conversation": false
}
'

import requests

url = "https://akapulu.com/api/conversations/connect"

payload = {
    "scenario_id": "11111111-2222-3333-4444-555555555555",
    "avatar_id": "66666666-7777-8888-9999-000000000000",
    "runtime_vars": {
        "user_name": "Alex",
        "company_name": "Acme Corp",
        "support_ticket_id": "TICK-1024"
    },
    "stt_keywords": ["Akapulu", "Alex", "Acme"],
    "record_conversation": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    scenario_id: '11111111-2222-3333-4444-555555555555',
    avatar_id: '66666666-7777-8888-9999-000000000000',
    runtime_vars: {user_name: 'Alex', company_name: 'Acme Corp', support_ticket_id: 'TICK-1024'},
    stt_keywords: ['Akapulu', 'Alex', 'Acme'],
    record_conversation: false
  })
};

fetch('https://akapulu.com/api/conversations/connect', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://akapulu.com/api/conversations/connect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'scenario_id' => '11111111-2222-3333-4444-555555555555',
    'avatar_id' => '66666666-7777-8888-9999-000000000000',
    'runtime_vars' => [
        'user_name' => 'Alex',
        'company_name' => 'Acme Corp',
        'support_ticket_id' => 'TICK-1024'
    ],
    'stt_keywords' => [
        'Akapulu',
        'Alex',
        'Acme'
    ],
    'record_conversation' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://akapulu.com/api/conversations/connect"

	payload := strings.NewReader("{\n  \"scenario_id\": \"11111111-2222-3333-4444-555555555555\",\n  \"avatar_id\": \"66666666-7777-8888-9999-000000000000\",\n  \"runtime_vars\": {\n    \"user_name\": \"Alex\",\n    \"company_name\": \"Acme Corp\",\n    \"support_ticket_id\": \"TICK-1024\"\n  },\n  \"stt_keywords\": [\n    \"Akapulu\",\n    \"Alex\",\n    \"Acme\"\n  ],\n  \"record_conversation\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://akapulu.com/api/conversations/connect")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scenario_id\": \"11111111-2222-3333-4444-555555555555\",\n  \"avatar_id\": \"66666666-7777-8888-9999-000000000000\",\n  \"runtime_vars\": {\n    \"user_name\": \"Alex\",\n    \"company_name\": \"Acme Corp\",\n    \"support_ticket_id\": \"TICK-1024\"\n  },\n  \"stt_keywords\": [\n    \"Akapulu\",\n    \"Alex\",\n    \"Acme\"\n  ],\n  \"record_conversation\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://akapulu.com/api/conversations/connect")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scenario_id\": \"11111111-2222-3333-4444-555555555555\",\n  \"avatar_id\": \"66666666-7777-8888-9999-000000000000\",\n  \"runtime_vars\": {\n    \"user_name\": \"Alex\",\n    \"company_name\": \"Acme Corp\",\n    \"support_ticket_id\": \"TICK-1024\"\n  },\n  \"stt_keywords\": [\n    \"Akapulu\",\n    \"Alex\",\n    \"Acme\"\n  ],\n  \"record_conversation\": false\n}"

response = http.request(request)
puts response.read_body

{
  "room_url": "https://your-team.daily.co/room-name",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "conversation_session_id": "7f1e7f76-b38d-4d03-b8f8-2570ce8d4e6d"
}

Use this endpoint to create a conversation session and receive:

room_url
token
conversation_session_id

The connect endpoint returns immediately after creating the conversation session and Daily room credentials. Use the updates endpoint to poll setup progress until the conversation is ready. Required headers:

Authorization: Bearer <YOUR_AKAPULU_API_KEY>
Content-Type: application/json

Required request fields:

scenario_id for the scenario to run
avatar_id for the avatar to use in this conversation

Optional request fields include:

runtime_vars for template/runtime values
stt_keywords for speech recognition hints
- accepts either an array of strings or a comma-separated string
- maximum 5 keywords
record_conversation whether to record this conversation session (default false)

Example request body:

{
  "scenario_id": "scenario_1234",
  "avatar_id": "avatar_5678",
  "runtime_vars": {
    "today": "2026-03-19"
  },
  "stt_keywords": ["Akapulu", "Dr. Nguyen", "A1C"],
  "record_conversation": true
}

Authorizations

Authorization

string

header

required

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

Body

application/json

scenario_id

string<uuid>

required

Scenario ID to run for this conversation.

avatar_id

string<uuid>

required

Avatar ID to use for this conversation.

runtime_vars

object

Runtime variables injected into scenario templates.

stt_keywords

Optional keywords used in the speech-to-text step of the pipeline to improve recognition of specific words in user speech (maximum 5).

Maximum array length: 5

record_conversation

boolean

default:false

If true, enable recording for this conversation session.

Response

Conversation connection created successfully

room_url

string

required

Daily room URL for the session.

token

string

required

Daily access token for joining the room.

conversation_session_id

string<uuid>

required

Created conversation session ID.

Overview

Starting a conversation

Transcripts and recordings

Authorizations

Body

Response