entities

Export Entities

Stream all matching collected data as a CSV download.

Same account scope, auth, and 9-filter set as GET /entities (single shared filter source — export and list can never drift). Row cap (ENTITY_EXPORT_MAX_ROWS) is applied count-first (D6) so the truncation headers are known at response construction; a capped export is still a 200 carrying the first cap rows.

Declared BEFORE /{entity_id} so export is never coerced to an int path param (D2 route order). Auth is header-only (Bearer / X-AUTH-TOKEN) — a direct browser <a href> 401s; in-browser download goes through the Nuxt proxy (task 4e84e060, out of scope here).

get/api/v1/entities/export

Request

  • Base URL: https://api.gnosari.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.gnosari.com/api/v1/entities/export
  • Auth: one of:
    • HTTP bearer
    • API key in header X-AUTH-TOKEN

Query parameters

agent_idinteger nullable

Filter by agent ID

entity_type_idinteger nullable

Filter by entity type ID

status'NEW' | 'REVIEWED' | 'ACTIONED' | 'ARCHIVED'

Status of an extracted entity in the workflow.

Filter by status

min_confidencenumber nullable

Minimum confidence score

max_confidencenumber nullable

Maximum confidence score

date_fromstring date-time nullable

Filter from date

date_tostring date-time nullable

Filter to date

searchstring nullable

Search in attributes, agent name, or data type name

include_archivedboolean

Include archived entities

Response

Successful Response

unknown required

Changes

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