Skip to main content
POST
/
v0
/
data-asset
/
register
/
s3
Register an S3 data asset
curl --request POST \
  --url https://{hostname}.gable.ai/v0/data-asset/register/s3 \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "assets": [
    {
      "schema": {
        "name": "<string>",
        "fields": [
          {
            "name": "<string>",
            "fields": "<array>",
            "alias": "<string>",
            "doc": "<string>",
            "logical": "<string>",
            "optional": true
          }
        ],
        "alias": "<string>",
        "doc": "<string>",
        "logical": "<string>"
      },
      "pattern": "<string>",
      "bucket": "<string>",
      "fieldNameToDataAssetFieldProfileMap": {}
    }
  ],
  "dry_run": 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

S3 Data Asset Registration Request

​
assets
object[]
required

Array of data assets to register

​
dry_run
boolean
default:false

If true, no data asset will be registered

​
prLink
string | null

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