Skip to main content
POST
/
v1
/
generateData
Generate synthetic data
curl --request POST \
  --url https://api.starfishdata.ai/v1/generateData \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "prompt": "<string>",
  "numOfRecords": 123,
  "projectId": "<string>"
}
'
{
  "projectId": "<string>",
  "jobId": "<string>",
  "success": true
}

Documentation Index

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

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

Authorizations

x-api-key
string
header
required

Body

application/json
prompt
string
required

The prompt for data generation

numOfRecords
integer
required

Number of records to generate

model
enum<string>
required

The model to use for generation

Available options:
gpt-4o-2024-08-06,
gpt-4o-mini-2024-07-18,
gpt-4-turbo-2024-04-09
projectId
string
required

ID of the project

Response

Successful data generation request

projectId
string

ID of the created project

jobId
string

ID of the generation job

success
boolean

Whether the request was successful