Skip to main content
POST
/
workflows
/
runs
/
getDetails
Get Workflow Run Details
curl --request POST \
  --url https://api.emberqa.com/api/workflows/runs/getDetails \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
'
{
  "statusCode": "SUCCESS",
  "statusMessage": "Successfully retrieved workflow run details",
  "doc": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "filename": "Contract-12345-Review",
    "status": "completed",
    "created_time": "2024-01-15T10:30:00Z",
    "metadata": {
      "example_property": "example_value",
      "example_property2": "example_value2"
    },
    "output_schema": {
      "contract_number": {
        "value": "CTR-789456",
        "reasoning": "Found in the header section on page 1, labeled 'Contract #'"
      },
      "effective_date": {
        "value": "2024-01-01",
        "reasoning": "Located in the terms section, specified as 'Effective Date: January 1, 2024'"
      },
      "total_value": {
        "value": "$50,000",
        "reasoning": "Extracted from the payment schedule showing total contract value"
      },
      "payment_terms": {
        "value": "Net 30",
        "reasoning": "Found in payment terms section on page 2"
      }
    },
    "supportingDocs": [
      {
        "id": "doc-123",
        "filename": "contract-page-1.jpg",
        "filenameUrl": "https://storage.example.com/..."
      }
    ]
  }
}

​
Status Values

StatusDescription
pendingQueued for processing
processingCurrently being processed
completedSuccessfully completed - check output_schema for results
failedProcessing failed - check failure_reason for details

​
Result Data

When status is completed, the response includes:
  • output_schema - Extracted data where each field contains a value and reasoning
  • supportingDocs - Array of processed files with presigned download URLs

​
Output Schema Format

Each field in output_schema returns an object with:
  • value - The extracted data (string or null if not found)
  • reasoning - Explanation of how/why the value was extracted

Authorizations

​
Authorization
string
header
required

API key obtained from the EmberQA dashboard under the "Integrations" tab

Body

application/json
​
id
string<uuid>
required

Unique identifier of the workflow run (doc_id from submit response)

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Response

Successfully retrieved workflow run details

​
statusCode
string
Example:

"SUCCESS"

​
statusMessage
string
Example:

"Successfully retrieved workflow run details"

​
doc
object