Workflow Endpoints
Update WorkflowRun
API Documentation
Workflow Endpoints
Processor Endpoints
Parse Endpoints
Evaluation Set Endpoints
Objects
Webhooks
Workflow Endpoints
Update WorkflowRun
You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.
curl --location --request POST 'https://api-prod.extend.app/v1/workflow_runs/:id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>' \
--data '{
"name": "test_workflow",
"metadata": {
"internal_id": "id_1234"
}
}'
{
"success": true,
"workflowRun": {
"object": "workflow_run",
"id": "workflow_run_1234",
"status": "PROCESSED",
"metadata": {
"internal_id": "id_1234"
},
"initialRunAt": "2023-01-01T09:41:00.000Z",
"reviewedBy": "user_1234",
"reviewedAt": "2023-01-10T05:39:14.500Z",
"startTime": "2023-01-01T09:41:00.000Z",
"endTime": "2023-01-10T05:39:24.500Z",
"files": [
{
"object": "file",
"id": "file_1234",
"name": "example_file_name.pdf",
}
],
"outputs": [
{
"object": "document_processor_run",
"id": "dpr_1234",
"edited": true,
"type": "EXTRACT",
"initialOutput": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"reviewedOutput": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"output": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
}
}
],
"workflow": {
"object": "workflow",
"id": "workflow_1234",
"version": "1",
"name": "test_workflow"
}
}
}
Parameters
The ID of the WorkflowRun that was outputted after you created it using the /workflow_runs endpoint.
Body
An optional name that can be assigned to a specific WorkflowRun.
A metadata object that can be assigned to a specific WorkflowRun. If metadata already exists on the WorkflowRun, this new metadata object will be merged with it, with the new metadata taking field precedence.
Response
An object representing a WorkflowRun. See the WorkflowRun object for the shape of the data.
curl --location --request POST 'https://api-prod.extend.app/v1/workflow_runs/:id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>' \
--data '{
"name": "test_workflow",
"metadata": {
"internal_id": "id_1234"
}
}'
{
"success": true,
"workflowRun": {
"object": "workflow_run",
"id": "workflow_run_1234",
"status": "PROCESSED",
"metadata": {
"internal_id": "id_1234"
},
"initialRunAt": "2023-01-01T09:41:00.000Z",
"reviewedBy": "user_1234",
"reviewedAt": "2023-01-10T05:39:14.500Z",
"startTime": "2023-01-01T09:41:00.000Z",
"endTime": "2023-01-10T05:39:24.500Z",
"files": [
{
"object": "file",
"id": "file_1234",
"name": "example_file_name.pdf",
}
],
"outputs": [
{
"object": "document_processor_run",
"id": "dpr_1234",
"edited": true,
"type": "EXTRACT",
"initialOutput": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"reviewedOutput": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"output": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
}
}
],
"workflow": {
"object": "workflow",
"id": "workflow_1234",
"version": "1",
"name": "test_workflow"
}
}
}
curl --location --request POST 'https://api-prod.extend.app/v1/workflow_runs/:id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>' \
--data '{
"name": "test_workflow",
"metadata": {
"internal_id": "id_1234"
}
}'
{
"success": true,
"workflowRun": {
"object": "workflow_run",
"id": "workflow_run_1234",
"status": "PROCESSED",
"metadata": {
"internal_id": "id_1234"
},
"initialRunAt": "2023-01-01T09:41:00.000Z",
"reviewedBy": "user_1234",
"reviewedAt": "2023-01-10T05:39:14.500Z",
"startTime": "2023-01-01T09:41:00.000Z",
"endTime": "2023-01-10T05:39:24.500Z",
"files": [
{
"object": "file",
"id": "file_1234",
"name": "example_file_name.pdf",
}
],
"outputs": [
{
"object": "document_processor_run",
"id": "dpr_1234",
"edited": true,
"type": "EXTRACT",
"initialOutput": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"reviewedOutput": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
},
"output": {
"value": {
"amount": {
"amount": 15735.1,
"iso_4217_currency_code": "USD"
},
"invoice_number": "36995"
},
"metadata": {
"amount": {
"insights": [
{
"type": "reasoning",
"content": "The total amount is shown as '$15,735.1' in both the table summary and the bottom right of the document. The currency symbol '$' and the US address indicate the currency is USD. The value is numeric and matches the required format."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 430.164,
"y": 722.772
},
{
"x": 467.27279999999996,
"y": 722.8296
},
{
"x": 467.2584,
"y": 731.6351999999999
},
{
"x": 430.1496,
"y": 731.5776
}
],
"referenceText": "TOTAL $15,735.1"
}
],
"ocrConfidence": 0.992,
"logprobsConfidence": 1
},
"invoice_number": {
"insights": [
{
"type": "reasoning",
"content": "The invoice number is clearly labeled as 'Invoice #36995' at the top right of the document, making it straightforward to extract."
}
],
"citations": [
{
"page": 1,
"polygon": [
{
"x": 296.73359999999997,
"y": 40.888799999999996
},
{
"x": 386.4168,
"y": 40.464000000000006
},
{
"x": 386.4744,
"y": 52.1712
},
{
"x": 296.7912,
"y": 52.596000000000004
}
],
"referenceText": "Invoice #36995"
}
],
"ocrConfidence": 0.986,
"logprobsConfidence": 1
}
},
}
}
],
"workflow": {
"object": "workflow",
"id": "workflow_1234",
"version": "1",
"name": "test_workflow"
}
}
}