FruxonDocs
ApiIntegration config sandbox

Generate sandbox entities from a natural-language description.

Runs the `sandbox_data_generator` meta-agent with the user's prompt, entity type, and (when available) the integration's payload-shape template. The LLM returns a JSON list of entity payloads which are persisted as Fruxon.Model.IntegrationSimulations.SimulatedEntity rows; the service then auto-snapshots so the seeded state becomes the natural revert point. Returns the count actually persisted and the snapshot id.

POST
/v1/tenants/{tenant}/integrations/{integration}/configs/{config}/sandbox:generate

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

config*string

The integration config id whose sandbox to seed.

Formatuuid
tenant*string

The tenant identifier

integration*string

The integration identifier

Request Body

Entity type, prompt, count, and optional scope.

entityType?string|null

Entity type to generate (e.g. "issue", "project").

prompt?string|null

Natural-language description of the data to generate.

count?integer

Target number of entities. Defaults to 10; capped at 100 per call by the service.

Formatint32
scope?string|null

Optional scope the entities live under (e.g. a Jira project key).

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/integrations/string/configs/497f6eca-6276-4993-bfeb-53cbbbba6f08/sandbox:generate" \  -H "Content-Type: application/json" \  -d '{}'
{
  "insertedCount": 0,
  "snapshotId": "00000000-0000-0000-0000-000000000000",
  "snapshotName": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}