UBIK Agent will launch soon, join the waitlist to get access!
import requests
url = "https://app.ubik-agent.com/api/v1/agent-sessions"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"model_name": "<string>",
"external_user_id": "<string>",
"active_tools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>"
}
],
"documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"file_type": "<string>",
"processing_pipeline": "<string>",
"error_message": "<string>",
"is_starred": false
}
]
}
],
"total": 123,
"page": 123,
"limit": 123,
"has_more": true
}Retrieves a paginated list of agent sessions. Use ‘X-End-User-ID’ header to filter by your end-users.
import requests
url = "https://app.ubik-agent.com/api/v1/agent-sessions"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"model_name": "<string>",
"external_user_id": "<string>",
"active_tools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>"
}
],
"documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"file_type": "<string>",
"processing_pipeline": "<string>",
"error_message": "<string>",
"is_starred": false
}
]
}
],
"total": 123,
"page": 123,
"limit": 123,
"has_more": true
}x >= 11 <= x <= 100Successful Response
Hide child attributes
Unique identifier for the session.
Current status (e.g., 'active', 'completed').
Creation timestamp.
Last update timestamp.
Title of the session.
Model being used.
The external user ID associated with this session, if any.
List of documents linked to this session.
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.
Whether the document is starred in the current session context.
Was this page helpful?