media

Trigger standalone subject/face detection

Required permission: media:write

post/v1/media/{id}/detect-subjects

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/media/{id}/detect-subjects
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.cueframe.ai/api/auth/mcp/authorize, token URL https://api.cueframe.ai/api/auth/mcp/token, scopes: media:write)
    • API key in header PAYMENT-SIGNATURE

Path parameters

idstring required

Query parameters

detector'face' | 'person'

Which detector to run. Defaults to face; an unknown value is refused, never defaulted.

Response

Detection claimed. alreadyExisted:true means this exact detection was already pending or ready — nothing was dispatched and nothing will be charged.

factIdstring required

Opaque identifier for the derived fact.

status'pending' | 'ready' | 'failed' required

State of the fact right now. ready with alreadyExisted means the detection was already computed and is available immediately.

quotedUsdnumber required

The server's price for this detection, in USD, quoted from the source duration. Zero is charged when alreadyExisted is true.

alreadyExistedboolean required

True when this exact detection was already pending or ready. Nothing was dispatched and nothing will be charged — the same fact is served twice for one price.

Changes

No recorded changes to this operation across all 1 revision of this API.