Workflows

Create a new workflow definition

post/api/v1/workflows

Request

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

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.

Request body

namestring required
slugstring required
descriptionstring
stepsstring[] required

Array of step configurations

inputSchemaobject

Expected input schema (JSON Schema format)

outputSchemaobject

Expected output schema (JSON Schema format)

isPublicboolean

Whether this workflow is publicly accessible for demos

Example request

{
  "name": "Proof of Address Extraction",
  "slug": "proof-of-address",
  "description": "Extract and validate proof of address documents",
  "steps": [
    {
      "type": "capture",
      "config": {
        "acceptedTypes": [
          "application/pdf"
        ],
        "maxSizeMb": 10
      }
    },
    {
      "type": "ocr",
      "config": {
        "provider": "auto"
      }
    }
  ]
}

Response

sandboxboolean required

Persisted execution mode: true for test data

idstring required
organizationIdstring nullable
namestring required
slugstring required
descriptionstring nullable
inputSchemaobject nullable
outputSchemaobject nullable
isPublicboolean required
isActiveboolean required
createdAtstring date-time required
updatedAtstring date-time required

When what a run executes last changed: the steps, output sharing, the input or output schema, or the slug. A rename, a new description or switching the workflow on or off leaves it alone.

Changes

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