Skip to main content
POST
/
storage
/
models
Create model
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"
}
'
{
  "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>"
  }
}

Documentation Index

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

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

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.

​
description
string

Model description.

​
schedule
Schedule · object

Model schedule configuration.

​
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

Successful response

​
model
Model · object
required

Created model details.