List models
curl --request GET \
--url https://api.getcargo.io/v1/storage/models/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getcargo.io/v1/storage/models/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getcargo.io/v1/storage/models/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getcargo.io/v1/storage/models/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getcargo.io/v1/storage/models/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getcargo.io/v1/storage/models/list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/storage/models/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"models": [
{
"uuid": "<string>",
"workspaceUuid": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"datasetUuid": "<string>",
"extractorSlug": "<string>",
"position": {
"x": 123,
"y": 123
},
"config": {},
"schedule": {
"type": "dbt",
"jobId": "<string>"
},
"meta": {},
"columns": [
{
"slug": "<string>",
"type": "string",
"label": "<string>",
"kind": "original",
"originalSlug": "<string>",
"properties": [
"<string>"
],
"description": "<string>"
}
],
"additionalColumns": [
{
"slug": "<string>",
"type": "string",
"label": "<string>",
"kind": "custom",
"properties": [
"<string>"
],
"description": "<string>"
}
],
"idColumnSlug": "<string>",
"unification": {
"source": "integration"
},
"titleColumnSlug": "<string>",
"timeColumnSlug": "<string>",
"folderUuid": "<string>",
"playsCount": 123,
"segmentsCount": 123,
"isPaused": true,
"lastEmittedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"lastRun": {
"uuid": "<string>",
"status": "pending",
"errorMessage": "<string>",
"createdAt": "<string>",
"finishedAt": "<string>"
},
"kind": "connector",
"connectorUuid": "<string>"
}
]
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Storage - Models
List models
List all models in the workspace (GET /storage/models/list).
GET
/
storage
/
models
/
list
List models
curl --request GET \
--url https://api.getcargo.io/v1/storage/models/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getcargo.io/v1/storage/models/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getcargo.io/v1/storage/models/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getcargo.io/v1/storage/models/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getcargo.io/v1/storage/models/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getcargo.io/v1/storage/models/list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/storage/models/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"models": [
{
"uuid": "<string>",
"workspaceUuid": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"datasetUuid": "<string>",
"extractorSlug": "<string>",
"position": {
"x": 123,
"y": 123
},
"config": {},
"schedule": {
"type": "dbt",
"jobId": "<string>"
},
"meta": {},
"columns": [
{
"slug": "<string>",
"type": "string",
"label": "<string>",
"kind": "original",
"originalSlug": "<string>",
"properties": [
"<string>"
],
"description": "<string>"
}
],
"additionalColumns": [
{
"slug": "<string>",
"type": "string",
"label": "<string>",
"kind": "custom",
"properties": [
"<string>"
],
"description": "<string>"
}
],
"idColumnSlug": "<string>",
"unification": {
"source": "integration"
},
"titleColumnSlug": "<string>",
"timeColumnSlug": "<string>",
"folderUuid": "<string>",
"playsCount": 123,
"segmentsCount": 123,
"isPaused": true,
"lastEmittedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"lastRun": {
"uuid": "<string>",
"status": "pending",
"errorMessage": "<string>",
"createdAt": "<string>",
"finishedAt": "<string>"
},
"kind": "connector",
"connectorUuid": "<string>"
}
]
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Authorizations
bearerAuthoauth2
API token from cargo-ai login. Send as Authorization: Bearer <token>.
Query Parameters
Filter models by dataset identifier.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Response
List models
List of models.
- Option 1
- Option 2
Show child attributes
Show child attributes
Was this page helpful?