Skip to main content
POST
Start an idempotent owned API execution

Authorizations

X-API-Key
string
header
required

Headers

X-Session-ID
string

Target-site session ID returned by a login endpoint. Required for session_required endpoints.

X-Encryption-Key
string

Target-site encryption key returned by a login endpoint. Required with X-Session-ID.

Path Parameters

apiId
string
required
Required string length: 1 - 256

Body

application/json
endpoint
string
required
Required string length: 1 - 128
idempotency_key
string
required
Required string length: 1 - 255
params
object
write-only

Business inputs and named runtime controls; never echo secrets or session keys.

session_id
string
write-only

Managed session id.

Required string length: 1 - 256
encryption_key
string
write-only

Key for that session.

Required string length: 1 - 256

Response

The same durable job is returned for an identical idempotency key and execution fingerprint.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
state
enum<string>
required
Available options:
running,
needs_input,
succeeded,
failed,
cancelled,
unknown
created_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
expires_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
question
object
result
object
error
object
progress
object[]
Maximum array length: 40