Place Outbound Call

curl --request POST \
  --url https://api.pokulabs.com/calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "to": "<string>",
  "from": "<string>",
  "transferTo": "<string>",
  "language": "en-US",
  "voice": "female",
  "waitForCallEnd": true
}
'

import requests

url = "https://api.pokulabs.com/calls"

payload = {
    "prompt": "<string>",
    "to": "<string>",
    "from": "<string>",
    "transferTo": "<string>",
    "language": "en-US",
    "voice": "female",
    "waitForCallEnd": True
}
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({
    prompt: '<string>',
    to: '<string>',
    from: '<string>',
    transferTo: '<string>',
    language: 'en-US',
    voice: 'female',
    waitForCallEnd: true
  })
};

fetch('https://api.pokulabs.com/calls', 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://api.pokulabs.com/calls",
  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([
    'prompt' => '<string>',
    'to' => '<string>',
    'from' => '<string>',
    'transferTo' => '<string>',
    'language' => 'en-US',
    'voice' => 'female',
    'waitForCallEnd' => true
  ]),
  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://api.pokulabs.com/calls"

	payload := strings.NewReader("{\n  \"prompt\": \"<string>\",\n  \"to\": \"<string>\",\n  \"from\": \"<string>\",\n  \"transferTo\": \"<string>\",\n  \"language\": \"en-US\",\n  \"voice\": \"female\",\n  \"waitForCallEnd\": true\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://api.pokulabs.com/calls")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"<string>\",\n  \"to\": \"<string>\",\n  \"from\": \"<string>\",\n  \"transferTo\": \"<string>\",\n  \"language\": \"en-US\",\n  \"voice\": \"female\",\n  \"waitForCallEnd\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pokulabs.com/calls")

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  \"prompt\": \"<string>\",\n  \"to\": \"<string>\",\n  \"from\": \"<string>\",\n  \"transferTo\": \"<string>\",\n  \"language\": \"en-US\",\n  \"voice\": \"female\",\n  \"waitForCallEnd\": true\n}"

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

{
  "interactionId": "f3f7870f-30f5-4bf2-83b0-a05bc140030c"
}

POST

calls

Place Outbound Call

curl --request POST \
  --url https://api.pokulabs.com/calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "to": "<string>",
  "from": "<string>",
  "transferTo": "<string>",
  "language": "en-US",
  "voice": "female",
  "waitForCallEnd": true
}
'

import requests

url = "https://api.pokulabs.com/calls"

payload = {
    "prompt": "<string>",
    "to": "<string>",
    "from": "<string>",
    "transferTo": "<string>",
    "language": "en-US",
    "voice": "female",
    "waitForCallEnd": True
}
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({
    prompt: '<string>',
    to: '<string>',
    from: '<string>',
    transferTo: '<string>',
    language: 'en-US',
    voice: 'female',
    waitForCallEnd: true
  })
};

fetch('https://api.pokulabs.com/calls', 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://api.pokulabs.com/calls",
  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([
    'prompt' => '<string>',
    'to' => '<string>',
    'from' => '<string>',
    'transferTo' => '<string>',
    'language' => 'en-US',
    'voice' => 'female',
    'waitForCallEnd' => true
  ]),
  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://api.pokulabs.com/calls"

	payload := strings.NewReader("{\n  \"prompt\": \"<string>\",\n  \"to\": \"<string>\",\n  \"from\": \"<string>\",\n  \"transferTo\": \"<string>\",\n  \"language\": \"en-US\",\n  \"voice\": \"female\",\n  \"waitForCallEnd\": true\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://api.pokulabs.com/calls")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"<string>\",\n  \"to\": \"<string>\",\n  \"from\": \"<string>\",\n  \"transferTo\": \"<string>\",\n  \"language\": \"en-US\",\n  \"voice\": \"female\",\n  \"waitForCallEnd\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pokulabs.com/calls")

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  \"prompt\": \"<string>\",\n  \"to\": \"<string>\",\n  \"from\": \"<string>\",\n  \"transferTo\": \"<string>\",\n  \"language\": \"en-US\",\n  \"voice\": \"female\",\n  \"waitForCallEnd\": true\n}"

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

{
  "interactionId": "f3f7870f-30f5-4bf2-83b0-a05bc140030c"
}

Authorizations

Authorization

string

header

required

Authentication header containing your Poku API key. Find it in the Poku dashboard. The format is "Bearer YOUR_API_KEY"

Body

application/json

prompt

string

required

The prompt defines the AI's personality, conversation topic, and objective.

Example:

You are a friendly voice assistant calling on behalf of Joe to make a dinner reservation.

Make a dinner reservation for a party of 2 people on [day] at [time], under the name Joe Smith.
- If that time is available, confirm the reservation and ask if a note is needed for a special occasion.
- If [time] is unavailable, ask what times are open and accept an alternative within one hour of the original if reasonable. Confirm the new time back clearly before ending the call.
- If no one answers, leave this voicemail: "Hi, this is a message on behalf of Joe — I'm hoping to make a dinner reservation for 2 on [day] at [time]. Please call back to confirm. Thank you."

string

required

The number you want to call, in E.164 format.

from

string

Defaults to your Poku reserved number. If you don't have one, falls back to a Poku shared number.

You can also bring your own number from Twilio or Messagebird. Configure your credentials on the Integrations page and pass the number here in E.164 format.

transferTo

string

The number the agent will transfer the call to if the other party asks to speak with a human. Must be in E.164 format.

language

string

Specifies the language. For example, fr-FR for French. Defaults to en-US if unset.

Available options: en-US, de-DE, es-ES, hi-IN, fr-FR, ja-JP, pt-PT, zh-CN, ru-RU, it-IT, ko-KR, nl-NL, pl-PL, tr-TR, vi-VN, ro-RO, bg-BG, ca-ES, th-TH, da-DK, fi-FI, el-GR, hu-HU, id-ID, no-NO, sk-SK, sv-SE, lt-LT, lv-LV, cs-CZ, ms-MY, af-ZA, ar-SA, az-AZ, bs-BA, cy-GB, fa-IR, fil-PH, gl-ES, he-IL, hr-HR, hy-AM, is-IS, kk-KZ, kn-IN, mk-MK, mr-IN, ne-NP, sl-SI, sr-RS, sw-KE, ta-IN, ur-IN, yue-CN, uk-UA

Example:

"en-US"

voice

enum<string>

default:female

Selects the voice used for the call. Defaults to female if unset.

Available options:

male,

female

waitForCallEnd

boolean

default:false

When false or omitted, the request returns immediately with an interactionId while the call continues in the background. Use Get Interaction Status to check whether the call has ended.

When true, the HTTP request stays open until the call ends, then returns the call summary and recording URL when available.

Example:

true

Response

200 - application/json

Call started or completed successfully.

response

string

Returned when waitForCallEnd is true. A natural language summary of the call outcome.

call

object

Show child attributes

interactionId

string

Unique identifier for this call interaction. Returned for both async and wait-for-completion requests.

Send an SMS

Calls

Messages

Forms

Interactions

Numbers

Webhooks

Place Outbound Call

Authorizations

Body

Response