Workflows

Start a new workflow run

Creates a new workflow run and returns an upload URL. Upload your document to the URL, then call confirm to start processing.

post/api/v1/workflows/{slug}/run

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/workflows/{slug}/run
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Path parameters

slugstring required

Headers

X-Korala-Mode'live' | 'test'

Dashboard JWT: live (default) or test. API keys are pinned to their credential mode. Mode cannot be changed after creation.

user-agentstring required

Request body

inputDataobject

Additional input data for the workflow

Example request

{
  "inputData": {
    "customField": "value"
  }
}

Response

runIdstring required

The workflow run ID to poll for status

status'pending' | 'running' | 'paused' | 'completed' | 'failed' required

Changes

No recorded changes to this operation across all 1 revision of this API.