Execute structured steps inside a runtime

POST

/v1/workspaces/:id/execute

POST

/v1/workspaces/:id/execute

1 curl -X POST https://api.bctrl.ai/v1/workspaces/id/execute \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "runtime": "string",
6   "steps": [
7     {
8       "call": "string"
9     }
10   ]
11 }'

200Successful

1 {
2   "kind": "result",
3   "result": {
4     "mode": "fail-fast",
5     "ok": true,
6     "runtime": "string",
7     "steps": [
8       {
9         "binding": {
10           "alias": "string",
11           "id": "string",
12           "type": "page"
13         },
14         "call": "string",
15         "index": 1,
16         "ok": true,
17         "resolved": {
18           "call": "string",
19           "contextId": "string",
20           "handleId": "string",
21           "method": "string",
22           "pageId": "string",
23           "ref": "string",
24           "sessionId": "string",
25           "target": "string"
26         }
27       }
28     ]
29   }
30 }

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Request

This endpoint expects an object.

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

stepslist of objectsRequired

idempotencyKeystringOptional1-200 characters

modeenumOptional

Allowed values:

Response

Default Response

object