Nordvec API reference

Conversations

Create, list, search, and retrieve conversations. Includes message history and feedback submission. Session-only: an API key has no conversations of its own and cannot create them.

• GET /api/v1/conversations List conversations
• POST /api/v1/conversations Create conversation
• GET /api/v1/conversations/{id} Get conversation with messages
• GET /api/v1/conversations/search Search conversations
• GET /api/v1/conversations/{id}/documents List conversation documents
• GET /api/v1/conversations/{id}/messages Load older messages
• POST /api/v1/conversations/{id}/feedback Submit message feedback
• POST /api/v1/conversations/retrieval-feedback Log retrieval quality feedback

Documents

Retrieve, list, and search indexed documents. Supports cursor-based pagination, filtering by datasource, status, and date range.

• GET /api/v1/documents/{id} Get document detail
• POST /api/v1/documents/batch Batch fetch documents by IDs
• GET /api/v1/documents/list List documents
• POST /api/v1/documents/search Search documents
• POST /api/v1/documents/push Push a document for indexing
• POST /api/v1/documents/push/bulk Bulk push documents for indexing
• POST /api/v1/documents/push/delete Delete a document from the index
• POST /api/v1/documents/push/permissions Update document permissions without re-indexing
• GET /api/v1/documents/push/status Check document push ingestion status
• GET /api/v1/documents/push/upload Check a bulk upload session
• POST /api/v1/documents/push/upload/restore Restore what a bulk upload session moved to the trash

Quota

Check embedding quota usage and limits.

• GET /api/v1/quota/embedding Get embedding quota status

Webhooks

Manage outbound event subscriptions (session-only, admin/owner). The events delivered to them are described under `webhooks`, one entry per live event.

• GET /api/v1/webhooks List webhook endpoints
• POST /api/v1/webhooks Create a webhook endpoint
• POST /api/v1/webhooks/delete Delete a webhook endpoint
• POST /api/v1/webhooks/rotate-secret Rotate webhook signing secret
• GET /api/v1/webhooks/deliveries List webhook delivery history

API Keys

Create, list, revoke, and rotate API keys. Session-only (admin/owner).

• GET /api/v1/api-keys List API keys
• POST /api/v1/api-keys Create API key
• POST /api/v1/api-keys/{keyId}/revoke Revoke API key
• POST /api/v1/api-keys/{keyId}/rotate Rotate API key

Audit Log

Search the workspace's own audit trail, for evidence collection and for feeding a SIEM. A POST because serving a page appends the read to the trail, so it is not a safe method (RFC 9110 section 9.2.1). Requires an API key scoped `audit:read`, or a session holding can_view_audit_log.

• POST /api/v1/tenant/audit-log/search Search the workspace's audit trail
• GET /api/v1/tenant/audit-log/catalog List the audit trail's event vocabulary

Analytics

Programmatic access to workspace usage metrics and ingestion health.

• GET /api/v1/analytics/usage Get AI usage statistics
• GET /api/v1/analytics/ingestion Get ingestion health

Webhook events

• documents.indexed documents.indexed
• documents.failed documents.failed
• audit.recorded audit.recorded
• endpoint.disabled endpoint.disabled
• delivery.failing delivery.failing
• endpoint.enabled endpoint.enabled
• delivery.recovered delivery.recovered
• webhook.ping webhook.ping