Introduction

Welcome to the Tess AI API documentation. This guide will help you integrate Tess AI's powerful agent and file management capabilities into your applications.

Getting Started

To use the Tess AI API, you'll need an API key. You can create one by:

1. Going directly to #Tess AI → User Tokens
2. Or navigating through the UI:
   • Visit #Tess AI
   • Click on the User Menu
   • Select "API Tokens"
   • Click "Add New Token"

Once you have your API key, you can use it to authenticate your API requests as shown in the Authentication section below.

Available 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

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

Authentication

The Tess AI API uses Bearer token authentication. All API requests must include an Authorization header with a valid API key.

Authorization: Bearer YOUR_API_KEY

caution

Keep your API key secure and never share it in publicly accessible areas such as GitHub, client-side code, or public forums.

Base URL

All API requests should be made to:

https://tess.pareto.io/api

Rate Limiting

The default rate limit applied to all endpoint is 1 request per second.

note

Contact support if you need increased rate limits for your application.

Request/Response Format

Unless otherwise specified, all requests and responses are in JSON format. Include the following header in your requests:

Content-Type: application/json

Pagination

Many endpoints return paginated results. You can control pagination using these query parameters:

Parameter	Type	Default	Description	Constraints
page	integer	1	Current page number	Minimum: 1
per_page	integer	15	Items per page	Minimum: 1, Maximum: 100

Example pagination response:

{
  "data": [...],
  "meta": {
    "current_page": 1,
    "per_page": 15
  }
}