# ChatterLab API

**Canonical:** https://apis.io/apis/chatterlab-ai/chatterlab-ai-api/  
**Provider:** ChatterLab — https://apis.io/providers/chatterlab-ai/  
**Documentation:** https://chatterlab.ai/en/docs/developers/api-reference

ChatterLab API is one of 2 APIs that [ChatterLab](https://apis.io/providers/chatterlab-ai/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

ChatterLab API as documented publicly: 43 operations. Contract generated from the documentation by API Evangelist (2026-11-04); not the provider's own document.

## Operations (43)

| Method | Path | Summary |
|---|---|---|
| GET | `/agents` | List agents |
| POST | `/agents` | Create an agent |
| DELETE | `/agents/{id}` | Delete an agent |
| GET | `/agents/{id}` | One agent |
| PATCH | `/agents/{id}` | Change an agent |
| GET | `/agents/{id}/analytics` | Figures for a period |
| DELETE | `/agents/{id}/branding/{image}` | Remove the logo or the launcher image |
| PUT | `/agents/{id}/branding/{image}` | Set the logo or the launcher image from an address |
| POST | `/agents/{id}/chat` | Ask a question |
| DELETE | `/agents/{id}/client` | Take the client off an agent |
| GET | `/agents/{id}/client` | The client an agent is run for |
| PUT | `/agents/{id}/client` | Record a client, or change what is recorded |
| POST | `/agents/{id}/client/report-link` | Give the client a new report link |
| GET | `/agents/{id}/conversations` | List conversations |
| DELETE | `/agents/{id}/conversations/{conversationid}` | Erase one conversation |
| GET | `/agents/{id}/conversations/{conversationid}` | One conversation with its messages |
| DELETE | `/agents/{id}/crawl` | Stop the latest crawl |
| GET | `/agents/{id}/crawl` | Progress of the latest crawl |
| GET | `/agents/{id}/embed` | The install snippets |
| GET | `/agents/{id}/leads` | List the contact details visitors left |
| DELETE | `/agents/{id}/leads/{leadid}` | Erase one lead |
| GET | `/agents/{id}/leads/{leadid}` | One lead |
| POST | `/agents/{id}/messages/{messageid}/correction` | Correct one answer |
| POST | `/agents/{id}/retrain` | Read every source again |
| GET | `/agents/{id}/sources` | List sources |
| POST | `/agents/{id}/sources` | Add a website, a file, a text or a Q&A pair |
| DELETE | `/agents/{id}/sources/{sourceid}` | Delete a source |
| GET | `/agents/{id}/sources/{sourceid}` | One source, with its content |
| GET | `/agents/{id}/tickets` | List tickets |
| GET | `/agents/{id}/tickets/{ticketid}` | One ticket with what came after the question |
| PATCH | `/agents/{id}/tickets/{ticketid}` | Change a ticket's status |
| POST | `/agents/{id}/tickets/{ticketid}/notes` | Add a note to a ticket |
| DELETE | `/agents/{id}/visitor-files/{fileid}` | Erase a file a visitor sent |
| GET | `/agents/{id}/visitor-files/{fileid}` | A file a visitor sent, with the text read from it |
| POST | `/api/v1/agents` | POST /api/v1/agents |
| POST | `/api/v1/agents/ag_123/chat` | POST /api/v1/agents/ag_123/chat |
| GET | `/models` | The models an agent can use |
| GET | `/setup-guide` | How to set an agent up for what it is for |
| GET | `/webhooks` | List webhooks |
| POST | `/webhooks` | Add a webhook |
| DELETE | `/webhooks/{id}` | Delete a webhook |
| GET | `/webhooks/{id}` | One webhook |
| GET | `/workspace` | The key, and the workspace's plan and usage |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/chatterlab-ai/openapi/_ae-authored/chatterlab-ai-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/chatterlab-ai/json-schema/chatterlab-ai-get-agents-id-leads-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/chatterlab-ai/json-schema/chatterlab-ai-post-agents-id-sources-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/chatterlab-ai/json-schema/chatterlab-ai-post-agents-id-chat-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/chatterlab-ai/json-schema/chatterlab-ai-patch-agents-id-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/chatterlab-ai/json-schema/chatterlab-ai-post-agents-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/chatterlab-ai/json-schema/chatterlab-ai-get-agents-id-tickets-response-schema.json

## Other ChatterLab APIs (1)

- [ChatterLab API](https://apis.io/apis/chatterlab-ai/chatterlab-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/chatterlab-ai/chatterlab-ai-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/chatterlab-ai/.