Skip to main content
GET
Rate limit tier: general, 600 requests/min. See Rate limits. Lists a workflow’s knowledge corpus: every source document plus the generated navigation pages, sorted by path. This is the tree an agent would browse instead of asking a question — for reading what documents exist and where, not for an answer. To ask a question with citations, use Ask. Each item’s kind is document for a source file or index for a generated navigation page; a navigation page’s page_count is always 0.

Requires a knowledge base

Same requirement as ask: the workflow needs a knowledge node, or this returns 409 KNOWLEDGE_NOT_ENABLED. 409 KNOWLEDGE_NOT_READY means no usable snapshot has ever been published — wait if indexing is in progress. Unlike ask, listing is never billed, so 402 cannot occur here.

Pagination

One keyset page per call, sorted by path. Follow next_cursor until it is null. See Pagination.

Folder

Pass folder to narrow the tree to entries directly inside that folder or one beneath it. Omit it for the whole corpus.

Errors

Authorizations

Authorization
string
header
required

API key issued from app.anyformat.ai/api-key. Send as Authorization: Bearer <key>.

Path Parameters

workflow_id
string
required

Query Parameters

folder
string | null

Only list entries directly in this folder or a folder beneath it; omit for the whole tree.

cursor
string | null

Opaque token from a previous response's next_cursor.

Response

Successful Response

One page of a workflow's knowledge corpus tree.

items
KnowledgeEntryV3 · object[]
required

Entries on this page.

next_cursor
string | null

Opaque token to fetch the next page; pass it back as ?cursor=. null on the last page.