Skip to main content
The REST API reads and changes one workspace: its agents, conversations and messages, contacts, leads and knowledge. You can also send a customer’s message to an agent and get its reply, without the chat widget. Every endpoint is on every plan.

​
Make your first request

1

Make an API key

In the dashboard, open Developers → API keys and make a key. Only owners and admins see the Developers section. See Authentication.
2

List your agents

3

Talk to one

Take an agent’s id from the list and send it a message:
Each endpoint page in this tab has a Try it button that sends the request with your key from the browser.

​
The OpenAPI spec

Every endpoint here comes from one OpenAPI 3.1 document. Import it into Postman, Insomnia or a code generator:

​
Also on MCP

The same operations are tools on the MCP server, for Claude, ChatGPT, Cursor and other AI assistants. An AI agent setting Wiredesk up for someone with no account yet starts with agent-first onboarding, which needs no key.

​
Next

Authentication

API keys, read-only keys, and who a key acts as.

Conventions

Responses, errors, pagination and rate limits.

REST API guide

Changing an agent, talking to one, knowledge and contacts, in more depth.

Webhooks

Signed events for new messages, handover requests, leads and finished conversations.