canonical: https://jentic.com/apis/yeti-switch.org/yeti-switch

# Yeti-Switch API

Yeti-Switch is a Session Border Controller (SBC) for VoIP interconnection. It provides two JSONAPI-compliant REST APIs: an Admin API for configuration and provisioning, and a Customer API for end-user access to rates, CDRs, and account information. This spec covers the Admin API. All requests and responses use the JSONAPI specification (application/vnd.api+json). The API exposes 101 endpoints secured with bearer authentication.

## For AI agents

Programmatically set account balance, apply balance correction. Covers 101 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for identity and authentication only.

## Capabilities

- Set account balance
- Apply balance correction
- Create Account
- List Accounts
- Get Account by ID
- Update Account
- Delete Account

## Use cases

### Identity and Authentication Operations

Use the Yeti-Switch API to perform identity auth operations programmatically. The API provides 101 endpoints covering core functionality including set account balance, apply balance correction, create account.

Example prompt: Call PUT `/balances/{account_external_id}` to set account balance

### Automated Accounts Management

Automate accounts operations by combining multiple Yeti-Switch API endpoints. Agents can apply balance correction and then create account in a single workflow.

Example prompt: Call PUT `/balances-correction/{account_external_id}` to apply balance correction, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Yeti-Switch 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 'set account balance', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| PUT | `/balances/{account_external_id}` | Set account balance |
| PUT | `/balances-correction/{account_external_id}` | Apply balance correction |
| POST | `/accounts` | Create Account |
| GET | `/accounts` | List Accounts |
| GET | `/accounts/{id}` | Get Account by ID |
| PATCH | `/accounts/{id}` | Update Account |
| DELETE | `/accounts/{id}` | Delete Account |
| POST | `/contractors` | Create Contractor |

## Key resources

- **Accounts** — Operations related to Accounts
- **AdminUsers** — Operations related to AdminUsers
- **Balances** — Operations related to Balances
- **CDRs** — Operations related to CDRs
- **CodecGroups** — Operations related to CodecGroups

## Why Jentic

- **Setup:** Wiring Yeti-Switch by hand means sending its admin bearer token against your own server_url host, accepting that the token carries full administrator access, and handling retries yourself. Through Jentic you install once, import Yeti-Switch from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Yeti-Switch puts the account id in the URL path (`/accounts/{id}`), so a rule can pin your agent to one account: it can read and update that account and nothing else. You choose the operations it may call, so destructive ones like deleting an account or correcting a balance are not included unless you add them.
- **Credential handling:** Your Yeti-Switch 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 'set an account balance' or 'create an account', and Jentic returns the matching Yeti-Switch operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Auth0** — Alternative identity auth API
- **Okta** — Alternative identity auth API

## FAQ

### What authentication does the Yeti-Switch API use?

The Yeti-Switch 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 set account balance with the Yeti-Switch API?

Yes. Use the PUT `/balances/{account_external_id}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Yeti-Switch 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 set account balance through Jentic?

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

### How many endpoints does the Yeti-Switch API have?

The Yeti-Switch API exposes 101 endpoints covering accounts, adminusers, balances operations.

### Can I limit what my agent is allowed to do with the Yeti-Switch API?

Yes. Jentic One runs self-hosted, so your own rules decide which operations and credentials the agent can use. Because Yeti-Switch puts the account id in the URL path, such as `/accounts/{id}`, you can pin the agent to a single account and let it read and update only that one. You also choose which operations it may call, so destructive actions like DELETE `/accounts/{id}` or applying a balance correction stay off unless you add them.