Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

Default authentication mechanism

Headers

x-tenant-id
string

Optional tenant id to use for the request. If not provided, the namespace will be used directly. Must be alphanumeric and up to 64 characters.

Pattern: ^[A-Za-z0-9]{1,64}$

Path Parameters

namespaceId
string
required

The id of the namespace (prefixed with ns_)

Example:

"ns_123"

Query Parameters

statuses
enum<string>[]

Comma separated list of statuses to filter by.

The status of the document.

Available options:
BACKLOG,
QUEUED,
QUEUED_FOR_RESYNC,
QUEUED_FOR_DELETE,
PRE_PROCESSING,
PROCESSING,
DELETING,
CANCELLING,
COMPLETED,
FAILED,
CANCELLED
orderBy
enum<string>
default:createdAt

The field to order by. Default is createdAt.

Available options:
createdAt
order
enum<string>
default:desc

The order to sort by. Default is desc.

Available options:
asc,
desc
ingestJobId
string

The ingest job ID to filter documents by.

cursor
string

The cursor to paginate by.

cursorDirection
enum<string>
default:forward

The direction to paginate by.

Available options:
forward,
backward
perPage
number
default:30

The number of records to return per page.

Required range: 1 <= x <= 100

Response

The retrieved ingest jobs

success
boolean
required
data
Document · object[]
required
pagination
object
required