Start a run

201 for a new run; 200 for an existing runKey with the same workflow and input; 409 run_key_conflict otherwise.

POST

https://workflows-api.ezghcloud.com/v1/organizations/{orgId}/projects/{projectId}/runs

View as Markdown

Authorization

apiKeyoptionalHTTP
oauthoptionalHTTP
sessionCookieoptionalAPI key in cookie

Path parameters

orgIdstringrequired
format: uuid
projectIdstringrequired
format: uuid

Header parameters

Idempotency-Keyoptionalstring
Makes a retry safe: the same key and request get the stored response.

pattern: ^[\x21-\x7e]{1,200}$

Request bodyJSONrequired

appIdstringrequired
format: uuid
workflowstringrequired
pattern: ^[A-Za-z0-9_-]{1,64}$
inputoptionalunknown
Any JSON value, at most 1 MiB.
runKeyoptionalstring
pattern: ^[A-Za-z0-9._:-]{1,128}$

Returns

200

The existing run with this runKey.

JSON

appIdstringrequired
format: uuid
attemptintegerrequired
causeStepIdstring | nullrequired
createdAtstringrequired
format: date-time
endedAtstring | nullrequired
format: date-time
errorobject | nullrequired
6 properties
- codestringrequired
  user, or a workflows.* platform code.
- messagestringrequired
- namestringrequired
- causeoptionalobject | null
  6 properties
  codestringrequired
  user, or a workflows.* platform code.
  
  messagestringrequired
  namestringrequired
  causeoptionalobject | null
  dataoptionalunknown
  The error's data, when the workflow attached any.
  
  stackoptionalstring
- dataoptionalunknown
  The error's data, when the workflow attached any.
- stackoptionalstring
idstringrequired
format: uuid
parentRunIdstring | nullrequired
A child workflow's run: the parent run that invoked it; null otherwise.

format: uuid
runKeystring | nullrequired
scheduleIdstring | nullrequired
The schedule that started the run (a firing or a manual trigger); null otherwise.

format: uuid
scheduledTimestring | nullrequired
A schedule's run: the time it was scheduled for (a trigger's: when it was triggered); null otherwise.

format: date-time
statusrunningorcancellingorcompletedorfailedorcancelledortimedOutrequired
stepsarray ofobjectrequired
8 properties
- attemptintegerrequired
- errorobject | nullrequired
  6 properties
  codestringrequired
  user, or a workflows.* platform code.
  
  messagestringrequired
  namestringrequired
  causeoptionalobject | null
  6 properties
  codestringrequired
  user, or a workflows.* platform code.
  
  messagestringrequired
  namestringrequired
  causeoptionalobject | null
  dataoptionalunknown
  The error's data, when the workflow attached any.
  
  stackoptionalstring
  dataoptionalunknown
  The error's data, when the workflow attached any.
  
  stackoptionalstring
- hasOutputbooleanrequired
- kindrunorsleeporvalueorcallbackorinvokerequired
  run, sleep, value, callback (a callback's wait) or invoke (a child workflow).
- namestringrequired
- seqintegerrequired
- statusrunningorretryingorcompletedorfailedorcancelledorsleeping+1 morerequired
  running, retrying, completed, failed, cancelled, sleeping, or waiting (a callback or child workflow not yet resolved).
- stepIdstringrequired
updatedAtstringrequired
format: date-time
workflowstringrequired

201

A new run.

JSON

appIdstringrequired
format: uuid
attemptintegerrequired
causeStepIdstring | nullrequired
createdAtstringrequired
format: date-time
endedAtstring | nullrequired
format: date-time
errorobject | nullrequired
6 properties
- codestringrequired
  user, or a workflows.* platform code.
- messagestringrequired
- namestringrequired
- causeoptionalobject | null
  6 properties
  codestringrequired
  user, or a workflows.* platform code.
  
  messagestringrequired
  namestringrequired
  causeoptionalobject | null
  dataoptionalunknown
  The error's data, when the workflow attached any.
  
  stackoptionalstring
- dataoptionalunknown
  The error's data, when the workflow attached any.
- stackoptionalstring
idstringrequired
format: uuid
parentRunIdstring | nullrequired
A child workflow's run: the parent run that invoked it; null otherwise.

format: uuid
runKeystring | nullrequired
scheduleIdstring | nullrequired
The schedule that started the run (a firing or a manual trigger); null otherwise.

format: uuid
scheduledTimestring | nullrequired
A schedule's run: the time it was scheduled for (a trigger's: when it was triggered); null otherwise.

format: date-time
statusrunningorcancellingorcompletedorfailedorcancelledortimedOutrequired
stepsarray ofobjectrequired
8 properties
- attemptintegerrequired
- errorobject | nullrequired
  6 properties
  codestringrequired
  user, or a workflows.* platform code.
  
  messagestringrequired
  namestringrequired
  causeoptionalobject | null
  6 properties
  codestringrequired
  user, or a workflows.* platform code.
  
  messagestringrequired
  namestringrequired
  causeoptionalobject | null
  dataoptionalunknown
  The error's data, when the workflow attached any.
  
  stackoptionalstring
  dataoptionalunknown
  The error's data, when the workflow attached any.
  
  stackoptionalstring
- hasOutputbooleanrequired
- kindrunorsleeporvalueorcallbackorinvokerequired
  run, sleep, value, callback (a callback's wait) or invoke (a child workflow).
- namestringrequired
- seqintegerrequired
- statusrunningorretryingorcompletedorfailedorcancelledorsleeping+1 morerequired
  running, retrying, completed, failed, cancelled, sleeping, or waiting (a callback or child workflow not yet resolved).
- stepIdstringrequired
updatedAtstringrequired
format: date-time
workflowstringrequired

400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

401

unauthenticated: no credential, or one that doesn't check out.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

404

not_found: unknown, malformed, or in an organization the caller isn't in.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

409

quota_exceeded (an allocation quota, with quota), idempotency_conflict, idempotency_in_progress (with Retry-After), organization_deletion_pending, operation_in_progress, or the endpoint's own 409 codes.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

413

payload_too_large: the body is over the endpoint's limit (1 MiB unless it says otherwise).

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

503

unavailable: a dependency the request needs is down. Retry after Retry-After.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.