---
title: "Create synthetic data"
method: POST
path: "/api/{projectId}/jobs/synthetic-data"
tags: ["Jobs"]
---

# Create synthetic data

`POST /api/{projectId}/jobs/synthetic-data`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/synthetic-data`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/jobs/synthetic-data/post.ts> (a function with typed inputs; its response is checked against the schema)

Generate new synthetic data

## Path parameters

- `projectId` integer, required

## Request body

- CreateSyntheticDataRequest
  - `transformationBlockId` integer, required: The ID of a Synthetic Data transform block ID (public or private)
  - `parameters` object, required: Properties for this synthetic data block

## Response `200`

OK

- StartJobResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `id` integer, required: Job identifier. Status updates will include this identifier.

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)