Start a generation

POST/generate

Starts a model generation using type, prompt, workspace_id, project_id, optional model endpoint ID, and optional model parameters. Use type=image|video|audio|text and model IDs returned by GET /models or list_models. Poll the returned run_id via GET /runs/{runId} for progress and outputs. Mutating public API requests support an optional Idempotency-Key header for client retries; duplicate keys within two hours return idempotency_duplicate.

Body ParametersJSONExpand Collapse

project_id: string

Project identifier. Use the public API ID returned by list projects; it must start with prj_.

prompt: string

Generation prompt

minLength1

type: "image" or "video" or "audio" or "text"

Generation type. Use “image”, “video”, “audio”, or “text”; do not pass model families such as “t2i” or “i2v”.

One of the following:

"image"

"video"

"audio"

"text"

workspace_id: string

Workspace identifier. Use the public API ID returned by list workspaces; it must start with ws_.

model: optional string

Model endpoint ID, not a display name. Use list_models (or GET /models) to find accessible endpoint IDs for the requested type.

params: optional map[unknown]

Model parameters

ReturnsExpand Collapse

charged_cost: number

Cost charged in USD

minimum0

estimated_seconds: number

minimum0

run_id: string

Run identifier

type: "generation" or "technique" or "action"

Run type

One of the following:

"generation"

"technique"

"action"

action: optional object { action_id }

action_id: "split-text" or "find-and-replace-text" or "concat-text" or 34 more

Action identifier

One of the following:

"split-text"

"find-and-replace-text"

"concat-text"

"ken-burns-video"

"color-grade-image"

"change-image-ar"

"rotate-image"

"flip-image"

"color-filter-image"

"color-tint-image"

"filter-color-image"

"blur-image"

"duplicate-image"

"side-by-side-composite"

"add-shape-to-image"

"generate-shape-image"

"add-text-to-image"

"generate-text-image"

"qr-code-generator"

"stitch-videos"

"split-video"

"extract-video-frames"

"color-grade-video"

"video-to-frame-grid"

"boomerang-video"

"reverse-video"

"video-to-long-exposure"

"video-effect"

"color-filter-video"

"speed-up-video"

"slow-down-video"

"duplicate-video"

"greenscreen-video"

"resize-video"

"change-video-ar"

"split-audio-from-video"

"merge-audio-into-video"

model: optional object { model_id }

model_id: string

Model identifier

minLength1

poll_url: optional string

URL to poll pending/running runs or fetch completed/failed run details.

formaturi

project_id: optional string

Project identifier

technique: optional object { name, technique_id }

name: string

Technique name

technique_id: string

Technique identifier

Start a generation

curl https://app.flora.ai/api/v1/generate \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $FLORA_API_KEY" \
    -d '{
          "project_id": "prj_abc123",
          "prompt": "A cinematic product photo of a ceramic mug on a sunlit table",
          "type": "image",
          "workspace_id": "ws_abc123"
        }'

{
  "charged_cost": 0,
  "estimated_seconds": 0,
  "run_id": "run_abc123",
  "type": "generation",
  "action": {
    "action_id": "split-text"
  },
  "model": {
    "model_id": "t2i-flux-2-pro"
  },
  "poll_url": "https://example.com",
  "project_id": "prj_abc123",
  "technique": {
    "name": "name",
    "technique_id": "tech_abcd1234"
  }
}

{
  "error": {
    "code": "input_validation_error",
    "message": "prompt: Required",
    "fields": [
      {
        "field": "prompt",
        "message": "Required"
      }
    ]
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key."
  }
}

{
  "error": {
    "code": "insufficient_credits",
    "message": "Insufficient credits."
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Forbidden."
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Not found."
  }
}

{
  "error": {
    "code": "idempotency_duplicate",
    "message": "Duplicate idempotency key."
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded."
  }
}

{
  "error": {
    "code": "unknown_error",
    "message": "An unknown error occurred."
  }
}

Returns Examples

{
  "charged_cost": 0,
  "estimated_seconds": 0,
  "run_id": "run_abc123",
  "type": "generation",
  "action": {
    "action_id": "split-text"
  },
  "model": {
    "model_id": "t2i-flux-2-pro"
  },
  "poll_url": "https://example.com",
  "project_id": "prj_abc123",
  "technique": {
    "name": "name",
    "technique_id": "tech_abcd1234"
  }
}

{
  "error": {
    "code": "input_validation_error",
    "message": "prompt: Required",
    "fields": [
      {
        "field": "prompt",
        "message": "Required"
      }
    ]
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key."
  }
}

{
  "error": {
    "code": "insufficient_credits",
    "message": "Insufficient credits."
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Forbidden."
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Not found."
  }
}

{
  "error": {
    "code": "idempotency_duplicate",
    "message": "Duplicate idempotency key."
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded."
  }
}

{
  "error": {
    "code": "unknown_error",
    "message": "An unknown error occurred."
  }
}