API referenceWorkflows

Run workflow

Starts a new execution of the workflow now. If the workflow already has a run in progress, no new run is started.

POST
/v1/brands/{brandId}/workflows/{workflowId}/runs
bearerAuth
headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

brandId*integer

The brand the request acts on. Every brand-scoped resource lives under its brand.

workflowId*string
Match^[1-9]\d*$
Length1 <= length
Idempotency-Key?string

Retrying with the same key within 24 hours returns the first response without acting again.

Lengthlength <= 255

Response Body

Run workflow

application/json
  1. response
[key: string]?unknown
curl -X POST "https://example.com/v1/brands/0/workflows/string/runs" \  -H "Authorization: Bearer koast_sk_..."
{  "property1": null,  "property2": null}

Required scope: write. CLI: koast run-workflow, see Workflows commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.