API Reference

Export all rows matching a read-only query

POST /api/connectors/{id}/query/export

Streams every row the query yields as a CSV/JSON/NDJSON file download — no row cap and no server-side buffering. Write methods are rejected regardless of role. Cancel by aborting the request/download.

Operation IDexportConnectorQuery

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Request body

This request body is required.

Content typeapplication/json

requestobject

5 properties

methodstringrequired

Connector method to call (must be read-only)

argsobjectrequired

Method arguments (send without limit/top to export all rows)

Additional properties are allowed.

formatstring

Default: ndjson
Allowed values: csv, ndjson

columnsarray<string>

CSV column order; defaults to the first row's keys

Array items

itemstring

filenamestring

Download filename (extension appended from format)

Success response body

200Streamed export file (Content-Disposition attachment). Gzip when Accept-Encoding includes gzip.

Streamed export file (Content-Disposition attachment). Gzip when Accept-Encoding includes gzip.

Content typetext/csv

responsestring

Content typeapplication/x-ndjson

responsestring

Error responses

400Validation error or cancelled export

Validation error or cancelled export

No response content schema is documented.

403Method is not read-only

Method is not read-only

No response content schema is documented.

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

500Export execution failed

Export execution failed

No response content schema is documented.

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/connectors/YOUR_ID/query/export' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "method": "string",
  "args": {}
}'

const response = await fetch("https://your-envoy.example.com/api/connectors/YOUR_ID/query/export", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "method": "string",
    "args": {}
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);