Overview
Welcome to the Tess AI API documentation! This guide will help you get started with our API and understand how to integrate Tess AI's powerful capabilities into your applications.
Base URL
All API requests should be made to the following base URL:
https://tess.pareto.io/api
Authentication
All API requests require authentication using an API key. You can obtain your API key from the Tess AI Dashboard.
To authenticate your requests, include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
API Endpoints
The Tess AI API provides the following main categories of endpoints:
Agents
| Endpoint | Method | Description | Documentation |
|---|---|---|---|
/agents | GET | List all agents | List Agents |
/agents/{id} | GET | Get a specific agent | Get Agent |
/agents/{id}/execute | POST | Execute an agent | Execute Agent |
/agent-responses/{id} | GET | Get agent execution response | Get Agent Response |
Agent Files
| Endpoint | Method | Description | Documentation |
|---|---|---|---|
/agents/{agentId}/files | GET | List agent files | List Agent Files |
/agents/{agentId}/files | POST | Link files to agent | Link Files to Agent |
/agents/{agentId}/files/{fileId} | DELETE | Delete agent file | Delete Agent File |
Agent Webhooks
| Endpoint | Method | Description | Documentation |
|---|---|---|---|
/agents/{id}/webhooks | GET | List agent webhooks | List Agent Webhooks |
/agents/{id}/webhooks | POST | Create agent webhook | Create Agent Webhook |
Memories
| Endpoint | Method | Description | Documentation |
|---|---|---|---|
/memories | GET | List all memories | List Memories |
/memories | POST | Create a memory | Create Memory |
/memories/{memoryId} | PATCH | Update a memory | Update Memory |
/memories/{memoryId} | DELETE | Delete a memory | Delete Memory |
Memory Collections
| Endpoint | Method | Description | Documentation |
|---|---|---|---|
/memory-collections | GET | List all collections | List Collections |
/memory-collections | POST | Create a collection | Create Collection |
/memory-collections/{collection_id} | PUT | Update a collection | Update Collection |
/memory-collections/{collection_id} | DELETE | Delete a collection | Delete Collection |
Files
| Endpoint | Method | Description | Documentation |
|---|---|---|---|
/files | GET | List all files | List Files |
/files | POST | Upload a file | Upload File |
/files/{fileId} | GET | Get file details | Get File |
/files/{fileId} | DELETE | Delete a file | Delete File |
/files/{fileId}/process | POST | Process a file | Process File |
Webhooks
| Endpoint | Method | Description | Documentation |
|---|---|---|---|
/webhooks | GET | List all webhooks | List Webhooks |
/webhooks/{id} | DELETE | Delete a webhook | Delete Webhook |
Request Format
Most API endpoints accept JSON-encoded request bodies. Make sure to include the following header in your requests:
Content-Type: application/json
Response Format
All API responses are returned in JSON format. A successful response will typically have a 2xx HTTP status code and contain the requested data. Error responses will have a 4xx or 5xx status code and include an error message.