> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://platform.bctrl.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://platform.bctrl.ai/_mcp/server.

# Get API, SDK, CLI, MCP help

GET https://api.bctrl.ai/v1/help

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.

Reference: https://platform.bctrl.ai/api/api-reference/help

## Authentication

- `Authorization` header (bearer token, required) — Use Bearer \<api-key>.

## Servers

- `https://api.bctrl.ai` (Production, default)
- `http://localhost:8787` (Local development gateway)

## Request

### Query parameters

- `topic` (string, optional)
- `audience` (enum, optional)
  - Allowed values: `api`, `sdk`, `cli`, `mcp`

## Response

### 200

OK

- `object`
  - `type`: `overview` (overview)
    - `summary` (string, required)
    - `topics` (list of object, required)
      - `audiences` (list of enum, required)
        - Allowed values: `api`, `sdk`, `cli`, `mcp`
      - `summary` (string, required)
      - `title` (string, required)
      - `topic` (string, required)
      - `aliases` (list of string, optional)
      - `method` (enum, optional)
        - Allowed values: `GET`, `POST`, `PATCH`, `PUT`, `DELETE`
      - `operationId` (string, optional)
      - `path` (string, optional)
    - `audience` (enum, optional)
      - Allowed values: `api`, `sdk`, `cli`, `mcp`
    - `docs` (list of object, optional)
      - `title` (string, required)
      - `url` (string, required)
      - `description` (string, optional)
      - `llmsUrl` (string, optional)
      - `markdownUrl` (string, optional)
      - `mcpResource` (string, optional)
    - `examples` (list of object, optional)
      - `audience` (enum, optional)
        - Allowed values: `api`, `sdk`, `cli`, `mcp`
      - `code` (string, optional)
      - `command` (string, optional)
      - `language` (string, optional)
      - `request` (object, optional)
      - `title` (string, optional)
    - `next` (list of object, optional)
      - `audience` (enum, optional)
        - Allowed values: `api`, `sdk`, `cli`, `mcp`
      - `command` (string, optional)
      - `method` (enum, optional)
        - Allowed values: `GET`, `POST`, `PATCH`, `PUT`, `DELETE`
      - `path` (string, optional)
      - `title` (string, optional)
      - `topic` (string, optional)
  - `type`: `topic` (topic)
    - `summary` (string, required)
    - `topic` (string, required)
    - `aliases` (list of string, optional)
    - `api` (object, optional)
      - `method` (enum, required)
        - Allowed values: `GET`, `POST`, `PATCH`, `PUT`, `DELETE`
      - `path` (string, required)
      - `operationId` (string, optional)
      - `requestFields` (list of string, optional)
      - `responseFields` (list of string, optional)
    - `audience` (enum, optional)
      - Allowed values: `api`, `sdk`, `cli`, `mcp`
    - `cli` (object, optional)
      - `command` (string, required)
      - `usage` (string, required)
      - `flags` (list of object, optional)
        - `description` (string, required)
        - `name` (string, required)
        - `value` (string, optional)
    - `docs` (list of object, optional)
      - `title` (string, required)
      - `url` (string, required)
      - `description` (string, optional)
      - `llmsUrl` (string, optional)
      - `markdownUrl` (string, optional)
      - `mcpResource` (string, optional)
    - `examples` (list of object, optional)
      - `audience` (enum, optional)
        - Allowed values: `api`, `sdk`, `cli`, `mcp`
      - `code` (string, optional)
      - `command` (string, optional)
      - `language` (string, optional)
      - `request` (object, optional)
      - `title` (string, optional)
    - `inputs` (object, optional)
      - `body` (object, optional)
        - `description` (string, optional)
        - `discriminator` (object, optional)
          - `property` (string, required)
          - `variants` (list of object, required)
            - `value` (string, required)
            - `example` (object, optional)
            - `required` (list of string, optional)
            - `schema` (string, optional)
            - `schemaResource` (string, optional)
            - `summary` (string, optional)
        - `fields` (list of object, optional)
          - `name` (string, required)
          - `type` (string, required)
          - `description` (string, optional)
          - `required` (boolean, optional)
          - `values` (list of string, optional)
        - `schema` (string, optional)
        - `schemaResource` (string, optional)
      - `headers` (list of object, optional)
        - `name` (string, required)
        - `type` (string, required)
        - `description` (string, optional)
        - `required` (boolean, optional)
        - `values` (list of string, optional)
      - `path` (list of object, optional)
        - `name` (string, required)
        - `type` (string, required)
        - `description` (string, optional)
        - `required` (boolean, optional)
        - `values` (list of string, optional)
      - `query` (list of object, optional)
        - `name` (string, required)
        - `type` (string, required)
        - `description` (string, optional)
        - `required` (boolean, optional)
        - `values` (list of string, optional)
    - `mcp` (object, optional)
      - `toolName` (string, required)
      - `operationResource` (string, optional)
      - `schemaResources` (list of string, optional)
    - `next` (list of object, optional)
      - `audience` (enum, optional)
        - Allowed values: `api`, `sdk`, `cli`, `mcp`
      - `command` (string, optional)
      - `method` (enum, optional)
        - Allowed values: `GET`, `POST`, `PATCH`, `PUT`, `DELETE`
      - `path` (string, optional)
      - `title` (string, optional)
      - `topic` (string, optional)
    - `output` (object, optional)
      - `fields` (list of object, required)
        - `name` (string, required)
        - `type` (string, required)
        - `description` (string, optional)
        - `required` (boolean, optional)
        - `values` (list of string, optional)
    - `sdk` (list of object, optional)
      - `language` (string, required)
      - `method` (string, required)
      - `package` (string, optional)
    - `title` (string, optional)

## Examples

**Response**

```json
{
  "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"
}
```

**SDK Code**

```python
import requests

url = "https://api.bctrl.ai/v1/help"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/help';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bctrl.ai/v1/help"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.bctrl.ai/v1/help")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.bctrl.ai/v1/help")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.bctrl.ai/v1/help', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/help");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/help")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```