products

Create a product job

Changed on

Billed in credits: the key's organization pool, or the owner's personal credits.

Reuse the same idempotency key on an uncertain response.

switchx_finish creates a higher-resolution child of a completed SwitchX 2.0 or 3.0 Standard product job. Supply the parent's model_id (switchx-2.0 or switchx-3.0), inputs.parent_job_id (the public dap_ ID), and inputs.target_resolution (1080 or 2160). Poll the returned child through /product-jobs/{job_id}.

post/v1/products/{product}/jobs

Request

  • Base URL
    https://api.beeble.ai
  • Auth
    API key in header x-api-key

Path parameters

productstring required

Request body

model_idstring required
inputsobject
billing_unit'usd' | 'credits'

These product endpoints bill credits: the key's organization pool, or the owner's personal credits.

idempotency_keystring required
max_creditsinteger nullable
callback_urlstring nullable

Response

Successful Response

idstring required
productstring required
model_idstring required
organization_idstring nullable
team_idstring nullable
billing_unit'credits'
statusstring required
progressnumber nullable
credits_chargedinteger nullable
refundedboolean nullable
outputsobject
errorobject nullable
created_atstring date-time required

Changes

    • breaking

      the response property became optional for the status

    • breaking

      response property organization_id list-of-types was widened by adding types null to media type application/json of response 202

    • info

      endpoint added