Create model

Create a new model

POST /storage/models

Create model

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/storage/models \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "<string>",
  "name": "<string>",
  "datasetUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "extractorSlug": "<string>",
  "config": {},
  "description": "<string>",
  "schedule": {
    "type": "<string>",
    "jobId": "<string>"
  },
  "folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.getcargo.io/v1/storage/models"

payload = {
    "slug": "<string>",
    "name": "<string>",
    "datasetUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "extractorSlug": "<string>",
    "config": {},
    "description": "<string>",
    "schedule": {
        "type": "<string>",
        "jobId": "<string>"
    },
    "folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    slug: '<string>',
    name: '<string>',
    datasetUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    extractorSlug: '<string>',
    config: {},
    description: '<string>',
    schedule: {type: '<string>', jobId: '<string>'},
    folderUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.getcargo.io/v1/storage/models', 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",
  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([
    'slug' => '<string>',
    'name' => '<string>',
    'datasetUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'extractorSlug' => '<string>',
    'config' => [
        
    ],
    'description' => '<string>',
    'schedule' => [
        'type' => '<string>',
        'jobId' => '<string>'
    ],
    'folderUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.getcargo.io/v1/storage/models"

	payload := strings.NewReader("{\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"datasetUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"extractorSlug\": \"<string>\",\n  \"config\": {},\n  \"description\": \"<string>\",\n  \"schedule\": {\n    \"type\": \"<string>\",\n    \"jobId\": \"<string>\"\n  },\n  \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

HttpResponse<String> response = Unirest.post("https://api.getcargo.io/v1/storage/models")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"datasetUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"extractorSlug\": \"<string>\",\n  \"config\": {},\n  \"description\": \"<string>\",\n  \"schedule\": {\n    \"type\": \"<string>\",\n    \"jobId\": \"<string>\"\n  },\n  \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/storage/models")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"datasetUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"extractorSlug\": \"<string>\",\n  \"config\": {},\n  \"description\": \"<string>\",\n  \"schedule\": {\n    \"type\": \"<string>\",\n    \"jobId\": \"<string>\"\n  },\n  \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

200

{
  "model": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "slug": "<string>",
    "name": "<string>",
    "description": "<string>",
    "datasetUuid": "<string>",
    "extractorSlug": "<string>",
    "position": {
      "x": 123,
      "y": 123
    },
    "config": {},
    "schedule": {
      "type": "<string>",
      "jobId": "<string>"
    },
    "meta": {},
    "columns": [
      {
        "slug": "<string>",
        "label": "<string>",
        "kind": "<string>",
        "originalSlug": "<string>",
        "properties": [
          "<string>"
        ],
        "description": "<string>"
      }
    ],
    "additionalColumns": [
      {
        "slug": "<string>",
        "label": "<string>",
        "kind": "<string>",
        "properties": [
          "<string>"
        ],
        "description": "<string>"
      }
    ],
    "idColumnSlug": "<string>",
    "unification": {
      "source": "<string>"
    },
    "titleColumnSlug": "<string>",
    "timeColumnSlug": "<string>",
    "folderUuid": "<string>",
    "playsCount": 123,
    "segmentsCount": 123,
    "isPaused": true,
    "lastEmittedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "lastRun": {
      "uuid": "<string>",
      "errorMessage": "<string>",
      "createdAt": "<string>",
      "finishedAt": "<string>"
    },
    "kind": "<string>",
    "connectorUuid": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

slug · string · required

Model slug.

Pattern: ^[a-z0-9]+(_[a-z0-9]+)*$

name · string · required

Model name.

datasetUuid · string<uuid> · required

Dataset identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

extractorSlug · string · required

Extractor identifier.

config · Config · object · required

Model configuration.

Show child attributes

description · string

Model description.

schedule · Schedule · object

Model schedule configuration.

Schedule

Schedule

Show child attributes

folderUuid · string<uuid>

Folder identifier. Only compatible with nativeIntegration define extractors.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

200

application/json

Successful response

model · Model · object · required

Created model details.

Model

Model

Show child attributes