Get API, SDK, and CLI Help

GET

/v1/help

GET

/v1/help

$ curl https://api.bctrl.ai/v1/help \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "kind": "overview",
3   "summary": "This endpoint provides comprehensive help information for the bctrl API, SDK, and CLI. Use query parameters to specify the topic or audience for targeted help content.",
4   "topics": [
5     {
6       "audiences": [
7         "api",
8         "sdk",
9         "cli"
10       ],
11       "summary": "Details on how to authenticate with the bctrl API using API keys and tokens.",
12       "title": "Authentication Help",
13       "topic": "authentication",
14       "aliases": [
15         "auth",
16         "authentication"
17       ],
18       "method": "GET",
19       "operationId": "getAuthenticationHelp",
20       "path": "/v1/help?topic=authentication"
21     }
22   ],
23   "audience": "api",
24   "examples": [
25     {
26       "audience": "api",
27       "code": "curl -X GET 'https://api.bctrl.ai/v1/help?topic=authentication' -H 'Authorization: Bearer YOUR_API_KEY'",
28       "command": "bctrl help authentication",
29       "language": "bash",
30       "request": {},
31       "title": "Get help on authentication"
32     }
33   ],
34   "next": [
35     {
36       "audience": "api",
37       "command": "bctrl get-status",
38       "method": "GET",
39       "path": "/v1/status",
40       "title": "Check API status",
41       "topic": "status"
42     }
43   ]
44 }

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>=1 character

audienceenumOptional

Allowed values:

Response

overviewobject

topicobject

Errors

401

Unauthorized Error

403

Forbidden Error