Start a technique run

POST/techniques/{techniqueId}/runs

Starts a run for a specific technique using the backward-compatible nested route. Mutating public API requests support an optional Idempotency-Key header for client retries; duplicate keys within two hours return idempotency_duplicate.

Path ParametersExpand Collapse

techniqueId: string

Technique identifier or slug

Body ParametersJSONExpand Collapse

inputs: array of object { id, type, value }

Technique inputs

id: string

Technique input identifier

type: "text" or "imageUrl" or "videoUrl"

Technique input type

One of the following:

"text"

"imageUrl"

"videoUrl"

value: string

Technique input value

mode: "async" or "stream"

Technique run execution mode

One of the following:

"async"

"stream"

callback_url: optional string

HTTPS callback URL for asynchronous run completion notifications

formaturi

idempotency_key: optional string

Idempotency key for safely retrying requests

ReturnsExpand Collapse

createdAt: number

progress: number

runId: string

Run identifier

status: "pending" or "running" or "completed" or "failed"

One of the following:

"pending"

"running"

"completed"

"failed"

chargedCost: optional number

completedAt: optional number

errorCode: optional string

Machine-readable run error code

errorMessage: optional string

Human-readable run error message

outputs: optional array of object { outputId, type, url }

outputId: string

Run output identifier

type: "imageUrl" or "videoUrl" or "audioUrl" or 2 more

Run output media type

One of the following:

"imageUrl"

"videoUrl"

"audioUrl"

"text"

"documentUrl"

url: string

Run output URL

formaturi

pollUrl: optional string

formaturi

startedAt: optional number

Start a technique run

curl https://app.flora.ai/api/v1/techniques/$TECHNIQUE_ID/runs \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $FLORA_API_KEY" \
    -d '{
          "inputs": [
            {
              "id": "id",
              "type": "text",
              "value": "value"
            }
          ],
          "mode": "async"
        }'

{
  "createdAt": 0,
  "progress": 0,
  "runId": "run_abc123",
  "status": "pending",
  "chargedCost": 0,
  "completedAt": 0,
  "errorCode": "provider_error",
  "errorMessage": "The provider failed to complete the generation.",
  "outputs": [
    {
      "outputId": "output_1",
      "type": "imageUrl",
      "url": "https://media.flora.ai/output.png"
    }
  ],
  "pollUrl": "https://example.com",
  "startedAt": 0
}

{
  "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

{
  "createdAt": 0,
  "progress": 0,
  "runId": "run_abc123",
  "status": "pending",
  "chargedCost": 0,
  "completedAt": 0,
  "errorCode": "provider_error",
  "errorMessage": "The provider failed to complete the generation.",
  "outputs": [
    {
      "outputId": "output_1",
      "type": "imageUrl",
      "url": "https://media.flora.ai/output.png"
    }
  ],
  "pollUrl": "https://example.com",
  "startedAt": 0
}

{
  "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."
  }
}