Orchestrator Types

TypeScript types for the Orchestrator API - workflows, API keys, and webhook triggers.

Orchestrator API Reference: Types conform to the Orchestrator REST API (separate from the Inference API). These TypeScript interfaces match the API JSON responses exactly. See the Orchestrator product documentation for complete usage.

See Orchestrator for usage.

OrchestratorWorkflowSummary

Returned by workflows.list() from GET /api/workflows. Lightweight workflow representation without nodes/edges.

interface OrchestratorWorkflowSummary {
  id: string;
  name: string;
  description: string;
  visibility: string;
  createdAt: string;
  updatedAt: string;
}

Field	Type	Description
`id`	`string`	Workflow ID.
`name`	`string`	Workflow name.
`description`	`string`	Description.
`visibility`	`string`	Visibility level.
`createdAt`	`string`	Creation timestamp.
`updatedAt`	`string`	Last update.

OrchestratorCreateWorkflowBody

interface OrchestratorCreateWorkflowBody {
  name: string;
  description?: string;
  nodes?: unknown[];
  edges?: unknown[];
}

Field	Type	Description
`name`	`string`	Workflow name (required).
`description`	`string`	Description.
`nodes`	`unknown[]`	Workflow nodes.
`edges`	`unknown[]`	Workflow edges.

OrchestratorUpdateWorkflowBody

interface OrchestratorUpdateWorkflowBody {
  name?: string;
  description?: string;
  nodes?: unknown[];
  edges?: unknown[];
  visibility?: string;
}

Field	Type	Description
`name`	`string`	Updated name.
`description`	`string`	Updated description.
`nodes`	`unknown[]`	Updated nodes.
`edges`	`unknown[]`	Updated edges.
`visibility`	`string`	Updated visibility.

OrchestratorWebhookTriggerResponse

Returned when triggering a workflow via webhook from POST /api/workflows/{workflowId}/webhook. See Orchestrator Webhooks.

interface OrchestratorWebhookTriggerResponse {
  executionId: string;
  status: string;
}

Field	Type	Description
`executionId`	`string`	Execution ID.
`status`	`string`	Execution status.

OrchestratorCreateApiKeyResponse

Returned by apiKeys.create(). See Orchestrator API Keys.

interface OrchestratorCreateApiKeyResponse {
  id: string;
  name: string;
  key: string;
  keyPrefix: string;
  createdAt: string;
}

Field	Type	Description
`id`	`string`	Key ID.
`name`	`string`	Key name.
`key`	`string`	Full key value (`wfb_…`). Returned only once at creation.
`keyPrefix`	`string`	Key prefix for display.
`createdAt`	`string`	Creation timestamp.

OrchestratorAiStreamOperation

interface OrchestratorAiStreamOperation {
  op: string;
}

Field	Type	Description
`op`	`string`	Operation type.

How is this guide?