Skip to main content
GET
Read a bounded chunk of existing extracted text

Authorizations

Authorization
string
header
required

Effective API key. Send Authorization: Bearer sk-eai-...

Path Parameters

fileId
string<uuid>
required

Query Parameters

maxBytes
integer
default:16384

Maximum UTF-8 bytes of text per response, 4–65536 (default 16384). Character boundaries may shorten a chunk. Repeat unchanged with cursor.

Required range: 4 <= x <= 65536
cursor
string

Opaque nextCursor. Fixed 24-hour lifetime; bound to caller scope, file, maxBytes and text revision.

Required string length: 1 - 128

Response

A revision-bound text chunk with byte location and continuation.

fileId
string<uuid>
required
textRevision
string
required

Opaque identity of this extracted-text revision, distinct from an original-file version. Changed text invalidates continuation.

Maximum string length: 68
versionId
string | null
required

Source file version that produced this extraction, or null when unproven. Currently null; never inferred from the current download.

text
string
required

Existing UTF-8 extracted text, at most maxBytes UTF-8 bytes. Empty available text is a successful terminal response. Page markers, if present, remain in text.

Maximum string length: 65536
location
object
required
nextCursor
string | null
required

Continue with the same file and maxBytes, or null at the end. Retry the same request safely; deduplicate by revision and start offset.