Skip to main content
POST
/
api
/
dataframer
/
analyze
JavaScript
import Dataframer from 'dataframer';

const client = new Dataframer({
  apiKey: 'My API Key',
});

const analyze = await client.dataframer.analyze.create({
  dataset_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  name: 'name',
});

console.log(analyze.datasets_id);
{
  "name": "<string>",
  "datasets_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "latest_version": -1,
  "status": "PROCESSING",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "dataset_name": "<string>",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_name": "<string>",
  "created_by": 123,
  "created_by_name": "<string>",
  "versions": [
    {
      "spec_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": -1,
      "config_yaml": "<string>",
      "results_yaml": "<string>",
      "orig_results_yaml": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "spec_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "runtime_params": {}
    }
  ],
  "version_count": 123,
  "latest_version_data": "<string>",
  "data_property_variations": "<string>"
}

Authorizations

Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Body

application/json
dataset_id
string<uuid>
required

ID of the dataset to analyze

name
string
required

Name for the new spec to be created

description
string
default:""

Description of the spec

analysis_model_name
enum<string>
default:anthropic/claude-sonnet-4-5

AI model to use for analysis

Available options:
anthropic/claude-sonnet-4-5,
anthropic/claude-sonnet-4-5-thinking,
anthropic/claude-haiku-4-5,
deepseek-ai/DeepSeek-V3.1,
moonshotai/Kimi-K2-Instruct,
openai/gpt-oss-120b,
deepseek-ai/DeepSeek-R1-0528-tput,
Qwen/Qwen2.5-72B-Instruct-Turbo
generate_distributions
boolean
default:true

Generate statistical distributions from the data

extrapolate_values
boolean
default:true

Extrapolate new values beyond existing data ranges

extrapolate_axes
boolean
default:false

Extrapolate to new axes/dimensions

use_truncation
boolean
default:false

Apply truncation to limit value ranges

generation_objectives
string
default:""

Custom objectives or instructions for data generation

Response

Spec created successfully

name
string
required
Minimum string length: 1
datasets_id
string<uuid>
required
id
string<uuid>
description
string | null
latest_version
integer
Required range: -2147483648 <= x <= 2147483647
status
enum<string>
Available options:
PROCESSING,
READY,
FAILED
created_at
string<date-time>
updated_at
string<date-time>
dataset_name
string
Minimum string length: 1
company_id
string<uuid>
company_name
string
Minimum string length: 1
created_by
integer | null
created_by_name
string
Minimum string length: 1
versions
object[]
version_count
integer
latest_version_data
string
data_property_variations
string