API Reference
Components
Documents
- POSTUpload and process a document
- GETGet all documents
- GETGet a signed upload URL for a document
- PUTUpdate document file content
- GETGet all tags
- GETGet a document by ID
- DELDelete a document
- PUTUpdate a document
- GETGet document visual components
- GETGet document text blocks
- GETGet document collaborators
- PUTAdd collaborators to a document
- PUTUpdate document file content
- POSTAdd a tag to a document
- GETGet tags for a document
- DELRemove a tag from a document
- POSTSearch for documents
- GETGet a document search by ID
- POSTAdd a retention policy to a document
- GETGet retention policies for a document
- DELRemove a retention policy from a document
Job Status
Questions & Answers
Documents
Get a document search by ID
Retrieves a document search by its unique identifier.
GET
/
api
/
v0
/
documents
/
search
/
{search_id}
Copy
{
"id": 123,
"user_id": 123,
"query": "string",
"status": "string",
"error_message": {},
"documents": [
{
"id": 123,
"name": "string",
"folder_id": {},
"file_path": {},
"file_type": "string",
"file_url": {},
"summary": "string",
"visibility": "string",
"version": 123,
"owner_id": 123,
"created_at": "string",
"updated_at": "string"
}
],
"created_at": "string"
}
Get a document search by ID
Retrieves a document search by its unique identifier.
Path Parameters
integer
required
No description provided
Response
The response data for this endpoint.
Copy
{
"id": 123,
"user_id": 123,
"query": "string",
"status": "string",
"error_message": {},
"documents": [
{
"id": 123,
"name": "string",
"folder_id": {},
"file_path": {},
"file_type": "string",
"file_url": {},
"summary": "string",
"visibility": "string",
"version": 123,
"owner_id": 123,
"created_at": "string",
"updated_at": "string"
}
],
"created_at": "string"
}
Copy
{
"id": 123,
"user_id": 123,
"query": "string",
"status": "string",
"error_message": {},
"documents": [
{
"id": 123,
"name": "string",
"folder_id": {},
"file_path": {},
"file_type": "string",
"file_url": {},
"summary": "string",
"visibility": "string",
"version": 123,
"owner_id": 123,
"created_at": "string",
"updated_at": "string"
}
],
"created_at": "string"
}
Assistant
Responses are generated using AI and may contain mistakes.