Skip to main content
POST
Submit Workflow

Important Notes

  • This is an async operation - the response means the files are accepted for processing
  • Use the returned doc_id with /runs/getDetails to check processing status
  • file_urls must be publicly accessible or use presigned URLs
  • Processing time varies by file size and complexity

Supported File Formats

  • Images: PNG, JPG, JPEG, GIF, WEBP
  • Documents: PDF

Authorizations

Authorization
string
header
required

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

Body

application/json
file_urls
string<uri>[]
required

Array of publicly accessible URLs to the files to process. Supports images (PNG, JPG, etc.) and PDFs.

Example:
extraction_template_id
string<uuid>
required

ID of the extraction template to use. Get available templates from /extractionTemplates/getAll

Example:

"ecf1adf3-11f5-4ff7-a4d1-92367384d7ba"

run_id
string
required

Human-readable name for this workflow run (e.g., 'Invoice-12345-Processing')

Example:

"Contract-12345-Review"

agent_name
string

Identifier for tracking (e.g., agent name or API client identifier)

Example:

"John Doe"

metadata
object

Optional custom key-value pairs for filtering and tracking. Searchable via /workflows/getData

Example:

Response

Workflow accepted for processing

message
string
Example:

"File Accepted"

doc_id
string<uuid>

Unique identifier for the submitted workflow. Use this with /workflows/getDetails to check status.