Docs / Get started

Model ids

Each model has one id. It goes in the path when you submit or ask for a quote.

Find an id

The price list names every model. GET /v1/models lists them with their ids, settings and prices; GET /v1/models/{model_id} gives one.

cURL
curl "https://api.minicut.ai/v1/models" \
  -H "Authorization: Key $MINIAPI_KEY"

Use an id

The id goes in the path. Status, result and cancel take the same id and the request_id the submit gave you.

CallPath
SubmitPOST /v1/queue/{model_id}
QuotePOST /v1/quote/{model_id}
StatusGET /v1/queue/{model_id}/requests/{request_id}/status
ResultGET /v1/queue/{model_id}/requests/{request_id}
CancelPUT /v1/queue/{model_id}/requests/{request_id}/cancel

Each model takes its own fields. The API reference shows them: pick a model there and the body and the code change with it. A field the model does not take is refused with 422.

On sale and coming soon

status in /v1/models is on_sale or coming_soon. A coming soon model has a price but cannot take jobs yet; a submit answers 503 model_unavailable and you are not charged.