Skip to main content
POST
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"

Body

application/json
payload
Text Payload · object
required

The ingest job payload for creation.

name
string | null

The name of the ingest job.

config
object

The ingest job config.

externalId
string | null

A unique external ID of the ingest job. You can use this to identify the ingest job in your system.

Response

The created ingest job

success
boolean
required
data
Ingest Job · object
required