FurniOpsDocs
API referenceUploads

Complete an upload

Checks that the bytes arrived, at the declared size, and queues a run that reads them. Missing or different bytes answer 422; an expired or already completed upload, a source with an active run, or a paused or disabled one answer 409.

POST/v1/uploads/{id}/complete

Checks that the bytes arrived, at the declared size, and queues a run that reads them. Missing or different bytes answer 422; an expired or already completed upload, a source with an active run, or a paused or disabled one answer 409.

Authorization

apiKey
AuthorizationBearer <token>

An API key (fo_live_… / fo_test_…) as a bearer token

In: header

Path Parameters

id*string

Upload (a file sent to a source, staged in storage) ID

Match^upl_[0-9A-Za-z]{22}$

Header Parameters

FurniOps-Version?string

Dated API version; pinned per organisation on first use and overridable per request

Value in

  • "2026-10-01"
  • "2026-10-04"
FurniOps-Mode?string

The data the request acts on: test is the organisation's sandbox. An OAuth token picks it (live by default); an API key's mode is fixed, and naming the other one is refused

Value in

  • "live"
  • "test"
Idempotency-Key*string

Unique key for this operation, reused on retries (24 h)

Length1 <= length <= 257
FurniOps-Dry-Run?string

Preview the write and change nothing: true answers the would-be response, explain a Preview (application/vnd.furniops.preview+json)

Value in

  • "true"
  • "explain"

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/uploads/string/complete" \  -H "Idempotency-Key: string"
{  "object": "run",  "id": "string",  "source": "string",  "trigger": "schedule",  "stream": "catalogue",  "status": "queued",  "stage": "fetch",  "served_by": null,  "stats": {    "property1": 0,    "property2": 0  },  "error": {    "code": "fetch_refused",    "message": "string"  },  "waiting": {    "reason": "rate_limited",    "until": "2019-08-24T14:15:22Z",    "attempt": 1,    "detail": "string"  },  "problems": [    {      "sheet": "string",      "line": 1,      "column": "string",      "field": "string",      "problem": "missing",      "detail": "string"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z"}

Replay a source POST

Queues a run that processes the source's current snapshot again without fetching, after a mapping or rule change: only records whose result changed are written, at the time they were fetched, and absence is not counted. It answers 409 like starting a run, and 422 when the source has no snapshot its records reflect yet.

Start an upload POST

Stages a file for a `file` source: the response's `target` is a presigned URL to PUT the bytes to, with the headers to send, for 15 minutes. Then complete the upload. Other kinds of source, and a file larger than the snapshot limit, answer 422.