canonical: https://jentic.com/apis/synthflow.ai/synthflow

# Synthflow AI API

Synthflow AI voice agent API for managing AI assistants and calls. The API exposes 8 endpoints secured with bearer authentication.

## For AI agents

Programmatically create assistant, list assistants. Covers 8 operations with bearer authentication.

## Scope

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

## Capabilities

- Create assistant
- List assistants
- Get assistant
- Update assistant
- Delete assistant

## Use cases

### Communications Operations

Use the Synthflow AI API to perform communications operations programmatically. The API provides 8 endpoints covering core functionality including create assistant, list assistants, get assistant.

Example prompt: Call POST /assistants to create assistant

### Automated Assistants Management

Automate assistants operations by combining multiple Synthflow AI API endpoints. Agents can list assistants and then get assistant in a single workflow.

Example prompt: Call GET /assistants to list assistants, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Synthflow AI 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 bearer tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/assistants` | Create assistant |
| GET | `/assistants` | List assistants |
| GET | `/assistants/{id}` | Get assistant |
| PUT | `/assistants/{id}` | Update assistant |
| DELETE | `/assistants/{id}` | Delete assistant |
| POST | `/calls` | Create call |
| GET | `/calls` | List calls |
| GET | `/calls/{id}` | Get call |

## Key resources

- **Assistants** — Operations related to Assistants
- **Calls** — Operations related to Calls

## Why Jentic

- **Setup:** Wiring the Synthflow AI API by hand means learning its bearer token scheme, pointing at the api.synthflow.ai host, and shaping the assistant and call requests yourself. Through Jentic you install once, import Synthflow from the API Directory, store the bearer token once, and your agent calls it.
- **Permission scoping:** Synthflow puts the record id in the URL path (`/assistants/{id}`, `/calls/{id}`), so a rule can pin your agent to one assistant: it can read and update that assistant and nothing else. You choose the operations it may call, so destructive ones like deleting an assistant are not included unless you add them.
- **Credential handling:** Your Synthflow bearer token 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 'create an assistant' or 'start a call', and Jentic returns the matching Synthflow operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the Synthflow AI API use?

The Synthflow AI API uses a Bearer token 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 create assistant with the Synthflow AI API?

Yes. Use the POST /assistants endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Synthflow AI 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 create assistant through Jentic?

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

### How many endpoints does the Synthflow AI API have?

The Synthflow AI API exposes 8 endpoints covering assistants, calls operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Synthflow operations and credentials the agent may use. Synthflow puts the record id in the URL path (`/assistants/{id}`, `/calls/{id}`), so you can pin the agent to a single assistant and let it only read and update that one record. You also choose which operations are exposed, so destructive calls like deleting an assistant are excluded unless you explicitly add them.