Skip to main content
GET
Rate limit tier: general, 600 requests/min. See Rate limits. Returns a presigned URL for a workflow’s whole knowledge corpus, packaged as a tar. Prefer List and Read for anything that stays inside this API — this endpoint exists for handing the whole archive to something outside it. Possession of the URL is read permission for the workflow’s corpus until it expires. The URL is not scoped to your API key: whoever holds it can fetch the tar, and revoking the key that requested it does not revoke a URL already minted. expires_in_seconds (900, 15 minutes) is the only bound. The URL can 404 if a newer snapshot replaced it or the workflow was deleted meanwhile — mint a fresh one rather than caching it past its TTL.

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. Unlike ask, downloading is never billed, so 402 cannot occur here.

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

Response

Successful Response

A presigned URL to the whole knowledge corpus tar for a workflow.

corpus_version
string
required

Version identifier of the snapshot this URL points to.

url
string
required

Presigned GET URL for the corpus tar.

size_bytes
integer
required

Size of the tar in bytes.

document_count
integer
required

Number of documents in the corpus.

built_at
string<date-time>
required

When this snapshot was built.

expires_in_seconds
integer
required

TTL of url from the moment of this response.