API Reference

All Queryvine functionality is available via REST API. Base URL: https://api.queryvine.com/v1

All requests require an Authorization: Bearer <api_key> header. Keys are workspace-scoped and created from the Queryvine dashboard.

Pipelines

GET /pipelines

List all pipelines in the workspace.

cURL

$ curl -X GET https://api.queryvine.com/v1/pipelines \
     -H "Authorization: Bearer qvk_live_xxx"

POST /pipelines

Create a new pipeline from a configuration object.

GET /pipelines/{id}

Get a single pipeline by ID, including current status and last run summary.

DELETE /pipelines/{id}

Delete a pipeline. Running executions are terminated and not resumed.

Runs

POST /pipelines/{id}/runs

Trigger a new pipeline run. Supports start_from for partial backfills.

JSON response

{
  "run_id": "run_8f3bq9sw",
  "pipeline_id": "pipe_7x9m2k4n",
  "status": "running",
  "started_at": "2025-11-17T14:22:00Z",
  "schema_fingerprint": "sha256:3a9f..."
}

GET /pipelines/{id}/runs/{run_id}

Retrieve run status, row counts, duration, and any drift events detected during this run.

Schemas

GET /pipelines/{id}/schema

Return the current captured schema fingerprint for a pipeline (column names, types, nullability).

GET /pipelines/{id}/schema/diff

Return a structured diff between the current schema and a previous fingerprint. Query params: from_version, to_version.

Events

GET /pipelines/{id}/events

List drift events for a pipeline. Filterable by severity, type, and since timestamp.

POST /webhooks

Register a webhook endpoint to receive real-time pipeline events (drift detected, run complete, pause triggered). Payload is signed with HMAC-SHA256.

API Keys

POST /api-keys

Create a new API key with a description and optional expiry. Keys are shown once at creation; store them securely.

DELETE /api-keys/{key_id}

Revoke an API key immediately. In-flight requests using this key fail within 30 seconds.