/api/v2/workflows/{workflowId}/runs/{runId}Read current run state with workspace read access. Request final output and files with includeOutput, or block outputs with selectedOutputs. Organization permission groups can hide output, files, or cost. A paused run lists every pause point in paused.points, with the fields a human pause asks for and its content with resolved secrets redacted; resume one with Resume workflow run.
includeFileBase64 inlines file bytes. A file or the total above 16 MiB returns 413 naming a download path; download large files individually. HEAD checks access with the same authorization as GET but skips side effects, returning an empty 200 without payload headers on success.
OAuth scope: api:read.
Authentication
Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their description.
Send X-API-Key in the request header.
Alternatively
Send a Sim OAuth access token in Authorization: Bearer. See OAuth authentication and scopes.
Authorization: Bearer YOUR_ACCESS_TOKEN
Required scopes: api:read
OAuth flows
OAuth scope: api:read.
Path parameters
Unique workflow identifier.
- minLength
- 1
Unique workflow run identifier.
- minLength
- 1
- maxLength
- 128
- pattern
- ^[A-Za-z0-9._:-]+$
Query parameters
Include the final workflow output when true. It does not gate blockOutputs, which selectedOutputs selects on its own.
Comma-separated block output references to include, as blockId or blockId.path. Block names are not resolved here — unlike the execute request, this resource reads a recorded run and matches ids only, so a selector that is not headed by a block id answers 400 instead of an empty blockOutputs.
Inline each produced file's bytes as base64. Requires includeOutput. A file above the inline ceiling answers 413 naming its download path; fetch large files from downloadPath instead.
Per-file inline ceiling, lowering but never raising the server limit of 16 MiB.
- minimum
- 1
- maximum
- 16777216
Responses
200
The workflow run status.
Detailed current state of a workflow run.
1 field
Response data.
14 fields
Unique workflow run identifier.
- minLength
- 1
- maxLength
- 128
- pattern
- ^[A-Za-z0-9._:-]+$
Workflow that produced the run.
Current or terminal run status. redacting is transient, reported while a finished run's output is being scrubbed. paused means the run has a human or time pause that can still be resumed; once the run has finished and every pause point has resumed or failed, it reports the finished status. The single-run response provides the pause kind, resume time, and any automatic-resume waiting reason.
- enum
- ["pending","running","paused","redacting","completed","failed","cancelled","queued"]
Trigger type that started the run. Backfilled as api for a run that is still queued, so it is populated from the first poll.
Schema details
Any of
ISO 8601 start timestamp. A queued run reports the time it was enqueued, so it is populated from the first poll.
- format
- date-time
Schema details
Any of
ISO 8601 end timestamp, or null while nonterminal.
- format
- date-time
Schema details
Any of
Run duration in milliseconds, or null while active.
Schema details
Any of
Deployment version the run executed. Null for a manual run, a queued run not yet started, or a run whose version no longer exists.
Schema details
Any of
- minimum
- -9007199254740991
- maximum
- 9007199254740991
Current pause details, or null when the run is not paused.
Schema details
Any of
9 fields
Resume context identifier, or null while every pause point is mid-resume.
Schema details
Any of
ISO 8601 timestamp when the execution entered the paused state.
- format
- date-time
- 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))$
ISO 8601 scheduled automatic-resume timestamp, or null when no resume time is set.
Schema details
Any of
- format
- date-time
- 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))$
Whether the pause waits for time or human input, or null when unspecified.
Schema details
Any of
- enum
- ["time","human"]
Workflow block awaiting resume, or null when no block is identified.
Schema details
Any of
Recorded automatic-resume failure, or null when no failure is recorded. Inspect pauseKind and resumeAt to distinguish a scheduled time pause from human input. Cleared after a successful resume. A non-retryable or exhausted failure starts with Automatic resume requires manual intervention: .
Schema details
Any of
Number of pause points tracked for the execution.
Number of pause points that have resumed.
Every point the run is paused at, earliest first, at most 100; past 100, points not yet resumed are kept in preference to resumed ones. Resume one with Resume workflow run, naming its contextId and supplying input.
Schema details
One point at which a paused run waits.
12 fields
Pause context to name in contextId when resuming this point.
Workflow block that paused.
Name of the block as the run executed it. Null only for a point paused before names were recorded whose run was manual or whose deployment version no longer exists.
Schema details
Any of
human waits for a resume request; time resumes automatically at resumeAt.
- enum
- ["human","time"]
Resume state of this point: waiting, queued behind another resume, resuming, resumed, or a failed resume attempt.
- enum
- ["paused","queued","resuming","resumed","failed"]
ISO 8601 timestamp when the run paused at this point, or null for a point recorded without one.
- format
- date-time
Schema details
Any of
ISO 8601 automatic-resume timestamp for a time pause, otherwise null.
- format
- date-time
Schema details
Any of
Parallel branch of the pause, or null outside a parallel.
Schema details
Any of
3 fields
Parallel block containing the pause.
Zero-based branch that paused.
- minimum
- -9007199254740991
- maximum
- 9007199254740991
Number of branches, or null when unrecorded.
Schema details
Any of
- minimum
- -9007199254740991
- maximum
- 9007199254740991
Additional properties are not allowed.
Loop iteration of the pause, or null outside a loop.
Schema details
Any of
2 fields
Loop block containing the pause.
Zero-based iteration that paused.
- minimum
- -9007199254740991
- maximum
- 9007199254740991
Additional properties are not allowed.
Fields a human pause asks for, without default values. Labels and descriptions are resolved, so they are withheld when organization permission groups hide execution data. Null then, for a time pause, a pause with no declared form, fields over 64 KiB or not provably free of secrets, or one recorded before pause details were captured.
Schema details
Any of
Schema details
One field a human pause asks the resumer to fill.
7 fields
Key to supply this field under in the resume input.
Display label for the field.
Declared value type, such as string, number, or boolean.
Field help text, when configured.
Placeholder text, when configured.
Whether the field is marked required.
Selectable options, when the field offers a fixed set.
Schema details
One selectable option.
Additional properties are not allowed.
Content the pause presents to its reviewer, with the run's resolved secrets redacted. Null unless includeOutput=true, when hidden by organization permission groups, for a time pause, for content over 64 KiB or not provably free of secrets, or for a pause recorded before pause details were captured.
Schema details
Any of
Reviewer content value.
Position among pending resume requests for this run, or null when none waits.
Schema details
Any of
- minimum
- -9007199254740991
- maximum
- 9007199254740991
Additional properties are not allowed.
Additional properties are not allowed.
Credits consumed, or null when unavailable or hidden by organization permission groups.
Schema details
Any of
1 field
Total credits consumed by the run.
Additional properties are not allowed.
Structured execution failure, or null when none occurred. The failing block is read from the run trace, so blockId/blockName/blockType are absent, and a block-level failure reports EXECUTION_FAILED, when the trace is unavailable or hidden by organization permission groups.
Schema details
Any of
Structured in-band failure details for a workflow run.
5 fields
Human-readable workflow execution failure message.
Stable machine-readable execution failure code. BLOCK_EXECUTION_FAILED and CHILD_WORKFLOW_FAILED are reported only where block attribution is available; elsewhere a block-level failure is reported as EXECUTION_FAILED.
- enum
- ["TIMEOUT","CANCELLED","USAGE_LIMIT_EXCEEDED","INVALID_INPUT","BLOCK_EXECUTION_FAILED","CHILD_WORKFLOW_FAILED","EXECUTION_FAILED"]
Identifier of the failing block, when attributable. Get workflow run reads it from the run trace, so it is absent there when the trace is unavailable or hidden by organization permission groups, when no failed block in the trace recorded the run error, and for a timeout, cancellation, usage-limit, or invalid-input failure.
Display name of the failing block, when attributable. Present whenever blockId is.
Integration or block type that failed, when attributable. Present whenever blockId is.
Additional properties are not allowed.
Final output when includeOutput=true, or null when not requested or hidden by organization permission groups.
Schema details
Any of
Final workflow output value.
Selected block outputs, or null when none were requested or execution data is hidden by organization permission groups. selectedOutputs controls these independently of includeOutput.
Schema details
Any of
Schema details
Output value produced by one workflow block.
Run-produced files when includeOutput=true, or null when not requested or execution data is hidden by organization permission groups.
Schema details
Any of
Schema details
A file produced by a workflow run.
6 fields
Identifier to address this file by on the download endpoint.
File name, including its extension.
File size in bytes.
- minimum
- 0
- maximum
- 9007199254740991
MIME type recorded for the file.
Path to fetch this file's bytes from, relative to the API host.
Base64-encoded contents when includeFileBase64 was requested and the file fits the inline ceiling, otherwise null.
Schema details
Any of
Additional properties are not allowed.
Additional properties are not allowed.
Additional properties are not allowed.
Response example 1
Response headers
Maximum requests allowed in the current window.
- minimum
- 0
- maximum
- 9007199254740991
Requests remaining in the current window.
- minimum
- 0
- maximum
- 9007199254740991
ISO 8601 timestamp when the current rate-limit window resets.
- format
- date-time
- 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))$
400
The request is invalid. This includes a query parameter sent with no value (?limit=, ?search=), which is rejected rather than read as zero, empty, or the parameter default — omit the parameter instead.
Canonical error envelope returned by the public v2 API.
1 field
Canonical error details.
4 fields
Stable machine-readable error code.
Human-readable explanation of the error.
Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.
Schema details
Any of
Machine-readable cause and optional context for an actionable 403 response.
1 field
Stable cause code for an actionable 403 response.
- enum
- ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","READ_ONLY_API_KEY","SCIM_MANAGED_MEMBERSHIP"]
Additional context for this refusal.
Other structured context defined by the specific error.
Identifier of this request, the same id as the x-request-id response header. Quote it when contacting support.
Additional properties are not allowed.
Additional properties are not allowed.
401
The API credential is missing or invalid.
Canonical error envelope returned by the public v2 API.
1 field
Canonical error details.
4 fields
Stable machine-readable error code.
Human-readable explanation of the error.
Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.
Schema details
Any of
Machine-readable cause and optional context for an actionable 403 response.
1 field
Stable cause code for an actionable 403 response.
- enum
- ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","READ_ONLY_API_KEY","SCIM_MANAGED_MEMBERSHIP"]
Additional context for this refusal.
Other structured context defined by the specific error.
Identifier of this request, the same id as the x-request-id response header. Quote it when contacting support.
Additional properties are not allowed.
Additional properties are not allowed.
403
The caller lacks the rights this operation requires. When the cause is one a caller can act on, error.details.code names it. A resource in a workspace the caller cannot reach at all answers 404 instead, so absence and denial are indistinguishable.
Canonical error envelope returned by the public v2 API.
1 field
Canonical error details.
4 fields
Stable machine-readable error code.
Human-readable explanation of the error.
Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.
Schema details
Any of
Machine-readable cause and optional context for an actionable 403 response.
1 field
Stable cause code for an actionable 403 response.
- enum
- ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","READ_ONLY_API_KEY","SCIM_MANAGED_MEMBERSHIP"]
Additional context for this refusal.
Other structured context defined by the specific error.
Identifier of this request, the same id as the x-request-id response header. Quote it when contacting support.
Additional properties are not allowed.
Additional properties are not allowed.
404
The requested resource was not found.
Canonical error envelope returned by the public v2 API.
1 field
Canonical error details.
4 fields
Stable machine-readable error code.
Human-readable explanation of the error.
Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.
Schema details
Any of
Machine-readable cause and optional context for an actionable 403 response.
1 field
Stable cause code for an actionable 403 response.
- enum
- ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","READ_ONLY_API_KEY","SCIM_MANAGED_MEMBERSHIP"]
Additional context for this refusal.
Other structured context defined by the specific error.
Identifier of this request, the same id as the x-request-id response header. Quote it when contacting support.
Additional properties are not allowed.
Additional properties are not allowed.
409
The request conflicts with current resource state.
Canonical error envelope returned by the public v2 API.
1 field
Canonical error details.
4 fields
Stable machine-readable error code.
Human-readable explanation of the error.
Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.
Schema details
Any of
Machine-readable cause and optional context for an actionable 403 response.
1 field
Stable cause code for an actionable 403 response.
- enum
- ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","READ_ONLY_API_KEY","SCIM_MANAGED_MEMBERSHIP"]
Additional context for this refusal.
Other structured context defined by the specific error.
Identifier of this request, the same id as the x-request-id response header. Quote it when contacting support.
Additional properties are not allowed.
Additional properties are not allowed.
413
The request, or a resource collection it must materialize, exceeds the allowed size: an oversized request body, a generated artifact past the download ceiling, or a workspace folder tree too large to load in full.
Canonical error envelope returned by the public v2 API.
1 field
Canonical error details.
4 fields
Stable machine-readable error code.
Human-readable explanation of the error.
Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.
Schema details
Any of
Machine-readable cause and optional context for an actionable 403 response.
1 field
Stable cause code for an actionable 403 response.
- enum
- ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","READ_ONLY_API_KEY","SCIM_MANAGED_MEMBERSHIP"]
Additional context for this refusal.
Other structured context defined by the specific error.
Identifier of this request, the same id as the x-request-id response header. Quote it when contacting support.
Additional properties are not allowed.
Additional properties are not allowed.
429
The caller exceeded the request rate limit.
Canonical error envelope returned by the public v2 API.
1 field
Canonical error details.
4 fields
Stable machine-readable error code.
Human-readable explanation of the error.
Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.
Schema details
Any of
Machine-readable cause and optional context for an actionable 403 response.
1 field
Stable cause code for an actionable 403 response.
- enum
- ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","READ_ONLY_API_KEY","SCIM_MANAGED_MEMBERSHIP"]
Additional context for this refusal.
Other structured context defined by the specific error.
Identifier of this request, the same id as the x-request-id response header. Quote it when contacting support.
Additional properties are not allowed.
Additional properties are not allowed.
Response headers
Seconds to wait before retrying, sent on 429 and 503. Add jitter rather than retrying at exactly this offset.
- minimum
- 0
- maximum
- 9007199254740991
500
An unexpected server error occurred.
Canonical error envelope returned by the public v2 API.
1 field
Canonical error details.
4 fields
Stable machine-readable error code.
Human-readable explanation of the error.
Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.
Schema details
Any of
Machine-readable cause and optional context for an actionable 403 response.
1 field
Stable cause code for an actionable 403 response.
- enum
- ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","READ_ONLY_API_KEY","SCIM_MANAGED_MEMBERSHIP"]
Additional context for this refusal.
Other structured context defined by the specific error.
Identifier of this request, the same id as the x-request-id response header. Quote it when contacting support.
Additional properties are not allowed.
Additional properties are not allowed.
503
A required service is temporarily unavailable. When present, Retry-After gives the minimum seconds to wait; add jitter before retrying. Check operation-specific guidance before repeating a change after an uncertain response.
Canonical error envelope returned by the public v2 API.
1 field
Canonical error details.
4 fields
Stable machine-readable error code.
Human-readable explanation of the error.
Structured error context whose keys depend on the error. Actionable 403 responses use the V2ActionableForbiddenDetails shape; validation failures may return issue arrays instead.
Schema details
Any of
Machine-readable cause and optional context for an actionable 403 response.
1 field
Stable cause code for an actionable 403 response.
- enum
- ["INSUFFICIENT_WORKSPACE_ROLE","PERSONAL_API_KEYS_DISABLED","WORKSPACE_KEY_OPERATION_NOT_PERMITTED","PRINCIPAL_KIND_NOT_PERMITTED","ORGANIZATION_MEMBERSHIP_REQUIRED","ORGANIZATION_ADMIN_REQUIRED","ENTERPRISE_PLAN_REQUIRED","SSO_DISABLED","SSO_DOMAIN_NOT_VERIFIED","SSO_PROVIDER_LIMIT_REACHED","ORGANIZATION_PLAN_REQUIRED","AUDIT_LOGS_DISABLED","ACCESS_REQUESTS_DISABLED","ACCESS_REQUEST_ORGANIZATION_REQUIRED","SKILL_EDITOR_ACCESS_REQUIRED","SECRET_ADMIN_ACCESS_REQUIRED","WORKSPACE_RESOURCE_LIMIT_REACHED","PUBLIC_SHARING_NOT_ALLOWED","CREDENTIAL_ADMIN_ACCESS_REQUIRED","MCP_SERVER_URL_NOT_ALLOWED","WORKSPACE_PLAN_CAPABILITY_REQUIRED","CHAT_AUTH_MODE_NOT_PERMITTED","CONNECTOR_MANAGED_RESOURCE_READ_ONLY","PERMISSION_GROUP_CAPABILITY_BLOCKED","INTEGRATION_NOT_ALLOWED","INSUFFICIENT_SCOPE","READ_ONLY_API_KEY","SCIM_MANAGED_MEMBERSHIP"]
Additional context for this refusal.
Other structured context defined by the specific error.
Identifier of this request, the same id as the x-request-id response header. Quote it when contacting support.
Additional properties are not allowed.
Additional properties are not allowed.
Response headers
Seconds to wait before retrying, sent on 429 and 503. Add jitter rather than retrying at exactly this offset.
- minimum
- 0
- maximum
- 9007199254740991