funko
browser-session

Poll one generation task

Clerk-session only, and gated on a runId this caller owns. A FAILED generation is a 200 carrying an error field, NOT an HTTP error - an HTTP error here means the poll itself could not be performed, which is the distinction a client absorbing transient network failures depends on. Polling is not itself billed but is gated anyway, because an open poll would leak whether an arbitrary task id exists and what it produced.

get/api/funko/task

Request

  • Base URL: https://www.immersivecommons.com
  • URL: https://www.immersivecommons.com/api/funko/task
  • Auth: API key in cookie __session

Query parameters

runIdstring required

A run id issued to THIS caller by POST /api/funko/run/start and still live.

kind'image' | 'mesh' required
idstring required

The upstream task id.

Response

The task's current status. status: "FAILED" is still a 200.

okboolean required
statusstring required

PENDING | IN_PROGRESS | SUCCEEDED | FAILED.

progressinteger required

0..100. Forced to 100 on SUCCEEDED.

imageUrlsstring[]

Image tasks only.

modelUrlstring

Mesh tasks only.

errorstring

Present when status is FAILED. A failed generation is still HTTP 200.

Changes

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