For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • POSTSearch documentation
      • GETGet platform documentation
      • POSTGet build instructions
Dashboard
LogoLogo
Runtype APIDocumentation

Search documentation

POST
/v1/docs/search
POST
/v1/docs/search
$curl -X POST https://api.runtype.com/v1/docs/search \
> -H "Authorization: <apiKey>" \
> -H "Content-Type: application/json" \
> -d '{
> "query": "How do I authenticate API requests using Runtype?"
>}'
1{
2 "content": [
3 {
4 "type": "text",
5 "text": "To authenticate API requests, include your Runtype API key in the Authorization header as a Bearer token. For example: Authorization: Bearer your-api-key."
6 },
7 {
8 "type": "text",
9 "text": "Alternatively, you can use a Clerk session token for dashboard authentication."
10 }
11 ]
12}

Semantic search over the published Runtype documentation corpus. Returns a synthesized answer with citations. Use this for prose/how-to questions; for deterministic schemas and build guidance use the /v1/documentation endpoints.

Was this page helpful?
Previous

Get platform documentation

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Request

This endpoint expects an object.
querystringRequired>=1 character

Natural-language documentation question.

Response

Documentation search result (MCP content blocks)

contentlist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
502
Bad Gateway Error