UBIK Agent will launch soon, join the waitlist to get access!
import requests
url = "https://app.ubik-agent.com/api/v1/workspaces/{workspace_id}/documents"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "c1d2e3f4-a5b6-7890-1234-567890abcdef",
"name": "Q1 Sales Report.pdf",
"file_type": "application/pdf",
"status": "completed",
"created_at": "2025-09-28T10:05:00Z",
"updated_at": "2025-09-28T10:05:00Z",
"processing_pipeline": "default-pipeline"
}
],
"total": 1,
"page": 1,
"limit": 20,
"has_more": false
}Retrieves a paginated list of documents within a specific workspace.
import requests
url = "https://app.ubik-agent.com/api/v1/workspaces/{workspace_id}/documents"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "c1d2e3f4-a5b6-7890-1234-567890abcdef",
"name": "Q1 Sales Report.pdf",
"file_type": "application/pdf",
"status": "completed",
"created_at": "2025-09-28T10:05:00Z",
"updated_at": "2025-09-28T10:05:00Z",
"processing_pipeline": "default-pipeline"
}
],
"total": 1,
"page": 1,
"limit": 20,
"has_more": false
}Documentation Index
Fetch the complete documentation index at: https://docs.ubik-agent.com/llms.txt
Use this file to discover all available pages before exploring further.
x >= 11 <= x <= 100Successful Response
Hide child attributes
The unique identifier for the document.
The display name of the document.
The current processing status of the document.
The timestamp when the document was created.
The timestamp when the document was last updated.
The MIME type of the document file.
The name of the processing pipeline used for this document.
If processing failed, this field will contain the error message.
Custom API metadata resolved for the current user. Useful for retrieving stored external references (e.g. {'internal_app_ref': 'REF-123'}). Note: This value is resolved based on the request's external_user_id. A document shared globally but also scoped to a specific user may return different metadata depending on who is asking.
Total number of documents available.
The current page number.
The number of items per page.
Indicates if there are more pages available.
Was this page helpful?