Skip to main content
POST
/
agent
Initiate Call
curl --request POST \
  --url https://api.plura.ai/v1/agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent": "aa951bc8-2942-4a75-9162-ba9946c7808",
  "phone": "17145551234",
  "from": "15045798220",
  "request_data": {
    "first_name": "John",
    "last_name": "Smith",
    "appointment_date": "2024-03-15"
  }
}
'
import requests

url = "https://api.plura.ai/v1/agent"

payload = {
    "agent": "aa951bc8-2942-4a75-9162-ba9946c7808",
    "phone": "17145551234",
    "from": "15045798220",
    "request_data": {
        "first_name": "John",
        "last_name": "Smith",
        "appointment_date": "2024-03-15"
    }
}
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({
    agent: 'aa951bc8-2942-4a75-9162-ba9946c7808',
    phone: '17145551234',
    from: '15045798220',
    request_data: {first_name: 'John', last_name: 'Smith', appointment_date: '2024-03-15'}
  })
};

fetch('https://api.plura.ai/v1/agent', 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.plura.ai/v1/agent",
  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([
    'agent' => 'aa951bc8-2942-4a75-9162-ba9946c7808',
    'phone' => '17145551234',
    'from' => '15045798220',
    'request_data' => [
        'first_name' => 'John',
        'last_name' => 'Smith',
        'appointment_date' => '2024-03-15'
    ]
  ]),
  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.plura.ai/v1/agent"

	payload := strings.NewReader("{\n  \"agent\": \"aa951bc8-2942-4a75-9162-ba9946c7808\",\n  \"phone\": \"17145551234\",\n  \"from\": \"15045798220\",\n  \"request_data\": {\n    \"first_name\": \"John\",\n    \"last_name\": \"Smith\",\n    \"appointment_date\": \"2024-03-15\"\n  }\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.plura.ai/v1/agent")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent\": \"aa951bc8-2942-4a75-9162-ba9946c7808\",\n  \"phone\": \"17145551234\",\n  \"from\": \"15045798220\",\n  \"request_data\": {\n    \"first_name\": \"John\",\n    \"last_name\": \"Smith\",\n    \"appointment_date\": \"2024-03-15\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.plura.ai/v1/agent")

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  \"agent\": \"aa951bc8-2942-4a75-9162-ba9946c7808\",\n  \"phone\": \"17145551234\",\n  \"from\": \"15045798220\",\n  \"request_data\": {\n    \"first_name\": \"John\",\n    \"last_name\": \"Smith\",\n    \"appointment_date\": \"2024-03-15\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "call_id": "0b62751b-9023-4f5d-a52c-2ea233240ed",
  "to": "17145551234",
  "from": "15045798220",
  "agent": "aa951bc8-2942-4a75-9162-ba9946c7808"
}
{
  "status": "failed",
  "message": "Human-readable error description"
}
{
  "status": "failed",
  "message": "Human-readable error description"
}

Authorizations

​
Authorization
string
header
required

API key from Settings → API Keys in your workspace

Body

application/json
​
agent
string
required

Agent UUID from your workspace

Example:

"aa951bc8-2942-4a75-9162-ba9946c7808"

​
phone
string
required

Recipient phone number in E.164 format

Example:

"17145551234"

​
from
string

Caller ID. If omitted, auto-selected from the agent's phone group.

Example:

"15045798220"

​
request_data
object

Flexible context data passed directly to your workflow. Accepts any JSON structure.

Example:
{
  "first_name": "John",
  "last_name": "Smith",
  "appointment_date": "2024-03-15",
  "service_type": "consultation"
}

Response

Call initiated successfully

​
call_id
string
Example:

"0b62751b-9023-4f5d-a52c-2ea233240ed"

​
to
string
Example:

"17145551234"

​
from
string
Example:

"15045798220"

​
agent
string
Example:

"aa951bc8-2942-4a75-9162-ba9946c7808"