Deactivate, or permanently delete, a workflow

curl --request DELETE \
  --url https://app.hookie.ai/admin/api/projects/{project_id}/workflows/{workflow_id} \
  --cookie hookie_session=

const options = {method: 'DELETE', headers: {cookie: 'hookie_session='}};

fetch('https://app.hookie.ai/admin/api/projects/{project_id}/workflows/{workflow_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.hookie.ai/admin/api/projects/{project_id}/workflows/{workflow_id}"

headers = {"cookie": "hookie_session="}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "ok": true,
  "done": true,
  "deleted": {
    "runs": 123,
    "step_events": 123
  }
}

{
  "ok": true,
  "done": false,
  "deleted": {
    "runs": 123,
    "step_events": 123
  },
  "remaining_runs": 123,
  "message": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "code": "unfinished_runs",
  "unfinished_runs": 123,
  "instances": [
    {
      "id": "<string>",
      "state": "<string>",
      "paused": true
    }
  ]
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

Workflows

Deactivate, or permanently delete, a workflow

By default the workflow is DEACTIVATED: `active` is set to 0, the definition and all its run history are kept, it stays in listWorkflows, and PATCH {"active": true} turns it back on. Runs already in progress carry on. With ?permanent=true it is deleted for good (#256): the definition (a workflow's version is a number on it, not a separate row) and its whole run history, meaning every run, its step log and any legacy-engine waiter. Nothing else goes: records and deliveries the runs produced, and the AI call log, are kept. A permanent delete is refused (409) while any run has not finished: pending, running, waiting, or paused by a workspace suspension. Cancel those runs first (POST workflow-instances/{id}/cancel). The workflow is deactivated before its history is deleted, so it starts no new runs meanwhile. The history goes in chunks, at most 10,000 runs a call; a longer one answers 202 with `done: false`, and the same DELETE again carries on until the one that removes the workflow answers 200. Each call that deletes something writes a `delete_workflow` audit row (details: permanent, done, name, project_id, runs_deleted, step_events_deleted); a deactivation writes one with `permanent: false`. Scoped to the caller's workspace and this project: a workflow of another project or workspace is not found.

DELETE

admin

api

projects

{project_id}

workflows

{workflow_id}

Deactivate, or permanently delete, a workflow

curl --request DELETE \
  --url https://app.hookie.ai/admin/api/projects/{project_id}/workflows/{workflow_id} \
  --cookie hookie_session=

const options = {method: 'DELETE', headers: {cookie: 'hookie_session='}};

fetch('https://app.hookie.ai/admin/api/projects/{project_id}/workflows/{workflow_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.hookie.ai/admin/api/projects/{project_id}/workflows/{workflow_id}"

headers = {"cookie": "hookie_session="}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "ok": true,
  "done": true,
  "deleted": {
    "runs": 123,
    "step_events": 123
  }
}

{
  "ok": true,
  "done": false,
  "deleted": {
    "runs": 123,
    "step_events": 123
  },
  "remaining_runs": 123,
  "message": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "code": "unfinished_runs",
  "unfinished_runs": 123,
  "instances": [
    {
      "id": "<string>",
      "state": "<string>",
      "paused": true
    }
  ]
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

Authorizations

hookie_session

string

required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

project_id

string

required

workflow_id

string

required

Query Parameters

permanent

boolean

default:false

true deletes the workflow and its run history for good. Omitted or false, the workflow is only deactivated (active set to 0), and PATCH active:true brings it back. Any other value is refused with 400.

Response

Deactivated ({"ok": true}), or with ?permanent=true deleted along with its runs and their step log (done: true, and what went in deleted).

enum<boolean>

required

Available options:

true

done

enum<boolean>

Permanent delete only: the workflow itself is gone.

Available options:

true

deleted

object

Permanent delete only: what this call deleted.

Show child attributes

Get started

Concepts

CLI

Guides

API reference

Deactivate, or permanently delete, a workflow

Authorizations

Path Parameters

Query Parameters

Response