workflows — @personaai/sdk

Generated field tables for workflows — do not edit

Generated from sdk/typescript/dist/typedoc.json — do not edit. Regenerate with node platform/scripts/typedoc-resources.mjs.

workflows

Auth: Requires Authorization: Bearer <keyId>.<secret> (server-side). For per-user calls add x-persona-external-user-id. See .

Workflows are multi-agent DAGs compiled to LangGraph StateGraphs — draft (editable) + publishedVersion (immutable). Stream via AG-UI with seq for resume and dryRun for safe testing.

Example

TypeScript

const wf = await persona.workflows.create({ name: 'Research', draft: { nodes, edges, trigger: { type: 'manual' } } });const result = await persona.workflows.run(wf._id, { input: { query: 'trends' } });for await (const e of persona.workflows.stream(wf._id, { input: { query: '...' } })) {}

const wf = await persona.workflows.create({ name: 'Research', draft: { nodes, edges, trigger: { type: 'manual' } } });const result = await persona.workflows.run(wf._id, { input: { query: 'trends' } });for await (const e of persona.workflows.stream(wf._id, { input: { query: '...' } })) {}

cURL

bash

curl https://api.persona.hasanraiyan.me/api/v1/developer/workflows/WF_ID/runs -H "Authorization: Bearer $PERSONA_CREDENTIAL" -H "Content-Type: application/json" -d '{"input":{"query":"trends"}}'

curl https://api.persona.hasanraiyan.me/api/v1/developer/workflows/WF_ID/runs -H "Authorization: Bearer $PERSONA_CREDENTIAL" -H "Content-Type: application/json" -d '{"input":{"query":"trends"}}'

Response

json

{  "success": true,  "data": { "runId": "run_123", "status": "completed", "output": { "summary": "..." } }}

{  "success": true,  "data": { "runId": "run_123", "status": "completed", "output": { "summary": "..." } }}

`Workflow`

Source: types/workflow.ts:61

Interface

Field	Type	Description
`_id`	`string`	— _ `types/workflow.ts:62`_
`domain?`	`string`	— _ `types/workflow.ts:63`_
`projectId?`	`string`	— _ `types/workflow.ts:64`_
`name`	`string`	— _ `types/workflow.ts:65`_
`description?`	`string`	— _ `types/workflow.ts:66`_
`isEnabled`	`boolean`	— _ `types/workflow.ts:67`_
`visibility`	`WorkflowVisibility`	— _ `types/workflow.ts:68`_
`ownerType`	`WorkflowOwnerType`	— _ `types/workflow.ts:69`_
`externalOwnerId?`	`string \| null`	— _ `types/workflow.ts:70`_
`draft`	`WorkflowDraft`	— _ `types/workflow.ts:71`_
`publishedVersion`	`number`	— _ `types/workflow.ts:72`_
`activeRuns`	`number`	— _ `types/workflow.ts:73`_
`createdAt`	`string`	— _ `types/workflow.ts:74`_
`updatedAt`	`string`	— _ `types/workflow.ts:75`_

`WorkflowNodeType`

Source: types/workflow.ts:3

Kind 2097152

type WorkflowNodeType = "trigger" | "agentStep" | "knowledgeStep" | "toolStep" | "condition" | "approval" | "parallel" | "join" | "output"

type WorkflowNodeType = "trigger" | "agentStep" | "knowledgeStep" | "toolStep" | "condition" | "approval" | "parallel" | "join" | "output"

`WorkflowTriggerType`

Source: types/workflow.ts:14

Kind 2097152

`WorkflowVisibility`

Source: types/workflow.ts:15

Kind 2097152

`WorkflowOwnerType`

Source: types/workflow.ts:16

Kind 2097152

`NodeOnErrorAction`

Source: types/workflow.ts:17

Kind 2097152

`NodeRetryPolicy`

Source: types/workflow.ts:19

Interface

Field	Type	Description
`maxRetries?`	`number`	— _ `types/workflow.ts:20`_
`backoffMs?`	`number`	— _ `types/workflow.ts:21`_
`exponential?`	`boolean`	— _ `types/workflow.ts:22`_

`WorkflowNodeData`

Source: types/workflow.ts:25

Interface

Field	Type	Description
`label`	`string`	— _ `types/workflow.ts:26`_
`description?`	`string`	— _ `types/workflow.ts:27`_
`config?`	`Record<string, unknown>`	— _ `types/workflow.ts:28`_
`retryPolicy?`	`NodeRetryPolicy`	— _ `types/workflow.ts:29`_
`onError?`	`NodeOnErrorAction`	— _ `types/workflow.ts:30`_

`WorkflowNode`

Source: types/workflow.ts:33

Interface

Field	Type	Description
`id`	`string`	— _ `types/workflow.ts:34`_
`type`	`WorkflowNodeType`	— _ `types/workflow.ts:35`_
`position?`	`{ x: number; y: number }`	— _ `types/workflow.ts:36`_
`data`	`WorkflowNodeData`	— _ `types/workflow.ts:37`_

`WorkflowEdge`

Source: types/workflow.ts:40

Interface

Field	Type	Description
`id`	`string`	— _ `types/workflow.ts:41`_
`source`	`string`	— _ `types/workflow.ts:42`_
`target`	`string`	— _ `types/workflow.ts:43`_
`sourceHandle?`	`string`	— _ `types/workflow.ts:44`_
`targetHandle?`	`string`	— _ `types/workflow.ts:45`_
`condition?`	`unknown`	— _ `types/workflow.ts:46`_
`conditionValue?`	`string`	— _ `types/workflow.ts:47`_

`WorkflowTrigger`

Source: types/workflow.ts:50

Interface

Field	Type	Description
`type`	`WorkflowTriggerType`	— _ `types/workflow.ts:51`_
`config?`	`Record<string, unknown>`	— _ `types/workflow.ts:52`_

`WorkflowDraft`

Source: types/workflow.ts:55

Interface

Field	Type	Description
`nodes`	`WorkflowNode[]`	— _ `types/workflow.ts:56`_
`edges`	`WorkflowEdge[]`	— _ `types/workflow.ts:57`_
`trigger?`	`WorkflowTrigger`	— _ `types/workflow.ts:58`_

`AgentSnapshot`

Source: types/workflow.ts:78

Interface

Field	Type	Description
`modelName`	`string`	— _ `types/workflow.ts:79`_
`systemPrompt`	`string`	— _ `types/workflow.ts:80`_
`tools?`	`string[]`	— _ `types/workflow.ts:81`_

`WorkflowVersion`

Source: types/workflow.ts:84

Interface

Field	Type	Description
`_id`	`string`	— _ `types/workflow.ts:85`_
`workflowId`	`string`	— _ `types/workflow.ts:86`_
`projectId`	`string`	— _ `types/workflow.ts:87`_
`version`	`number`	— _ `types/workflow.ts:88`_
`definition`	`WorkflowDraft`	— _ `types/workflow.ts:89`_
`agentSnapshots?`	`Record<string, AgentSnapshot>`	— _ `types/workflow.ts:90`_
`publishedBy?`	`string`	— _ `types/workflow.ts:91`_
`publishedAt`	`string`	— _ `types/workflow.ts:92`_
`createdAt`	`string`	— _ `types/workflow.ts:93`_
`updatedAt`	`string`	— _ `types/workflow.ts:94`_

`WorkflowRunStatus`

Source: types/workflow.ts:97

Kind 2097152

`NodeRunStatus`

Source: types/workflow.ts:105

Kind 2097152

`NodeRun`

Source: types/workflow.ts:107

Interface

Field	Type	Description
`nodeId`	`string`	— _ `types/workflow.ts:108`_
`nodeType`	`string`	— _ `types/workflow.ts:109`_
`status`	`NodeRunStatus`	— _ `types/workflow.ts:110`_
`input?`	`unknown`	— _ `types/workflow.ts:111`_
`output?`	`unknown`	— _ `types/workflow.ts:112`_
`error?`	`string`	— _ `types/workflow.ts:113`_
`retriesTaken`	`number`	— _ `types/workflow.ts:114`_
`durationMs`	`number`	— _ `types/workflow.ts:115`_
`tokens`	`number`	— _ `types/workflow.ts:116`_
`startedAt`	`string`	— _ `types/workflow.ts:117`_
`endedAt?`	`string`	— _ `types/workflow.ts:118`_

`WorkflowUsage`

Source: types/workflow.ts:121

Interface

Field	Type	Description
`totalTokens`	`number`	— _ `types/workflow.ts:122`_
`agentTurns`	`number`	— _ `types/workflow.ts:123`_
`toolCalls`	`number`	— _ `types/workflow.ts:124`_
`creditsDeducted`	`number`	— _ `types/workflow.ts:125`_

`WorkflowRun`

Source: types/workflow.ts:128

Interface

Field	Type	Description
`_id`	`string`	— _ `types/workflow.ts:129`_
`workflowId`	`string`	— _ `types/workflow.ts:130`_
`workflowVersion`	`number`	— _ `types/workflow.ts:131`_
`projectId`	`string`	— _ `types/workflow.ts:132`_
`triggeredBy`	`{ type: WorkflowTriggerType; userId: string; details: unknown }`	— _ `types/workflow.ts:133`_
`status`	`WorkflowRunStatus`	— _ `types/workflow.ts:138`_
`isDryRun`	`boolean`	— _ `types/workflow.ts:139`_
`nodeRuns`	`NodeRun[]`	— _ `types/workflow.ts:140`_
`pendingApproval?`	`{ nodeId: string; prompt: string; options: string[]; requestedAt: string }`	— _ `types/workflow.ts:141`_
`output?`	`unknown`	— _ `types/workflow.ts:147`_
`usage?`	`WorkflowUsage`	— _ `types/workflow.ts:148`_
`threadId`	`string`	— _ `types/workflow.ts:149`_
`startedAt`	`string`	— _ `types/workflow.ts:150`_
`endedAt?`	`string`	— _ `types/workflow.ts:151`_
`createdAt`	`string`	— _ `types/workflow.ts:152`_
`updatedAt`	`string`	— _ `types/workflow.ts:153`_

`CreateWorkflowInput`

Source: types/workflow.ts:156

Interface

Field	Type	Description
`name`	`string`	— _ `types/workflow.ts:157`_
`description?`	`string`	— _ `types/workflow.ts:158`_
`visibility?`	`WorkflowVisibility`	— _ `types/workflow.ts:159`_
`isEnabled?`	`boolean`	— _ `types/workflow.ts:160`_
`draft?`	`WorkflowDraft`	— _ `types/workflow.ts:161`_

`UpdateWorkflowInput`

Source: types/workflow.ts:164

Interface

Field	Type	Description
`name?`	`string`	— _ `types/workflow.ts:165`_
`description?`	`string`	— _ `types/workflow.ts:166`_
`visibility?`	`WorkflowVisibility`	— _ `types/workflow.ts:167`_
`isEnabled?`	`boolean`	— _ `types/workflow.ts:168`_
`draft?`	`WorkflowDraft`	— _ `types/workflow.ts:169`_

`DiscoverWorkflowsParams`

Source: types/workflow.ts:172

Interface

Field	Type	Description
`page?`	`number`	— _ `types/workflow.ts:173`_
`limit?`	`number`	— _ `types/workflow.ts:174`_
`search?`	`string`	— _ `types/workflow.ts:175`_
`scope?`	`"mine" \| "public" \| "all"`	— _ `types/workflow.ts:176`_
`visibility?`	`WorkflowVisibility`	— _ `types/workflow.ts:177`_
`isEnabled?`	`boolean`	— _ `types/workflow.ts:178`_

`ListWorkflowRunsParams`

Source: types/workflow.ts:181

Interface

Field	Type	Description
`page?`	`number`	— _ `types/workflow.ts:182`_
`limit?`	`number`	— _ `types/workflow.ts:183`_
`status?`	`WorkflowRunStatus`	— _ `types/workflow.ts:184`_
`isDryRun?`	`boolean`	— _ `types/workflow.ts:185`_

`ListWorkflowVersionsParams`

Source: types/workflow.ts:188

Interface

Field	Type	Description
`page?`	`number`	— _ `types/workflow.ts:189`_
`limit?`	`number`	— _ `types/workflow.ts:190`_

`RunWorkflowOptions`

Source: types/workflow.ts:193

Interface

Field	Type	Description
`input?`	`unknown`	— _ `types/workflow.ts:194`_
`dryRun?`	`boolean`	— _ `types/workflow.ts:195`_
`version?`	`number`	— _ `types/workflow.ts:196`_
`signal?`	`AbortSignal`	— _ `types/workflow.ts:197`_

`WorkflowRunResult`

Source: types/workflow.ts:200

Interface

Field	Type	Description
`runId`	`string`	— _ `types/workflow.ts:201`_
`threadId`	`string`	— _ `types/workflow.ts:202`_
`status`	`WorkflowRunStatus`	— _ `types/workflow.ts:203`_
`isDryRun`	`boolean`	— _ `types/workflow.ts:204`_
`output`	`unknown`	— _ `types/workflow.ts:205`_
`usage?`	`WorkflowUsage`	— _ `types/workflow.ts:206`_
`nodeRuns`	`Record<string, NodeRun>`	— _ `types/workflow.ts:207`_
`events`	`WorkflowStreamEvent[]`	— _ `types/workflow.ts:208`_

`WorkflowStreamEvent`

Source: types/workflow.ts:211

Kind 2097152

voice — @personaai/sdk