canonical: https://jentic.com/apis/superbot.one/superbot-one

# Superbot One Superbot API

Superbot voice AI platform API for managing superbots, campaigns, calling contacts, and generating TTS audio. The API exposes 6 endpoints secured with apiKey authentication.

## For AI agents

Programmatically list superbots, list campaigns. Covers 6 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- List superbots
- Queue calls in campaign
- Update contact in campaign
- Get contact records
- Generate TTS audio

## Use cases

### CRM Operations

Use the Superbot API to perform crm operations programmatically. The API provides 6 endpoints covering core functionality including list superbots, list campaigns, queue calls in campaign.

Example prompt: Call GET `/v2/superbot` to list superbots

### Automated Calls Management

Automate calls operations by combining multiple Superbot API endpoints. Agents can list campaigns and then queue calls in campaign in a single workflow.

Example prompt: Call GET `/v2/superbot/{superbot}/campaign` to list campaigns, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Superbot API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'list superbots', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v2/superbot` | List superbots |
| GET | `/v2/superbot/{superbot}/campaign` | List campaigns |
| POST | `/v2/superbot/{superbot}/campaign/{campaign}/call` | Queue calls in campaign |
| POST | `/v2/superbot/{superbot}/campaign/{campaign}/contact/update` | Update contact in campaign |
| GET | `/v2/superbot/{superbot}/campaign/{campaign}/contact/{phone}` | Get contact records |
| POST | `/v2/tts` | Generate TTS audio |

## Key resources

- **Calls** — Operations related to Calls
- **Campaigns** — Operations related to Campaigns
- **Contacts** — Operations related to Contacts
- **Superbots** — Operations related to Superbots
- **TTS** — Operations related to TTS

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 65 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 90 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 46 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/superbot.one/superbot-one/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Superbot API by hand means passing its API key as an Authorization header and handling retries yourself. Through Jentic you install once, import the Superbot API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The Superbot API puts the superbot and campaign ids in the URL path (`/v2/superbot/{superbot}/campaign/{campaign}/...`), so a rule can pin your agent to one superbot or one campaign: it can read that campaign and nothing else. You choose the operations it may call, so ones like placing a call or updating a contact are not included unless you add them.
- **Credential handling:** Your Superbot API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list superbots' or 'read a campaign contact', and Jentic returns the matching Superbot API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Superbot API use?

The Superbot API uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I list superbots with the Superbot API?

Yes. Use the GET `/v2/superbot` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Superbot API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I list superbots through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list superbots'. Jentic returns the matching Superbot API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Superbot API have?

The Superbot API exposes 6 endpoints covering calls, campaigns, contacts operations.

### Can I limit what my agent is allowed to do with the Superbot API?

Yes. Because you run Jentic One yourself, your own rules decide which Superbot API operations your agent may call, so you can grant only read calls like listing superbots (GET `/v2/superbot`) or reading a campaign contact while withholding write calls such as queuing a call or updating a contact. Since the Superbot API carries the superbot and campaign ids in the URL path, a rule can pin the agent to a single superbot or campaign, letting it read that campaign and nothing else. The stored API key stays with your Jentic One instance and is injected only for the operations you have allowed.