Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions api-reference/agents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@

## Agent verification

Agents can be verified using multiple verification types: `eas` (Ethereum Attestation Service), `coinbase`, `ens`, or `webauthn`.

Check warning on line 478 in api-reference/agents.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L478

Did you really mean 'Ethereum'?

### Get verification status

Expand Down Expand Up @@ -548,7 +548,7 @@

Provisions a new agent with messaging channel tokens. No authentication is required. Rate-limited per IP. At least one channel token is required.

The request is proxied to the backend provisioning service. A dedicated Mux live stream is automatically created for the agent. The backend may enqueue the provisioning job to the `provision` queue for asynchronous processing.

Check warning on line 551 in api-reference/agents.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L551

Did you really mean 'proxied'?

Check warning on line 551 in api-reference/agents.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L551

Did you really mean 'Mux'?

### Request body

Expand All @@ -561,6 +561,8 @@
| `aiProvider` | string | No | AI provider (default: `openrouter`). Options: `openrouter`, `gemini`, `groq`, `anthropic`, `openai` |
| `apiKey` | string | No | API key for the AI provider |
| `plan` | string | No | Plan tier. Options: `solo`, `collective`, `label`, `network`. A paid plan is required — requests with `plan` set to `free` (or omitted) return `402 Payment Required`. |
| `email` | string | No | User email address. Used for admin and tester bypass of payment requirements. |
| `stripeSubscriptionId` | string | No | Stripe subscription ID. Required for paid plans unless the caller is an admin or tester. |

<Warning>The `free` plan value is deprecated. The provisioning service now requires a paid plan (`solo`, `collective`, `label`, or `network`) and a valid Stripe subscription. Requests with `plan` set to `free` return `402 Payment Required` with `code: "PAYMENT_REQUIRED"`.</Warning>

Expand All @@ -581,17 +583,18 @@
}
```

<Note>The `/api/provision` proxy returns only `success`, `userId`, `subdomain`, `url`, `streamKey`, and `liveStreamId`. Additional fields such as `aiProvider`, `plan`, and `playbackUrl` are available when calling the backend provisioning service directly.</Note>
<Note>The `/api/provision` proxy returns only `success`, `userId`, `subdomain`, `url`, `streamKey`, and `liveStreamId`. Additional fields such as `agentId`, `aiProvider`, `aiProviderConfig`, `plan`, `playbackUrl`, `hls`, `rtmp`, `status`, `createdAt`, and `metadata` are available when calling the backend provisioning service directly.</Note>

Check warning on line 586 in api-reference/agents.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L586

Did you really mean 'userId'?

Check warning on line 586 in api-reference/agents.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L586

Did you really mean 'streamKey'?

Check warning on line 586 in api-reference/agents.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L586

Did you really mean 'agentId'?

Check warning on line 586 in api-reference/agents.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L586

Did you really mean 'aiProvider'?

Check warning on line 586 in api-reference/agents.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L586

Did you really mean 'playbackUrl'?

Check warning on line 586 in api-reference/agents.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L586

Did you really mean 'hls'?

Check warning on line 586 in api-reference/agents.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L586

Did you really mean 'rtmp'?

Check warning on line 586 in api-reference/agents.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L586

Did you really mean 'createdAt'?

### Errors

| Code | Description |
|------|-------------|
| 400 | At least one channel token required (Telegram, WhatsApp, or Discord) |
| 400 | At least one channel token required (Telegram, WhatsApp, or Discord), invalid `aiProvider` value, or invalid `plan` value |
| 402 | Payment required. Returned when `plan` is `free` or when no valid Stripe subscription is present. The response includes `code: "PAYMENT_REQUIRED"` and a message directing the user to choose a paid plan. |
| 429 | Too many requests |
| 500 | Internal server error |
| 502 | Provisioning service unavailable or returned an error |
| 503 | Provisioning is temporarily disabled (kill switch is active) |

## Agent interaction

Expand Down Expand Up @@ -786,7 +789,7 @@
|-------|------|----------|-------------|
| `action` | string | Yes | `set-credential` |
| `key` | string | Yes | Credential key (for example, `anthropic`, `telegram`) |
| `value` | string | No | Credential value. When omitted, the credential is marked as unconfigured. |

Check warning on line 792 in api-reference/agents.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L792

Did you really mean 'unconfigured'?

```json
{
Expand Down