Get runtime-scoped progressive help

POST

/v1/workspaces/:id/help

AuthorizationBearer

Use Bearer <api-key>.

idstringRequired

This endpoint expects an object.

runtimestringOptionalformat: "^[A-Za-z][A-Za-z0-9_-]{0,63}$"

topicstringOptional>=1 character

Default Response

exampleslist of any

kindenum

Allowed values:

suggestionslist of strings

summarystring>=1 character

detailsmap from strings to any or null

runtimestring or nullformat: "^[A-Za-z][A-Za-z0-9_-]{0,63}$"

topicstring or null

usagestring or null

1	curl -X POST https://api.bctrl.ai/v1/workspaces/id/help \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"examples": [],
3	"kind": "overview",
4	"suggestions": [
5	"Try using the 'listUsers' call to retrieve all users in the workspace."
6	],
7	"summary": "This overview provides general guidance on using the workspace API.",
8	"details": {},
9	"runtime": "nodejs_14",
10	"topic": "workspace API usage",
11	"usage": "Use this endpoint to get contextual help and suggestions for working with your workspace."
12	}