Requests

Get request status

Changed on

Retrieve the current state and output of a generation request.

get/requests/{request_id}/status

Request

  • Base URL
    https://api.higgsfield.ai
  • Auth
    API key in header Authorization

Path parameters

request_idstring uuid required

Response

Current request state and output, when available.

status'queued' | 'in_progress' | 'nsfw' | 'failed' | 'completed' | 'canceled' required
request_idstring uuid required
status_urlstring uri
cancel_urlstring uri
errorstring nullable
expires_atstring date-time nullable

When the request data is deleted and output URLs stop working. Present once the request has finished.

Changes