Workflows

Two read-only operations read the workflows of the workspace environment the call is made in. data.workflows.list lists them. data.workflows.get reads one workflow: its summary and an outline of its blocks. Neither returns a block's configuration.

import { createHttpPlatformTransport, createScrydonSDK } from '@scrydon/sdk/platform'

const platform = createScrydonSDK(
  createHttpPlatformTransport({
    baseUrl: 'https://scrydon.com',
    headers: () => ({ authorization: `Bearer ${accessToken}` }),
  })
)

const { workflows, truncated } = await platform.data.workflows.list({ limit: 20 })

const { found, workflow } = await platform.data.workflows.get({
  workflowId: workflows[0].id,
})

Over HTTP, both need the tools:read scope. They are read-only and safe to retry.

In a workflow, select the Scrydon tools List workflows and Read a workflow in an Agent block's tools. Inside a Scrydon tool, the same operations are ctx.data.workflows.list and ctx.data.workflows.get. Only the Scrydon workflow tools may call them; another extension's tool is refused. Cortex runs both tools without asking for approval, in any room, because they only read.

Who sees what

Neither input names a workspace or an environment. The workspace environment is the one the call is made in: for a tool, the run's own. The workflow service then decides each read for the person the call is made for, with the same rules as the workflow editor. Someone who cannot open a workflow in the editor cannot read it here.

Only workflows the editor lists in that environment are returned. Automations and the workflows internal to a process flow are not.

List

The result is { workflows, truncated }. The workflows are most recently changed first, so the limit leaves out the ones changed longest ago. Each has id, name, description (when set), isDeployed, deployedAt (when deployed), createdAt, updatedAt, lastRunAt (when it has run) and runCount. Times are ISO 8601. truncated is true when the environment holds more workflows than limit.

Get

The result is { found, workflow }. found is false, with no workflow, when the workflow does not exist, is in another environment, is not the person's to read, or is internal to a process flow. The four look the same on purpose.

workflow is the list's summary plus:

• blocks: each block's id, type and name, at most 200. blocksTruncated is true when the workflow has more.
• edgeCount: how many connections join the blocks.

A block's settings, prompts, endpoints and credential references are never returned.

@scrydon/sdk/platform exports the bounds (WORKFLOWS_LIST_LIMIT_DEFAULT, WORKFLOWS_LIST_LIMIT_MAX, WORKFLOWS_GET_BLOCKS_MAX, WORKFLOW_ID_MAX_CHARS). Unknown fields, including a workspace or environment field, are refused.

Errors