Flambe docs
API referenceImports

List child imports

For an `image_batch` parent, the per-image child imports it fanned out into. Each child succeeds or fails independently, so a batch can be partially complete.

GET
/api/imports/{id}/children

For an image_batch parent, the per-image child imports it fanned out into. Each child succeeds or fails independently, so a batch can be partially complete.

Authorization

bearerAuth
AuthorizationBearer <token>

A Clerk session JWT. Obtain one with a Clerk frontend SDK (session.getToken()) or, for server-to-server use, with a Clerk machine token. The token's sub claim is the Flambe user id that scopes every request.

In: header

Path Parameters

id*string

Import identifier.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/imports/497f6eca-6276-4993-bfeb-53cbbbba6f08/children"
{  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "user_id": "string",      "type": "web",      "status": "pending",      "url": "http://example.com",      "file_id": "string",      "file_ids": [        "1c0f12fe-c5bf-4fbd-ba1b-466cb232eca5"      ],      "text_file_id": "f6dba989-8fc3-4ab0-b9d1-49bdefc7e954",      "source_url": "http://example.com",      "source_section": "string",      "recipe_id": "fa7d15d4-7670-4586-a94b-5079ed028135",      "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",      "error": "string",      "progress": {        "stage": "extracting",        "percent": 0      },      "processing_started_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

List the import working set GET

The newest imports by `created_at`, intentionally not paginated — this is the bounded window the apps' import screens render. Ordering is by **creation**, not by recency of activity. An old import that just failed or is being retried has a fresh `updated_at` but keeps its original `created_at`, so it is *not* pulled into this window. Use `/api/imports/v2` when you need the archive. Batch parents of any child in the window are fetched and included even when the parent itself falls outside it.

List imports (paginated) GET

The full import archive, newest first by `created_at`, cursor paginated. Use this to page back through history; use `/api/imports/working-set` for the bounded set a UI renders.