Workbench API reference

Run flows, browse the public gallery, fork public flows into your workspace, manage + search knowledge bases, and fetch the weights for shims you've published. Authentication, key management, and the shared error envelope live in API setup. New to the model? Start with Flows.

Base URL

https://api.zerowidth.ai/1.0

All endpoints return JSON. All requests require a bearer token. See Authentication for the key format + how to mint one.

Endpoints

Run a flowPOST /1.0/flows/:flowUuid/runs

Execute a flow synchronously or stream it. Returns outputs + cost + timeline. Scope: workbench:flows:run.

List public flowsGET /1.0/flows/public

Browse the public gallery, newest first. Anonymous, cursor-paged.

Read a public flowGET /1.0/flows/public/:flowUuid

Read one public flow's metadata + full definition. Anonymous.

Fork a public flowPOST /1.0/flows/:flowUuid/fork

Copy a public flow into your workspace. Scope: workbench:flows:write (Personal key).

List knowledge basesGET /1.0/knowledge-bases

Every knowledge base in the key's workspace. Scope: workbench:knowledge_bases:read.

Read a knowledge baseGET /1.0/knowledge-bases/:id

One knowledge base in full — status, counts, ingestion settings. Scope: workbench:knowledge_bases:read.

Create a knowledge basePOST /1.0/knowledge-bases

Create an empty docs / tabular / graph knowledge base. Scope: workbench:knowledge_bases:write.

Add documentsPOST /1.0/knowledge-bases/:id/documents

Upload text or base64 PDF/DOCX sources; ingestion runs in the background. Scope: workbench:knowledge_bases:write.

Search a knowledge basePOST /1.0/knowledge-bases/:id/search

Semantic or keyword retrieval over one knowledge base. Scope: workbench:knowledge_bases:search.

List shimsGET /1.0/shims

Every shim in the key's workspace, with its published version and accuracy. Scope: workbench:shims:read.

Read a shimGET /1.0/shims/:id

One shim's question and answers. Scope: workbench:shims:read.

Fetch weightsGET /1.0/shims/:id/weights

The published version's weights file, at a URL that stays put across publishes. Scope: workbench:shims:read.

2 min read