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

# API reference

> The production REST API, with schemas generated from Protodesk's published OpenAPI specification.

## Base URL

```text theme={null}
https://api.protodesk.io/v1
```

Authenticated endpoints use `Authorization: Bearer YOUR_API_KEY`. The key determines the workspace. Start with the [quickstart](/quickstart) if you have not made a request yet.

## Explore endpoints

Choose an endpoint in the sidebar to see its parameters, request body, response schema, and generated examples. The reference loads the [published OpenAPI specification](https://protodesk.io/openapi.yaml).

The reference covers customers, channel identities, conversations, messages, assignment, statuses, priorities, webhooks, realtime events, API keys, and Help Center authoring. Check each endpoint's required permissions before using it.

<Warning>
  The request playground calls the selected API server. Write requests can change workspace data or trigger webhook deliveries. Use a dedicated test workspace and your own appropriately scoped key.
</Warning>

## API and MCP availability

Hosted MCP exposes selected customer, conversation, recorded-message, and webhook operations through Streamable HTTP. It supports browser OAuth or scoped API keys. OAuth tokens are bound to MCP and cannot replace REST API keys. Help Center authoring uses a delegated authoring key and preserves human review. See [MCP overview](/mcp/overview) and the [hosted tool reference](/mcp/hosted-tools).

Creating a message through the public API records it; it does not invoke the dashboard's outbound email or channel delivery workflow.

An API key scope shown in the dashboard is not a promise of a corresponding public endpoint. Use this reference for documented request contracts.


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