alpha

Start workflows

Start one run of a published Alpha workflow, using the organization's Alpha credits; a retry with the same idempotency key returns the same run. Follow the run with alpha_workflows_get_v2 (its recentRuns); an internal-report run is also readable by runId through alpha_reports_get, then alpha_report_results_get_v2 once it has succeeded.

post/api/v1/alpha/workflows/start

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/alpha/workflows/start
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

workflowKeystring required

Published Alpha workflow key

expectedWorkflowVersionIdstring uuid

Optional immutable workflow version the caller confirmed

Response

Accepted: the durable run started. Follow it with GET /api/v1/platform/runs-v2/{id}.

runIdstring uuid required

The billing.runs ID of the workflow run

status'started' | 'pending_redelivery' required

started: Workflow accepted the run. pending_redelivery: the run is reserved and its Workflow start is redelivered.

workflowKeystring required

Changes

No recorded changes to this operation across all 1 revision of this API.