Developers and governance · Autessa Synthetic Data

Synthetic data REST API

The Autessa Synthetic Data REST API lets your own code generate data with an Autessa API key. Generate rows on demand, propose schemas, and create, review and export dataset file jobs from tests, CI pipelines and internal tools.

A core synthetic data capability, done properly

Start free

REST · API keySAMPLE

POST /clients/synthetic-data/generate
POST /clients/synthetic-data/schema/propose
POST /clients/synthetic-data/jobs
GET  /clients/synthetic-data/jobs
GET  /clients/synthetic-data/jobs/{jobId}
GET  /clients/synthetic-data/jobs/{jobId}/preview
GET  /clients/synthetic-data/jobs/{jobId}/export
POST /clients/synthetic-data/jobs/{jobId}/approve
     … /discard  /cancel  /append  /exclude-rows  /regenerate-batch

The problem

Fixtures go stale

Checked-in fixture files drift away from the real schema and get reused until every test sees the same twelve customers. Generating fresh, valid data at test time keeps tests honest.

What you get

Endpoints under https://api.autessa.com/clients/synthetic-data, authenticated with the Authorization header.
POST /generate returns up to 50 rows in the response.
POST /schema/propose drafts columns from a description.
POST /jobs starts a job; with an API key, jobs produce dataset files.
GET /jobs/{jobId} for status and batches, GET /jobs/{jobId}/export for the download link.
Review endpoints for approve, discard, cancel, append, exclude-rows and regenerate-batch.

How it works

How does synthetic data REST API work?

Create an API key
Create a key for your company in Autessa (see the API keys guide).
Call generate or create
Send a description and columns to /generate for small sets, or to /jobs for up to 5,000 rows.
Poll the job
Call GET /jobs/{jobId} until it is final.
Download
Call GET /jobs/{jobId}/export and download the file from the returned link.

Every option

Endpoints

Option	What it does
POST /clients/synthetic-data/generate	Rows back directly (1 to 50).
POST /clients/synthetic-data/schema/propose	Draft columns from a description.
POST /clients/synthetic-data/jobs	Start a background job (dataset file by default).
GET /clients/synthetic-data/jobs	Your company’s jobs, newest first.
GET /clients/synthetic-data/jobs/{jobId}	Status, progress and batches.
GET /clients/synthetic-data/jobs/{jobId}/preview?batchIndex=	Staged rows (review mode).
GET /clients/synthetic-data/jobs/{jobId}/export	Temporary download link for the file.
POST /clients/synthetic-data/jobs/{jobId}/…	approve, discard, cancel, append, exclude-rows, regenerate-batch.

Example

Generate rows with one request

Replace the ids with your own.

POST /clients/synthetic-data/generateEXAMPLE

curl https://api.autessa.com/clients/synthetic-data/generate \
  -H "Authorization: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Support tickets for a meal-kit delivery company",
    "rowCount": 10,
    "columnDefinitions": [
      {"columnName": "subject", "columnType": "SHORT_TEXT", "required": true},
      {"columnName": "channel", "columnType": "SINGLE_SELECT",
       "allowedValues": ["Email", "Chat", "Phone"]}
    ]
  }'

# → { "rows": [ ... ], "rowCount": 10, "rejectedRowCount": 1 }

Permissions

Who can do what?

Who	Can
API keys	Can run quick generate, propose schemas and run dataset file jobs. Table targets need a signed-in person.
Signed-in people	Use the app or CLI to target tables, since table writes use a person’s permissions.

Connected

How synthetic data REST API connects to the rest of Autessa

SYNTHETIC DATA FEATURE

CLI

The same operations from a terminal.

SYNTHETIC DATA FEATURE

Dataset files

What API jobs produce.

AUTESSA PLATFORM

Autessa API

API keys and the rest of the Autessa API.

FAQ

Questions about synthetic data REST API

Why can’t an API key fill a table?

Table writes use a signed-in person’s table permissions. With an API key, generate a dataset file (the default) or use `/generate` to get rows back directly.

How do I authenticate?

Send your Autessa API key in the Authorization header, as with the rest of the Autessa REST API.

Are API jobs visible in the app?

Yes. Jobs belong to the company, so API-created jobs appear in the Synthetic Data list too.

Also in Developers and governance:Synthetic data CLI Your model and PII stripping

Try synthetic data REST API in Autessa Synthetic Data

The Autessa Synthetic Data REST API lets code with an API key generate rows, propose schemas and run dataset file jobs.

Start free

Describe it · review it · write it · or download JSONL and CSV

100% customizable, code and all

Make Autessa Synthetic Data fully your own.

Use it out of the box, then change anything. Ask Autobot, Autessa’s AI builder, for a new field, screen, report, workflow or agent and it builds it into your copy of the app. Or open the code and edit it yourself. Nothing is locked: the app, its data and its code are yours.

Start free and make it yours