Technique Runs

Start a technique run

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.

post/techniques/{techniqueId}/runs

Path parameters

techniqueIdstring required

Technique identifier or slug

Example:art-directors-critique

Technique identifier or slug

Request body

mode'async' | 'stream' required

Technique run execution mode

callback_urlstring uri

HTTPS callback URL for asynchronous run completion notifications

idempotency_keystring

Idempotency key for safely retrying requests

Response

Technique run started.

run_idstring required

Run identifier

status'pending' | 'running' | 'completed' | 'failed' required
progressnumber required
created_atnumber required
started_atnumber
completed_atnumber
error_codestring

Machine-readable run error code

error_messagestring

Human-readable run error message

charged_costnumber

Cost charged in USD

poll_urlstring uri

Example response

{
  "run_id": "run_abc123",
  "error_code": "provider_error",
  "error_message": "The provider failed to complete the generation.",
  "outputs": [
    {
      "output_id": "output_1",
      "url": "https://media.flora.ai/output.png"
    }
  ]
}

Changes

Changed in 5 of the 8 revisions of this API.101227

  • 2f4a714f8ce961218See the full diff
    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property // from the response with the status

      response-required-property-removed

    • removed the required property // from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property // to the response with the status

      response-required-property-added

    • added the required property // to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

  • 3b683901714c11See the full diff
    • added required request body

      request-body-added-required

    • for the path request parameter techniqueId, the minLength was decreased from 1 to 0

      request-parameter-min-length-decreased

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5546855ea63718See the full diff
    • removed the request body

      request-body-removed

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added required request body

      request-body-added-required

    • removed the request body

      request-body-removed