Skip to content
WorkRoad home
REST API

Read a docs page

GET
/docs/page

Returns a WorkRoad docs page as Markdown: a guide to part of the app, the REST API or MCP guide, or an operation's reference with its parameters, fields, example response and errors. Find the page with searchDocs, or pass a docs URL you already have. Any key may call it.

Required scopes: None beyond a valid key.

Authorization

headerAuthorizationBearer <token>

Query Parameters

slug?string

The page: its path under /docs, such as studying or api/mcp, or its whole URL, such as https://workroad.app/docs/api/mcp.md. Leave it out for the docs' first page.

Lengthlength <= 300
Default""
locale?string

The docs' language: en, de, es, fr, it. Defaults to en. A page with no translation, such as an API reference page, comes back in English.

Value in"en""de""es""fr""it"

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://workroad.app/api/v1/docs/page' \  -H 'Authorization: Bearer $WORKROAD_API_KEY'
Example Response
{  "data": {    "title": "MCP server",    "description": "Add WorkRoad to ChatGPT or Claude by pasting one address, or connect Claude Code, Codex or Cursor with an API key.",    "slug": "api/mcp",    "locale": "en",    "url": "https://workroad.app/docs/api/mcp",    "markdownUrl": "https://workroad.app/docs/api/mcp.md",    "markdown": "# MCP server\n\n> Add WorkRoad to ChatGPT or Claude by pasting one address, or connect Claude Code, Codex or Cursor with an API key.\n\nWorkRoad runs an MCP server at `https://workroad.app/api/mcp`.\n"  }}

Send a copilot message POST

Adds a message to a copilot conversation, or starts one, and queues the reply.

Search the docs GET

Searches the WorkRoad docs: the guides to each part of the app, the REST API guide, the MCP server guide and the reference page of every operation.