Skip to main content
GET
Get Workflow
Get complete details for a specific workflow, including its full node graph, model settings, instructions, and deployment status. The orchestration_nodes array represents the canvas layout — each node is a step in the pipeline (Agent, Action, Classifier, Guardrail, etc.).

Path Parameters

string
required
Unique identifier of the workflow (UUID)

Response

Returns the full WorkflowResponse object with all configuration details including the node graph, trigger settings, notification configuration, and task-level strategies.

Example Request

Notes

  • Returns 404 if the ID belongs to a regular agent (not a workflow)
  • The orchestration_nodes array contains the full canvas graph — each node includes its type, instructions, and connections to other nodes
  • Node types include: pointer (Agent), classifier, parallel, code, guardrail, summarizer, wait, send_to_end

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

workflow_id
string
required

Response

Successful Response

Response model for workflow endpoints.

Inherits from AIAgent but excludes agent-specific fields that are not relevant to workflows (orchestrations). This provides a clean API surface for workflow consumers without exposing confusing agent-only concepts.

The workflow's execution logic is defined in orchestration_nodes — a DAG of typed nodes. Agent-specific fields like graph, attached_tools, delegation_*, framework, and agno_settings are hidden.

name
string
required
organization_id
string
required
webhook_url
string
required
read-only
id
string | null
unique_name
string | null
origin_template
string | null
environment_id
string | null
deployment_type
enum<string> | null
default:serverless
Available options:
serverless,
container
prompts
string[] | null
is_latest
boolean | null
default:false
has_pending_changes
boolean | null
default:false
deep_planning
boolean | null
default:true
enforce_deep_planning
boolean | null
default:true
use_agent_gateway
boolean | null
default:false
connectivity_details
AIAgentConnectivityDetailsA2A · object
framework
string | null
default:agno
description
string | null
default:""
tools
any[] | null
icon
string | null
default:🚀
avatar
string | null
default:male-avatar
source_nodes
AIAgentSourceNode · object[] | null
attached_tools
Connector · object[] | null
access_scope
enum<string> | null
default:personal
Available options:
personal,
organizational
instructions
AIAgentInstructions · object | null
oas
Oas · object | null
graph
AIAgentGraphItem · object[] | null
is_omni
boolean | null
default:false
skills
Skills · object[] | null
status
enum<string> | null
default:ACTIVE

Enumeration of possible agent statuses.

Attributes: DRAFT: Agent is in a draft state. ACTIVE: Agent is active and operational. INACTIVE: Agent is inactive and not operational.

Available options:
DRAFT,
ACTIVE,
INACTIVE
knowledge_bases
AgentKnowledgeBase · object[] | null
version
integer | null
default:1
created_by
string | null
created_at
string<date-time> | null
type
enum<string> | null

Enumeration of the agent types.

Attributes: Manager: marks the agent as a Managing agent. Regular: marks the agent as a regular agent. A2A: marks the agent as an external agent used via A2A protocol. Curl: marks the agent as an external agent used via a CURL. Orchestration: marks the agent as an Orchestration object.

Available options:
manager,
regular,
a2a,
curl,
orchestration
using_nemo
boolean | null
default:false
deletable
boolean | null
default:true
model_provider
enum<string> | null
default:amazon_bedrock
Available options:
openai,
nim,
amazon_bedrock,
azure_ai_foundary,
huggingFace,
friendlyAI,
anthropic,
gemini,
fireworks,
google_ai_studio,
helicone,
bytedance,
tzafon_lightcone,
cerebras,
open_router,
nebius,
cloudflare_ai_gw,
z_ai
model_name
string | null
default:global.anthropic.claude-sonnet-5
llm_reasoning_effort
enum<string> | null
default:medium
Available options:
low,
medium,
high,
xhigh
llm_api_base
string | null
output_format
enum<string> | null
default:markdown
Available options:
text,
markdown,
json,
voice
voice_id
string | null
output_schema
Output Schema · object | null
llm_credentials_key
string | null
llm_credentials_key_type
enum<string> | null
default:xpander
Available options:
xpander,
custom
llm_credentials
LLMCredentials · object | null
llm_extra_headers
Llm Extra Headers · object | null
expected_output
string | null
default:""
agno_settings
AgnoSettings · object | null
on_prem_event_streaming
boolean | null
default:true
is_supervised
boolean | null
default:false
orchestration_nodes
OrchestrationNode · object[] | null
notification_settings
NotificationSettings · object | null

Configuration for event-based notifications.

Attributes: on_success: Notifications to send when an operation succeeds. Maps notification types to a list of notification configurations. on_error: Notifications to send when an operation fails. Maps notification types to a list of notification configurations. on_budget: Notifications to send on budget threshold crossings. A dedicated category — budget alerts are not errors.

task_level_strategies
TaskLevelStrategies · object | null

Configuration object for task-level execution strategies.

This model groups optional strategy configurations that control how a task is executed and managed over time, including retries, iterative execution, stopping conditions, and daily run limits.

Attributes: retry_strategy: Optional retry policy configuration that defines how the task should behave when execution fails (e.g., max attempts, backoff rules).

use_oidc_pre_auth
boolean | null
default:false
pre_auth_audiences
string[] | null
use_oidc_pre_auth_token_for_llm
boolean | null
default:false
oidc_pre_auth_token_llm_audience
string | null
oidc_pre_auth_token_mcp_audience
string | null
can_self_schedule
boolean | null
default:false
max_self_schedules
integer | null
default:3
Required range: 1 <= x <= 1000
use_dynamic_tools
boolean | null
default:false
workspace_tools_enabled
boolean | null
default:true
is_autonomous
boolean | null
default:false
discoverable
boolean | null
default:true
with_auto_context_management
boolean | null
default:true
developer_access
boolean | null
default:true
should_stage_before_publish
boolean | null
default:true