Launch an action run

POST

/projects/:projectId/action-runs

Launches a batch run of an active custom action over the supplied inputs (project-pool files for extract actions, records for generate/fill actions) and returns the live run plus a WebSocket-upgrade ticket.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

projectIdstringRequired

Request

This endpoint expects an object.

actionIdstringRequired>=1 character

fileIdslist of stringsOptional

folderIdslist of stringsOptional

recordIdslist of stringsOptional

Response

The newly launched run.

runmap from strings to any

An action-run projection.

wsTicketstring

Signed ticket for the run's WebSocket upgrade.

wsUrlstring

WebSocket URL with the ticket pre-applied.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

1	curl -X POST https:/https://api/projects/projectId/action-runs \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"actionId": "act_9f8b7c6d5e4a3b2c1d0e"
6	}'

1	{
2	"run": {},
3	"wsTicket": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJydW5JZCI6ImFjdF85ZjhiN2M2ZDVlNGEzYjJjMWQwZSIsImlhdCI6MTY4NjQ3MjAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
4	"wsUrl": "wss://app.raker.one/api/projects/proj_1234567890/action-runs/ws?ticket=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJydW5JZCI6ImFjdF85ZjhiN2M2ZDVlNGEzYjJjMWQwZSIsImlhdCI6MTY4NjQ3MjAwMH0.SflKxwRJSMeKKF2QT4f"
5	}