Query Document Content

POST

/org/:org_id/project/:project_id/document/:document_id/query

POST

/api/v1/org/:org_id/project/:project_id/document/:document_id/query

$ curl -X POST "https://app.rightbrain.ai/api/v1/org/org_id/project/project_id/document/019a2f10-b1b6-7e60-95fd-1c9d4e7b6f30/query?query=What%20are%20the%20pre-trip%20inspection%20requirements%3F" \
>      -H "Authorization: Bearer <token>"

1 [
2   {
3     "chat_document_id": "019a2f10-b1b6-7e60-95fd-1c9d4e7b6f30",
4     "text": "Drivers must complete a pre-trip inspection checklist covering brakes, lights, and cargo securement before departing the yard.",
5     "score": 0.91
6   },
7   {
8     "chat_document_id": "019a2f10-b1b6-7e60-95fd-1c9d4e7b6f30",
9     "text": "Any collision, near-miss, or cargo shift must be reported to dispatch within 30 minutes of occurrence.",
10     "score": 0.84
11   }
12 ]

Search within a specific document using semantic search.

Performs vector similarity search on the document’s embedded chunks to find relevant content. Useful for:

Finding specific information in large documents
Testing embedding quality
Building document Q&A features
Extracting key passages

Returns ranked chunks with relevance scores.

Search within a specific document using semantic search. Performs vector similarity search on the document's embedded chunks to find relevant content. Useful for: - Finding specific information in large documents - Testing embedding quality - Building document Q&A features - Extracting key passages Returns ranked chunks with relevance scores.

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

document_idstringRequiredformat: "uuid"

The UUID of the document

org_idstringRequiredformat: "uuid"

The unique identifier of the organization.

project_idstringRequiredformat: "uuid"

The unique identifier of the project.

Query parameters

querystringRequired

Search query

Response

Ranked chunks matching the query

chat_document_idstringformat: "uuid"

textstring

scoredouble

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error