Skip to main content
POST
/
storage
/
models
/
preview
Preview model
curl --request POST \
  --url https://api.getcargo.io/v1/storage/models/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "datasetUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "config": {}
}
'
{
  "outcome": "<string>",
  "records": [
    {}
  ],
  "columns": [
    "<unknown>"
  ]
}

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.

​
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})$
​
slug
string
required

Model slug.

​
config
Config · object
required

Model configuration.

Response

Successful response

​
outcome
string
required

Preview outcome.

Allowed value: "previewed"
​
records
Records · object[]
required

Preview records.

​
columns
any[]
required

Preview columns.