Connect integration

curl --request POST \
  --url http://localhost:8787/api/v1/integrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "<string>",
  "displayName": "<string>",
  "credentials": {}
}
'

import requests

url = "http://localhost:8787/api/v1/integrations"

payload = {
    "provider": "<string>",
    "displayName": "<string>",
    "credentials": {}
}
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({provider: '<string>', displayName: '<string>', credentials: {}})
};

fetch('http://localhost:8787/api/v1/integrations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

POST

integrations

Connect integration

curl --request POST \
  --url http://localhost:8787/api/v1/integrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "<string>",
  "displayName": "<string>",
  "credentials": {}
}
'

import requests

url = "http://localhost:8787/api/v1/integrations"

payload = {
    "provider": "<string>",
    "displayName": "<string>",
    "credentials": {}
}
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({provider: '<string>', displayName: '<string>', credentials: {}})
};

fetch('http://localhost:8787/api/v1/integrations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Connects or updates credentials for a third-party provider. The backend verifies the credentials with the live provider API before saving them (returning 201 on success, 400 if credentials are rejected by the provider, or 502 if the provider is unreachable).

Body parameters

string

required

Provider key — one of PLIVO, TWILIO, ACEFONE, VOBIZ, CAL_COM, WHATSAPP

string

required

A friendly label for this connection (e.g. Main Plivo Account or Support WhatsApp)

object

required

Key-value pair credentials specific to the provider:

PLIVO: { "auth_id": "...", "auth_token": "...", "application_id": "..." }
TWILIO: { "account_sid": "...", "auth_token": "..." }
ACEFONE: { "api_token": "...", "auth_token": "..." }
VOBIZ: { "auth_id": "...", "auth_token": "..." }
CAL_COM: { "api_key": "..." }
WHATSAPP: { "accessToken": "...", "phone_number_id": "...", "business_account_id": "..." }

curl -X POST https://api.agentic-os.com/api/v1/integrations \
  -H "Authorization: Bearer $AGENTIC_OS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "PLIVO",
    "displayName": "Main Plivo Account",
    "credentials": {
      "auth_id": "MAMXXXXXXXXXXXXXXXXX",
      "auth_token": "your_auth_token_here",
      "application_id": "app_xxxxxxxx"
    }
  }'

import os, requests

resp = requests.post(
    "https://api.agentic-os.com/api/v1/integrations",
    headers={
        "Authorization": f"Bearer {os.environ['AGENTIC_OS_API_KEY']}",
        "Content-Type": "application/json",
    },
    json={
        "provider": "PLIVO",
        "displayName": "Main Plivo Account",
        "credentials": {
            "auth_id": "MAMXXXXXXXXXXXXXXXXX",
            "auth_token": "your_auth_token_here",
            "application_id": "app_xxxxxxxx",
        },
    },
)
print(resp.json())

await fetch("https://api.agentic-os.com/api/v1/integrations", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.AGENTIC_OS_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    provider: "PLIVO",
    displayName: "Main Plivo Account",
    credentials: {
      auth_id: "MAMXXXXXXXXXXXXXXXXX",
      auth_token: "your_auth_token_here",
      application_id: "app_xxxxxxxx",
    },
  }),
});

Response

{
  "id": "conn_9a8b7c6d-...",
  "provider": "PLIVO",
  "displayName": "Main Plivo Account",
  "status": "CONNECTED",
  "createdAt": "2026-08-15T12:00:00.000Z"
}

⌘I

Overview

Account

Integrations

Configuration

Agents

Numbers

Calls

Campaigns

Knowledge Bases

WhatsApp

Logs

Analytics

Connect integration

Body parameters

Response

​Body parameters

​Response

Body parameters

Response