Skip to main content
POST
/
v0
/
data-asset
/
ingest
Ingest a data asset from a schema
curl --request POST \
  --url https://{hostname}.gable.ai/v0/data-asset/ingest \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "sourceType": "postgres",
  "sourceNames": [
    "<string>"
  ],
  "databaseSchema": "<string>",
  "schema": [
    "<string>"
  ],
  "dryRun": false,
  "prLink": "https://github.com/fakeorg/fakerepo/pull/123"
}
'
{
  "message": "<string>",
  "registered": [
    "<string>"
  ],
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.gable.ai/llms.txt

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

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Data Asset Schema

​
sourceType
enum<string>
required

The type of the source data asset, indicating its source or format (e.g., postgres, protobuf).

Available options:
postgres,
mysql,
mssql,
json_schema,
avro,
protobuf,
python,
pyspark,
typescript,
java,
s3,
dataframe,
kotlin,
swift,
php,
golang
​
sourceNames
string[]
required

The names of the sources

​
databaseSchema
string
required

The name of the database schema

​
schema
string[]
required

Array of schemas. Each schema could be from a db information schema or the contents of a schema file.

​
dryRun
boolean
default:false

If true, no data asset will be registered

​
prLink
string

Link to the PR that may have added or edited the data assets

Example:

"https://github.com/fakeorg/fakerepo/pull/123"

Response

Data Asset ID

​
message
string
required

Response message

​
registered
string[]
required

List of the registered data asset ids

​
success
boolean
required

Whether the request was successful