Get API, SDK, CLI, and MCP Help

GET

/v1/help

GET

/v1/help

curl https://api.bctrl.ai/v1/help \
     -H "Authorization: Bearer <token>"

{
  "audience": "api",
  "docs": [
    {
      "description": "string",
      "llmsUrl": "string",
      "markdownUrl": "string",
      "mcpResource": "string",
      "title": "string",
      "url": "string"
    }
  ],
  "examples": [
    {
      "audience": "api",
      "code": "string",
      "command": "string",
      "language": "string",
      "request": {},
      "title": "string"
    }
  ],
  "next": [
    {
      "audience": "api",
      "command": "string",
      "method": "GET",
      "path": "string",
      "title": "string",
      "topic": "string"
    }
  ],
  "summary": "string",
  "topics": [
    {
      "aliases": [
        "string"
      ],
      "audiences": [
        "api"
      ],
      "method": "GET",
      "operationId": "string",
      "path": "string",
      "summary": "string",
      "title": "string",
      "topic": "string"
    }
  ],
  "type": "string"
}

Return global API, SDK, and CLI help, or help for one named topic. Use query parameters so help is easy to call from browsers, CLI tools, SDKs, and plain HTTP clients.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Query parameters

topicstringOptional

audienceenumOptional

Allowed values:

Response headers

BCTRL-Request-IdstringOptional

Current request identifier, also echoed in errors.

BCTRL-VersionstringOptional

Negotiated dated API version.

RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

overviewobject

topicobject

Errors

401

Unauthorized Error

403

Forbidden Error

Authentication

Headers

Query parameters

Response headers

Response

Errors