Workflows

Update a workflow definition

patch/api/v1/workflows/{slug}

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/workflows/{slug}
  • 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.

Request body

namestring
slugstring
descriptionstring
stepsstring[]

Array of step configurations

inputSchemaobject

Expected input schema (JSON Schema format)

outputSchemaobject nullable

Expected output schema (JSON Schema format). null removes the stored schema; leaving it out keeps it.

isPublicboolean

Whether this workflow is publicly accessible

isActiveboolean

Whether this workflow is active

Example request

{
  "name": "Updated Workflow Name",
  "slug": "updated-slug",
  "description": "Updated description"
}

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.