Skip to main content
PATCH
/
api
/
workflows
/
{workflow_uuid}
Update Workflow
curl --request PATCH \
  --url https://api.example.com/api/workflows/{workflow_uuid} \
  --header 'Content-Type: application/json' \
  --header 'X-Kinetic-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "specification": {}
}
'
{
  "workflow_uuid": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "workflow_version_uuid": "<string>",
  "specification": null,
  "versions": [
    {
      "workflow_version_uuid": "<string>",
      "workflow_uuid": "<string>",
      "specification": "<unknown>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "version": 123,
      "is_current": true,
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "current_version": 123,
  "executions": 0,
  "success_rate": 123,
  "last_run": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.kineticsystems.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Kinetic-Key
string
header
required

Your Kinetic API key

Path Parameters

​
workflow_uuid
string
required

Body

application/json
​
name
string | null
​
description
string | null
​
specification
Specification · object

Response

Successful Response

Backed by workflows table (see kinetic/db/schema.sql).

workflow_version_uuid/specification are derived from the latest version and may be included by some endpoints.

​
workflow_uuid
string
required
​
name
string
required
​
created_at
string<date-time> | null
​
updated_at
string<date-time> | null
​
description
string | null
​
workflow_version_uuid
string | null
​
specification
unknown
​
versions
WorkflowVersionResponse · object[] | null
​
current_version
integer | null
​
executions
integer
default:0
​
success_rate
number | null
​
last_run
string<date-time> | null