Database endpoints
Subscribe to live changes
Streams the live result of a natural-language query as Server-Sent Events, re-sending it whenever the data changes.
GET /v1/tenants/{tenant}/watch
- Supply the natural-language queryChoose schemas and the polling interval.
- Open the event streamKeep the Server-Sent Events connection active.
- Apply each data eventReplace results when updates arrive; ignore keep-alive comments.
Before you start
Use your database bearer token.
Requires configured natural-language compilation and an allowed model provider; consumes the deployment’s applicable resources.
Uses natural-language compilation and its deployment-specific provider/entitlement setup; use curl -N with Accept: text/event-stream.
Path parameters
| Field | Type | Required |
|---|---|---|
tenant | string | Required |
Query parameters
| Field | Type | Required |
|---|---|---|
nl | string | Required |
schemas | string | Optional |
poll_ms | integer | Optional |
Headers
| Field | Type | Required | Description |
|---|---|---|---|
x-oc-db-user | string | Optional | Acting database user (role, grant and row-policy checks). Send with x-oc-db-key. |
x-oc-db-key | string | Optional | API key of the x-oc-db-user user. |
Read the result
This is a long-lived Server-Sent Events response, not a single JSON document. Parse each data: event as a new result and treat keep-alive comments as stream maintenance. Natural-language query availability still depends on configuration.
Response statuses
HTTP status reference
| Status | What to do |
|---|---|
| 200 | OK |
| 400 | Correct the request before retrying. |
| 401 | Check the credential and Authorization header. |
| 402 | Check feature access or available credits. |
| 403 | Check tenant access, roles and permissions. |
| 404 | Check the resource ID and API route. |
| 429 | Honor Retry-After when present; back off. |
| 500 | Check the outcome before retrying a write. |
| 503 | Honor Retry-After when present; check write outcomes. |