Workflows
Workflow management operations
Workflow management operations
List all workflow executions
Retrieve a list of all workflow executions across all workflows
Response Body
curl -X GET "https://loading/api/v0/executions/workflows"{
"data": {
"executions": [
{
"error": {
"code": "string",
"details": {
"property1": null,
"property2": null
},
"message": "string"
},
"input": {
"property1": null,
"property2": null
},
"output": {
"property1": null,
"property2": null
},
"status": "PENDING",
"tasks": {
"property1": {
"action_id": "string",
"agent_id": "string",
"component": "workflow",
"created_at": "string",
"error": {
"code": "string",
"details": {
"property1": null,
"property2": null
},
"message": "string"
},
"execution_type": "basic",
"input": {
"property1": null,
"property2": null
},
"output": {
"property1": null,
"property2": null
},
"parent_state_id": "string",
"status": "PENDING",
"task_exec_id": "string",
"task_id": "string",
"tool_id": "string",
"updated_at": "string",
"workflow_exec_id": "string",
"workflow_id": "string"
},
"property2": {
"action_id": "string",
"agent_id": "string",
"component": "workflow",
"created_at": "string",
"error": {
"code": "string",
"details": {
"property1": null,
"property2": null
},
"message": "string"
},
"execution_type": "basic",
"input": {
"property1": null,
"property2": null
},
"output": {
"property1": null,
"property2": null
},
"parent_state_id": "string",
"status": "PENDING",
"task_exec_id": "string",
"task_id": "string",
"tool_id": "string",
"updated_at": "string",
"workflow_exec_id": "string",
"workflow_id": "string"
}
},
"workflow_exec_id": "string",
"workflow_id": "string"
}
]
},
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"data": null,
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}curl -X GET "https://loading/api/v0/workflows"{
"data": {
"workflows": [
{
"agent_count": 0,
"author": {
"contributors": [
{
"email": "string",
"name": "string",
"organization": "string",
"url": "string"
}
],
"email": "string",
"name": "string",
"organization": "string",
"url": "string"
},
"config": {
"env": {
"property1": "string",
"property2": "string"
},
"heartbeat_timeout": "string",
"input": {
"property1": null,
"property2": null
},
"on_error": {
"next": "string",
"with": {
"property1": null,
"property2": null
}
},
"retry_policy": {
"backoff_coefficient": 0,
"initial_interval": "string",
"maximum_attempts": 0,
"maximum_interval": "string",
"non_retryable_error_types": [
"string"
]
},
"schedule_to_close_timeout": "string",
"schedule_to_start_timeout": "string",
"start_to_close_timeout": "string"
},
"description": "string",
"id": "string",
"mcp_count": 0,
"schedule": {
"cron": "string",
"enabled": true,
"end_at": "string",
"input": {
"property1": null,
"property2": null
},
"jitter": "string",
"overlap_policy": "skip",
"start_at": "string",
"timezone": "string"
},
"task_count": 0,
"task_ids": [
"string"
],
"tool_count": 0,
"triggers": [
{
"name": "string",
"schema": {
"property1": null,
"property2": null
},
"type": "signal"
}
],
"version": "string"
}
]
},
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"data": null,
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}Get workflow by ID
Retrieve a specific workflow configuration by its ID
Path Parameters
workflow_idstring
Workflow ID
Response Body
curl -X GET "https://loading/api/v0/workflows/string"{
"data": {
"agent_count": 0,
"author": {
"contributors": [
{
"email": "string",
"name": "string",
"organization": "string",
"url": "string"
}
],
"email": "string",
"name": "string",
"organization": "string",
"url": "string"
},
"config": {
"env": {
"property1": "string",
"property2": "string"
},
"heartbeat_timeout": "string",
"input": {
"property1": null,
"property2": null
},
"on_error": {
"next": "string",
"with": {
"property1": null,
"property2": null
}
},
"retry_policy": {
"backoff_coefficient": 0,
"initial_interval": "string",
"maximum_attempts": 0,
"maximum_interval": "string",
"non_retryable_error_types": [
"string"
]
},
"schedule_to_close_timeout": "string",
"schedule_to_start_timeout": "string",
"start_to_close_timeout": "string"
},
"description": "string",
"id": "string",
"mcp_count": 0,
"schedule": {
"cron": "string",
"enabled": true,
"end_at": "string",
"input": {
"property1": null,
"property2": null
},
"jitter": "string",
"overlap_policy": "skip",
"start_at": "string",
"timezone": "string"
},
"task_count": 0,
"task_ids": [
"string"
],
"tool_count": 0,
"triggers": [
{
"name": "string",
"schema": {
"property1": null,
"property2": null
},
"type": "signal"
}
],
"version": "string"
},
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"data": null,
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"data": null,
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"data": null,
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}List executions by workflow ID
Retrieve all executions for a specific workflow
Path Parameters
workflow_idstring
Workflow ID
Response Body
curl -X GET "https://loading/api/v0/workflows/string/executions"{
"data": {
"executions": [
{
"error": {
"code": "string",
"details": {
"property1": null,
"property2": null
},
"message": "string"
},
"input": {
"property1": null,
"property2": null
},
"output": {
"property1": null,
"property2": null
},
"status": "PENDING",
"tasks": {
"property1": {
"action_id": "string",
"agent_id": "string",
"component": "workflow",
"created_at": "string",
"error": {
"code": "string",
"details": {
"property1": null,
"property2": null
},
"message": "string"
},
"execution_type": "basic",
"input": {
"property1": null,
"property2": null
},
"output": {
"property1": null,
"property2": null
},
"parent_state_id": "string",
"status": "PENDING",
"task_exec_id": "string",
"task_id": "string",
"tool_id": "string",
"updated_at": "string",
"workflow_exec_id": "string",
"workflow_id": "string"
},
"property2": {
"action_id": "string",
"agent_id": "string",
"component": "workflow",
"created_at": "string",
"error": {
"code": "string",
"details": {
"property1": null,
"property2": null
},
"message": "string"
},
"execution_type": "basic",
"input": {
"property1": null,
"property2": null
},
"output": {
"property1": null,
"property2": null
},
"parent_state_id": "string",
"status": "PENDING",
"task_exec_id": "string",
"task_id": "string",
"tool_id": "string",
"updated_at": "string",
"workflow_exec_id": "string",
"workflow_id": "string"
}
},
"workflow_exec_id": "string",
"workflow_id": "string"
}
]
},
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"data": null,
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"data": null,
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}Execute workflow
Trigger the execution of a workflow with provided input data
Path Parameters
workflow_idstring
Workflow ID
Workflow input data
Empty Object
Response Body
curl -X POST "https://loading/api/v0/workflows/string/executions" \
-H "Content-Type: application/json" \
-d '{}'{
"data": {
"exec_id": "2Z4PVTL6K27XVT4A3NPKMDD5BG",
"exec_url": "localhost:5001/api/workflows/executions/2Z4PVTL6K27XVT4A3NPKMDD5BG",
"workflow_id": "data-processing"
},
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"data": null,
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"data": null,
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}{
"data": null,
"error": {
"code": "string",
"details": "string",
"message": "string"
},
"message": "string",
"status": 0
}API Overview
Compozy provides a comprehensive **REST API** that enables programmatic access to the Next-level Agentic Orchestration Platform, tasks, and tools. The API follows RESTful design principles and provides a unified interface for managing all aspects of your AI-powered workflows.
Tasks
Task management operations