> ## Documentation Index
> Fetch the complete documentation index at: https://wiredesk.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting started

> The Wiredesk REST API: read and change a workspace's agents, conversations, contacts, leads and knowledge, and talk to an agent from your own code.

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.

```
https://wiredesk.ai/api/v1
```

## 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](https://wiredesk.ai/docs/api-reference/authentication.md).

**2. List your agents**

```bash theme={null}
curl https://wiredesk.ai/api/v1/agents \
  -H "Authorization: Bearer wd_3f9a…"
```

**3. Talk to one**

Take an agent's `id` from the list and send it a message:

```bash theme={null}
curl https://wiredesk.ai/api/v1/agents/AGENT_ID/chat \
  -H "Authorization: Bearer wd_3f9a…" \
  -H "Content-Type: application/json" \
  -d '{ "message": "When are you open on Saturday?" }'
```

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:

```
https://wiredesk.ai/docs/api-reference/openapi.json
```

## Also on MCP

The same operations are tools on the [MCP server](https://wiredesk.ai/docs/developers/mcp.md), 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](https://wiredesk.ai/docs/developers/agent-onboarding.md), which needs no key.

## Next

> [card] [Authentication](https://wiredesk.ai/docs/api-reference/authentication.md)
>
> API keys, read-only keys, and who a key acts as.

> [card] [Conventions](https://wiredesk.ai/docs/api-reference/conventions.md)
>
> Responses, errors, pagination and rate limits.

> [card] [REST API guide](https://wiredesk.ai/docs/developers/api.md)
>
> Changing an agent, talking to one, knowledge and contacts, in more depth.

> [card] [Webhooks](https://wiredesk.ai/docs/developers/webhooks.md)
>
> Signed events for new messages, handover requests, leads and finished conversations.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.