Skip to content
WorkRoad home
REST API

Search the docs

GET
/docs/search

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. Use it when the user asks how WorkRoad works, how to do something in the app, or how to use the API, then read a page with getDoc. Pages come best match first, each with the passages that matched. Any key may call it.

Required scopes: None beyond a valid key.

Authorization

headerAuthorizationBearer <token>

Query Parameters

q*string

Words to look for, 1-200 characters, such as practice flashcards.

Length1 <= length <= 200
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"
limit?integer

Pages to return, 1-20.

Range1 <= value <= 20
Default5

Response Body

OK

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://workroad.app/api/v1/docs/search?q=string' \  -H 'Authorization: Bearer $WORKROAD_API_KEY'
Example Response
{  "data": [    {      "title": "Studying",      "description": "Study sets, take tests, use the feed, and check performance.",      "slug": "studying",      "url": "https://workroad.app/docs/studying",      "markdownUrl": "https://workroad.app/docs/studying.md",      "snippets": [        {          "text": "Study a set",          "url": "https://workroad.app/docs/studying#study-a-set"        }      ]    }  ]}

Read a docs page GET

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.

Complete a file upload POST

Checks that the upload reached storage and starts extracting the file's text.