## Documentation Index

Fetch the complete documentation index at: [/llms.txt](https://docs.gable.ai/llms.txt)

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

POST

/
v0

/sca-metadata

Try it

Register sca metadata for a data asset version

### cURL

```
curl --request POST \
  --url https://demo-api.gable.ai/v0/sca-metadata/ingest \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '\n{\n  "metadata": {},\n  "dataAssetResourceName": "<string>"\n}\n'
```

### Python

```
import requests

url = "https://demo-api.gable.ai/v0/sca-metadata/ingest"

payload = {
    "metadata": {},
    "dataAssetResourceName": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

### JavaScript (Fetch)

```
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({metadata: {}, dataAssetResourceName: '<string>'})
};

fetch('https://demo-api.gable.ai/v0/sca-metadata/ingest', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

### PHP

```
<?php

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://demo-api.gable.ai/v0/sca-metadata/ingest",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "POST",\
  CURLOPT_POSTFIELDS => json_encode([\
    'metadata' => [\
\
    ],\
    'dataAssetResourceName' => '<string>'\
  ]),\
  CURLOPT_HTTPHEADER => [\
    "Content-Type: application/json",\
    "X-API-KEY: <api-key>"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

### Go

```
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

url := "https://demo-api.gable.ai/v0/sca-metadata/ingest"

payload := strings.NewReader("{\n  \"metadata\": {},\n  \"dataAssetResourceName\": \"<string>\"}\n")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}
```

### Java (Unirest)

```
HttpResponse<String> response = Unirest.post("https://demo-api.gable.ai/v0/sca-metadata/ingest")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {},\n  \"dataAssetResourceName\": \"<string>\"}\n")
  .asString();
```

### Ruby

```
require 'uri'
require 'net/http'

url = URI("https://demo-api.gable.ai/v0/sca-metadata/ingest")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {},\n  \"dataAssetResourceName\": \"<string>\"}\n"

response = http.request(request)
puts response.read_body
```

### Status Codes

- **200** 
- **400** 
- **500**

### Sample Responses

```json
{
  "newVersionCreated": true
}
```

```json
{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}
```

```json
{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}
```

### Authorizations

**X-API-KEY**  
string  
header  
required

### Body

**application/json**  
Upload metadata tied to data asset

- **metadata**  
object  
required

- **dataAssetResourceName**  
string  
required  
The unique identifier of the data asset. It follows the pattern '{data_asset_type}://{data_asset_source}:{data_asset_name}'  
Pattern: `^(protobuf|avro|json_schema|java|postgres|mysql|mssql|snowflake|bigquery|python|pyspark|typescript|s3|dataframe|kotlin|swift|php)://(?=.*[a-zA-Z0-9])[a-zA-Z0-9_@:.\/-]+[:/](?=.*[a-zA-Z0-9])[a-zA-Z0-9 _\./-\\{}-]+$`

### Response

**200**  
application/json  
Sca Metadata Registration Response

- **newVersionCreated**  
boolean  
Indicates whether a new version was created