Skip to main content
POST
/
api
/
airbyte
/
ingest
Create PyAirbyte ingestion job
curl --request POST \
  --url https://api.example.com/api/airbyte/ingest \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "source_name": "<string>",
  "source_config": {},
  "schema_name": "<string>",
  "streams": [
    "<string>"
  ],
  "merge": "<string>",
  "schedule": "<string>",
  "domain": "<string>",
  "tags": [
    "<string>"
  ],
  "owner_id": "<string>",
  "column_transformations": [
    {
      "column": "<string>",
      "stream": "<string>",
      "new_name": "<string>",
      "encryption_key_name": "<string>"
    }
  ],
  "archive_staging": true,
  "add_ingestion_metadata": true
}
'
{
  "flow_url": "<string>",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Request model for creating an Airbyte ingestion job.

​
name
string
required

Name of the ingestion job.

​
source_name
string
required

PyAirbyte source identifier. For example, 'source-github'.

​
source_config
Source Config · object
required

Source configuration key-value pairs, including secrets.

​
schema_name
string
required

Target Iceberg schema where tables will be created.

​
mode
enum<string>
required

Write mode.

Available options:
append,
overwrite,
merge
​
streams
string[] | null

Optional list of streams to sync. If empty, NexusOne syncs all streams.

​
merge
string | null

Comma-separated merge key columns. If omitted for merge mode, Airbyte primary keys are used.

​
schedule
string | null

Cron expression for scheduled runs.

​
domain
string | null

DataHub domain to assign to ingested tables.

​
tags
string[] | null

DataHub tags to assign to ingested tables.

​
owner_id
string | null

Owner user ID.

​
column_transformations
ColumnTransformation · object[] | null

Optional per-stream column transformations. Use the 'stream' field on each transformation to target a specific stream.

​
archive_staging
boolean
default:true

Archive staging files to archive/{run_id}/ instead of deleting them after ingestion.

​
add_ingestion_metadata
boolean
default:true

Add ingestion metadata columns (ingestion_time, ingestion_run_id, ingestion_mode, dag_job_id) to output tables.

Response

Ingestion job created successfully.

​
flow_url
string
required

Airflow URL to access the ingestion flow.

​
job_id
string<uuid> | null

A unique ID of the created ingestion job.

​
error
string | null

Error message if the ingestion fails due to any issue.