Version: 1.0.0

Ontologie Workflow API

Ontologie Workflow API

Build, execute, and schedule workflows with 21+ block types.

Getting Started

1. Get an API Key: Settings > API Keys > Create
2. Set Workspace ID: Find in URL or Settings > Workspace
3. Make requests: Include X-API-Key and X-Workspace-Id headers

Authentication

curl -X GET "https://api.ontologie-growthsystemes.com/api/v1/workflow/runs" \
  -H "X-API-Key: your-api-key" \
  -H "X-Workspace-Id: your-workspace-uuid"

Authentication

API Key: apiKey

API key for external integrations. Get yours at Settings > API Keys.

Security Scheme Type:	apiKey
Header parameter name:	X-API-Key

API Key: workspaceId

Workspace UUID. Required for multi-tenant operations.

Security Scheme Type:	apiKey
Header parameter name:	X-Workspace-Id

Contact

Ontologie Support:

URL: https://doc.growthsystemes.com

📄️ Execute batch commands

Execute multiple workflow commands atomically in a single transaction.

📄️ Cancel a running workflow

Cancel a currently running or pending workflow execution.

📄️ Clear breakpoints

Remove all breakpoints from a workflow function.

📄️ Clone workflow to another canvas

Clone a workflow function to a different canvas, creating independent copies of all blocks and edges.

📄️ Continue to next breakpoint

Resume execution of a paused debug run until the next breakpoint or completion.

📄️ Create a Kinetic action

Create a new Kinetic action attached to an entity with webhook, workflow, or script trigger.

📄️ Create a schedule

Create a new cron or interval schedule for a workflow function.

📄️ Create canvas

Create a new workflow canvas to organize functions visually.

📄️ Create a function

Create a new workflow function with an initial flow definition.

📄️ Create a workflow run

Start a new durable workflow execution with automatic checkpointing.

📄️ Create snapshot

Create a named snapshot of the current function state for later restore.

📄️ Delete a schedule

Permanently delete a workflow schedule.

📄️ Delete canvas

Delete a workflow canvas and cascade-delete all contained functions.

📄️ Delete function

Permanently delete a workflow function and all associated runs.

📄️ Delete snapshot

Permanently delete a workflow snapshot.

📄️ Diff between versions

Compare two versions of a workflow function and return the differences.

📄️ Disable schedule

Disable an active schedule. No further runs will be triggered until re-enabled.

📄️ Duplicate canvas

Create a deep copy of a canvas including all its functions.

📄️ Duplicate function

Create a copy of an existing workflow function with a new ID and name suffix.

📄️ Enable schedule

Enable a previously disabled schedule. The next run will be calculated based on the expression.

📄️ Execute a Kinetic action

Manually trigger execution of a Kinetic action.

📄️ Export specific workflow

Export a single workflow function by ID as a JSON bundle.

📄️ Export workflow as JSON

Export one or more workflows as a portable JSON bundle including functions, blocks, and edges.

📄️ Canvas statistics

Get aggregate statistics for a canvas including function count, run counts, and success rates.

📄️ Get command history

Get the full command history for the current workflow session.

📄️ Get debug state

Get the current debug state including variables, block outputs, and execution position.

📄️ Get actions for an entity

Get all Kinetic actions attached to a specific entity.

📄️ Get Kinetic action execution history

Get the execution history for a specific Kinetic action.

📄️ Queue statistics

Get workflow queue statistics including pending, active, and completed counts.

📄️ Get execution logs

Get detailed execution logs for a workflow run, including per-block timings.

📄️ Get schedule details

Get detailed information about a specific schedule.

📄️ Get canvas

Get detailed information about a specific workflow canvas and its functions.

📄️ Get function details

Get detailed information about a specific workflow function including its flow definition.

📄️ Get version history

Get the complete version history for a workflow function.

📄️ Get run details

Get detailed information about a specific workflow run including checkpoints.

📄️ Get snapshot

Get detailed information about a specific snapshot including the full flow definition.

📄️ Import workflow from JSON

Import workflows from a previously exported JSON bundle.

📄️ List disabled block types

List workflow block types that are currently disabled or unavailable.

📄️ List Kinetic agents

List all agents available for Kinetic action bindings.

📄️ List Kinetic workflows

List all workflows available for Kinetic action bindings.

📄️ List checkpoints

List all durable execution checkpoints for a given run.

📄️ List all schedules

List all workflow schedules for the current workspace.

📄️ List canvases

List all workflow canvases in the current workspace.

📄️ List workflow functions

List all workflow functions in the current workspace.

📄️ List workflow runs

List workflow runs with optional filters by function and status.

📄️ List snapshots

List all named snapshots for a workflow function.

📄️ Ontologie Workflow API

# Ontologie Workflow API

📄️ Preview import

Dry-run an import to preview what would be created, updated, or skipped without making changes.

📄️ Redo last undo

Redo the last undone workflow change.

📄️ Reorder canvases

Update the display order of workflow canvases.

📄️ Restore snapshot

Restore a workflow function to the state captured in a snapshot. Creates a new version.

📄️ Retry from last checkpoint

Retry a failed workflow run from the last successful checkpoint. Uses durable execution state for crash recovery.

📄️ Run batch tests

Execute multiple workflow functions in parallel for batch testing.

📄️ Set breakpoints

Set breakpoints on specific blocks within a workflow function for step-through debugging.

📄️ Step through execution

Execute the next block in a paused debug run and pause again.

📄️ Test block sequence

Test a sequence of blocks in isolation to verify their chained behavior.

📄️ Test execute a function

Synchronously execute a workflow function for testing purposes. Uses LogicExecutor (not durable).

📄️ Toggle favorite

Toggle the favorite status of a workflow snapshot.

📄️ Trigger immediate run

Trigger an immediate workflow execution outside of the normal schedule cadence.

📄️ Undo last workflow change

Undo the last workflow change. Uses compensation events in the event store.

📄️ Update a Kinetic action

Update an existing Kinetic action configuration.

📄️ Update a schedule

Update schedule configuration such as expression, type, or timezone.

📄️ Update snapshot tags

Replace the tags on a workflow snapshot.

📄️ Update canvas

Update canvas name or description.

📄️ Update function

Update a workflow function name, description, flow definition, or status.

📄️ Validate workflow configuration

Validate a workflow flow definition for correctness, checking for missing connections, invalid block configs, and unreachable blocks.