curl --request POST \
--url http://localhost:3500/v1/workflow-runs/{id}/retry \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/workflow-runs/{id}/retry', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/workflow-runs/{id}/retry"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry_of_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organization_currency_conversion",
"resource": {
"type": "invoice_import",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"status": "queued",
"progress": {
"total": 1,
"queued": 1,
"running": 1,
"completed": 1,
"skipped": 1,
"failed": 1,
"cancelled": 1
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"failure": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The run type or current resource state does not permit retry.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Dispatch could not be confirmed. Inspect workflow_run_id before retrying.",
"request_id": "req_example"
}
}Retry a workflow run
Retries an unsuccessful invoice compliance check, invoice import, or integration sync using its retained inputs. An import or check creates a linked run; a sync resumes the same run. Other workflow types and runs that are no longer retryable return 409. Commands that need new user input must be submitted through their domain endpoint.
curl --request POST \
--url http://localhost:3500/v1/workflow-runs/{id}/retry \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/workflow-runs/{id}/retry', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/workflow-runs/{id}/retry"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retry_of_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organization_currency_conversion",
"resource": {
"type": "invoice_import",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"status": "queued",
"progress": {
"total": 1,
"queued": 1,
"running": 1,
"completed": 1,
"skipped": 1,
"failed": 1,
"cancelled": 1
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"failure": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The run type or current resource state does not permit retry.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Dispatch could not be confirmed. Inspect workflow_run_id before retrying.",
"request_id": "req_example"
}
}Authorizations
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.
Path Parameters
Response
The resumed or newly linked run.
One operation containing zero or more work items. Explicit retry creates a new run.
organization_currency_conversion, document_extraction, document_index, agreement_document_classification, agreement_detail_suggestions, invoice_import, invoice_import_batch, invoice_agreement_matching, invoice_credit_note_matching, agreement_invoice_matching, invoice_compliance_check, agreement_compliance_check, integration_sync, alert_topic_reconciliation, alert_topic_proposal, agreement_context_suggestions, agreement_price_import, agreement_document_import The business operation owning this execution; for invoice_import, the InvoiceImport.
Show child attributes
Show child attributes
queued, running, completed, completed_with_errors, failed, cancelled Counts of admitted items. total is null while more items may be discovered.
Show child attributes
Show child attributes
Last product state change, excluding internal provider checks.
Show child attributes
Show child attributes