Invoke Skill Workstream Describe

post/api/v1/skills/workstream.describe/invoke

Describe a workstream by id, slug, or permakey. Returns the full definition: metadata, execution_mode, declared inputs, and step count. The adapter resolves the literal across both inline and containerized execution modes.

Request bodyapplication/json

Field	Type	Description
`workstream_id`required	`string`	UUID, slug, or 7-char permakey. The adapter resolves it.

Responses

200Skill executed successfully

Field Type Description

skillrequired string —

outputrequired

object

Full definition of a workstream — metadata + step graph.

show nested

Field	Type	Description
`stub_fields`	`string[]`	—
`warnings`	`string[]`	—
`workstream_id`	`string (uuid) \| null`	Stable internal id.
`permakey`	`string`	7-char human-friendly id.
`name`	`string`	Display name.
`description`	`string \| null`	One-paragraph overview.
`execution_mode`	`"inline" \| "containerized"`	`inline` (Temporal declarative) or `containerized` (Fly.io agentic). `inlinecontainerized`
`status`	`"draft" \| "active" \| "archived"`	Lifecycle state. `draftactivearchived`
`step_count`	`integer`	Number of declared steps in the workstream graph.
`inputs_required`	`object[]`	Declaration of every input the caller can or must supply via `runtime_vars` when starting a cycle. Each entry follows the `WorkstreamInputSpec` shape (name, type, required, description, default) but is wire-typed as a JSON object for backward compatibility with stored authoring metadata. Empty for client-agnostic workstreams that take no runtime inputs. item shape Empty object.
`error`	`string \| null`	—
`error_envelope`	`any \| null`	Canonical structured error. Set when describe failed (e.g. workstream not found, FGA denied). The legacy `error` string field is populated alongside it for back-compat.

correlation_idrequired string —

401Authentication required

Field Type Description

errorrequired

object

—

show nested

Field	Type	Description
`type`required	`string`	—
`code`required	`string`	—
`message`required	`string`	—
`param`	`string`	—
`retry_after_seconds`	`integer`	—

403Insufficient permissions

Field Type Description

errorrequired

object

—

show nested

Field	Type	Description
`type`required	`string`	—
`code`required	`string`	—
`message`required	`string`	—
`param`	`string`	—
`retry_after_seconds`	`integer`	—

404Skill not found

Field Type Description

errorrequired

object

—

show nested

Field	Type	Description
`type`required	`string`	—
`code`required	`string`	—
`message`required	`string`	—
`param`	`string`	—
`retry_after_seconds`	`integer`	—

429Rate limit exceeded

Field Type Description

errorrequired

object

—

show nested

Field	Type	Description
`type`required	`string`	—
`code`required	`string`	—
`message`required	`string`	—
`param`	`string`	—
`retry_after_seconds`	`integer`	—

5XXInternal server error

Field Type Description

errorrequired

object

—

show nested

Field	Type	Description
`type`required	`string`	—
`code`required	`string`	—
`message`required	`string`	—
`param`	`string`	—
`retry_after_seconds`	`integer`	—

curl https://api.dev.arch.ie/api/v1/skills/workstream.describe/invoke \
  -X POST \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
       "workstream_id": "string"
     }'