Workspaces

Ingest files

Other errors (500, 502, 503) are on Errors.

POST
/v1/workspaces/{id}/ingestions

Other errors (500, 502, 503) are on Errors.

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer nace_sk_...

  • Where: the dashboard's API Keys page. It is shown once, when you create it.
  • Format: nace_sk_ followed by 43 URL-safe characters (A-Z, a-z, 0-9, _ and -).
  • Limit: an account can hold at most 3 active keys.
  • Wrong or missing key: returns 401 authentication_error.

In: header

Path Parameters

idstringrequired

The workspace's workspace_id.

Query Parameters

wait_secondsinteger

Hold the request open until the job finishes, up to this many seconds. 0 (default) returns at once; a value above 60 waits 60.

Range0 <= value

Header Parameters

Idempotency-Keystring

Up to 200 characters, unique per account. Retry identical inputs with the same key to get the original job; use a new key for changed inputs.

Lengthlength <= 200

Request Body

application/json

selectionobject | objectrequired

{"type": "file_ids", "file_ids": [...]} (1 to 1000), or {"type": "path_prefix", "path_prefix": "", "stale_only": false}; "" is the whole workspace.

Show variants
reingest_unchangedboolean
Defaultfalse

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/workspaces/string/ingestions" \  -H "Content-Type: application/json" \  -d '{    "selection": {      "type": "path_prefix",      "path_prefix": ""    }  }'
{  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",  "kind": "string",  "status": "queued",  "workspace_id": "string",  "result": null}