Skip to content
Open
Show file tree
Hide file tree
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
136 changes: 74 additions & 62 deletions api-reference/agents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,29 +35,6 @@
}
```

## Create agent

```http
POST /api/agents
```

### Request body

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | Yes | Name of the agent |
| `config` | object | No | Agent configuration |

### Response

```json
{
"id": "agent_456",
"name": "My Agent",
"status": "deploying"
}
```

## Get agent

```http
Expand Down Expand Up @@ -95,40 +72,6 @@
| 404 | Agent not found or not owned by user |
| 500 | Failed to fetch agent |

## Update agent

```http
PUT /api/agents/:id
```

### Request body

Any valid agent configuration fields.

### Response

```json
{
"id": "agent_123",
"message": "Agent updated"
}
```

## Delete agent

```http
DELETE /api/agents/:id
```

### Response

```json
{
"id": "agent_123",
"message": "Agent deleted"
}
```

## Provision agent

```http
Expand Down Expand Up @@ -527,7 +470,7 @@

## Agent verification

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

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

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L473

Did you really mean 'Ethereum'?

### Get verification status

Expand Down Expand Up @@ -600,7 +543,7 @@

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

A dedicated Mux live stream is automatically created for the agent.

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

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/agents.mdx#L546

Did you really mean 'Mux'?

### Request body

Expand All @@ -624,18 +567,51 @@
{
"success": true,
"userId": "a1b2c3d4e5f6g7h8",
"agentId": "agent_789",
"id": "a1b2c3d4e5f6g7h8",
"aiProvider": "openrouter",
"aiProviderConfig": {
"model": "anthropic/claude-sonnet-4-20250514",
"baseUrl": "https://openrouter.ai/api/v1",
"requiresKey": true
},
"plan": "free",
"streamKey": "live_abc123",
"liveStreamId": "stream_456",
"rtmpServer": "rtmps://global-live.mux.com:443/app",
"playbackUrl": "https://stream.mux.com/abc123.m3u8",
"subdomain": "a1b2c3d4e5f6g7h8.agents.localhost",
"url": "https://a1b2c3d4e5f6g7h8.agents.localhost",
"streamKey": "live_abc123",
"liveStreamId": "stream_456"
"hls": {
"playlistUrl": "https://stream.mux.com/abc123.m3u8"
},
"rtmp": {
"server": "rtmps://global-live.mux.com:443/app",
"key": "live_abc123"
},
"status": "active",
"createdAt": "2026-03-19T00:00:00Z",
"metadata": {
"channels": {
"telegram": true,
"discord": false,
"whatsapp": false
},
"streaming": {
"provider": "mux",
"lowLatency": true,
"resolution": "1080p",
"bitrate": "5000kbps"
}
}
}
```

### Errors

| Code | Description |
|------|-------------|
| 400 | At least one channel token required (Telegram, WhatsApp, or Discord) |
| 400 | At least one channel token required, invalid AI provider, or invalid plan |
| 401 | Unauthorized |
| 429 | Too many requests |
| 500 | Internal server error |
Expand Down Expand Up @@ -859,12 +835,48 @@
POST /api/chat
```

Requires session authentication.

### Request body

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `message` | string | Yes | Message to send |
| `topic` | string | No | Conversation topic |

### Response

```json
{
"agentId": "agent_123",
"id": "msg_abc123",
"message": "Hello!",
"platform": "telegram"
"topic": "general",
"status": "sent",
"timestamp": "2026-03-19T00:00:00Z",
"reply": "Message received by agent"
}
```

### Get chat history

```http
GET /api/chat
```

Requires session authentication.

```json
{
"messages": [],
"count": 0
}
```

### Errors

| Code | Description |
|------|-------------|
| 400 | Message required |
| 401 | Unauthorized |
| 500 | Failed to send message or failed to fetch messages |
```
34 changes: 34 additions & 0 deletions api-reference/ai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,40 @@

Endpoints for interacting with AI models through a unified provider layer. These endpoints are served by the backend API and do not require session authentication.

## List models (frontend)

```http
GET /api/models
```

Returns available AI models from OpenRouter with additional featured models. No authentication required.

### Response

```json
{
"models": [
{
"id": "anthropic/claude-sonnet-4-20250514",
"name": "Claude Sonnet",
"contextLength": 200000,
"pricing": {
"prompt": 0.003,
"completion": 0.015
},
"featured": true,
"description": "Anthropic's Claude Sonnet model"

Check warning on line 32 in api-reference/ai.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/ai.mdx#L32

Did you really mean 'Anthropic's'?
}
]
}
```

### Errors

| Code | Description |
|------|-------------|
| 500 | Failed to fetch models or invalid response from provider |

## Health check

```http
Expand Down
9 changes: 9 additions & 0 deletions api-reference/keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# API keys

Create and manage API keys for authenticating with the Agentbot API. All endpoints require session authentication.

Check warning on line 8 in api-reference/keys.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/keys.mdx#L8

Did you really mean 'Agentbot'?

## List keys

Expand All @@ -29,6 +29,13 @@
}
```

### Errors

| Code | Description |
|------|-------------|
| 401 | Unauthorized |
| 500 | Failed to fetch keys |

## Create key

```http
Expand Down Expand Up @@ -88,6 +95,7 @@
|------|-------------|
| 401 | Unauthorized |
| 404 | Key not found |
| 500 | Failed to fetch key |

## Delete key

Expand All @@ -111,3 +119,4 @@
|------|-------------|
| 401 | Unauthorized |
| 404 | Key not found |
| 500 | Failed to delete key |
5 changes: 2 additions & 3 deletions api-reference/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: API reference
description: "Complete API reference for Agentbot"

Check warning on line 3 in api-reference/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/overview.mdx#L3

Did you really mean 'Agentbot'?
---

# API reference

Complete API reference for Agentbot.

Check warning on line 8 in api-reference/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/overview.mdx#L8

Did you really mean 'Agentbot'?

## Base URL

Expand All @@ -15,7 +15,7 @@

## Authentication

Agentbot supports two authentication methods depending on the endpoint.

Check warning on line 18 in api-reference/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/overview.mdx#L18

Did you really mean 'Agentbot'?

### Session authentication

Expand Down Expand Up @@ -88,10 +88,7 @@
|----------|--------|-------------|
| `/api/v1/gateway` | POST | Route requests to plugins with Stripe or [MPP](/payments/mpp) payment |
| `/api/agents` | GET | List all agents |
| `/api/agents` | POST | Create an agent |
| `/api/agents/:id` | GET | Get agent details |
| `/api/agents/:id` | PUT | Update an agent |
| `/api/agents/:id` | DELETE | Delete an agent |
| `/api/agents/:id/config` | GET | Get agent configuration |
| `/api/agents/:id/config` | PUT | Update agent configuration |
| `/api/agents/:id/logs` | GET | Get agent logs |
Expand All @@ -112,6 +109,8 @@
| `/api/agents/provision` | POST | Provision a new agent |
| `/api/agents/provision` | GET | List provisioned agents |
| `/api/chat` | POST | Send message to agent |
| `/api/chat` | GET | Get chat history |
| `/api/models` | GET | List available AI models |
| `/api/health` | GET | Health check |
| `/api/heartbeat` | GET | Get heartbeat settings |
| `/api/heartbeat` | POST | Update heartbeat settings |
Expand Down Expand Up @@ -145,8 +144,8 @@
| `/api/auth/callback/wallet` | POST | Wallet sign in (SIWE) |
| `/api/auth/forgot-password` | POST | Request password reset |
| `/api/auth/reset-password` | POST | Reset password |
| `/api/auth/farcaster/verify` | POST | Verify Farcaster identity |

Check warning on line 147 in api-reference/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/overview.mdx#L147

Did you really mean 'Farcaster'?
| `/api/auth/farcaster/refresh` | POST | Refresh Farcaster token |

Check warning on line 148 in api-reference/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/overview.mdx#L148

Did you really mean 'Farcaster'?
| `/api/auth/token-gating/verify` | GET, POST | Verify token gating access |
| `/api/billing` | GET | Get billing info |
| `/api/billing` | POST | Billing actions (checkout, BYOK, usage, credits) |
Expand All @@ -162,7 +161,7 @@

## SDK

Use the Agentbot SDK:

Check warning on line 164 in api-reference/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/overview.mdx#L164

Did you really mean 'Agentbot'?

```bash
npm install @agentbot/sdk
Expand Down
2 changes: 2 additions & 0 deletions api-reference/wallet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# Wallet API

Manage wallets for on-chain transactions and payments. Supports both session-based wallets and Coinbase Developer Platform (CDP) wallets.

Check warning on line 8 in api-reference/wallet.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/wallet.mdx#L8

Did you really mean 'Coinbase'?

## Get wallet

Expand All @@ -30,7 +30,7 @@
"x402_payments"
]
},
"instructions": "CDP Agentic Wallet is configured. Use /api/wallet/cdp/* endpoints."

Check warning on line 33 in api-reference/wallet.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/wallet.mdx#L33

Did you really mean 'Agentic'?
}
```

Expand Down Expand Up @@ -115,7 +115,9 @@
|------|-------------|
| 400 | Invalid action or wallet already exists |
| 401 | Unauthorized |
| 403 | Seed export is disabled for security (for `export_seed`) |
| 404 | No wallet found (for `get_seed`) |
| 500 | Failed to fetch wallet or failed to process request |

## Get CDP wallet address

Expand All @@ -123,7 +125,7 @@
GET /api/wallet/address
```

Returns the address of the CDP Agentic Wallet.

Check warning on line 128 in api-reference/wallet.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/wallet.mdx#L128

Did you really mean 'Agentic'?

### Response (authenticated)

Expand All @@ -150,7 +152,7 @@
POST /api/wallet/create
```

Creates a new wallet using the Coinbase Developer Platform SDK.

Check warning on line 155 in api-reference/wallet.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/wallet.mdx#L155

Did you really mean 'Coinbase'?

### Request body

Expand Down Expand Up @@ -198,7 +200,7 @@
POST /api/wallet/cdp
```

Creates a viem wallet client on Base Sepolia.

Check warning on line 203 in api-reference/wallet.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/wallet.mdx#L203

Did you really mean 'viem'?

Check warning on line 203 in api-reference/wallet.mdx

View check run for this annotation

Mintlify / Mintlify Validation (raveculture) - vale-spellcheck

api-reference/wallet.mdx#L203

Did you really mean 'Sepolia'?

### Request body

Expand Down