We know that when exploring an innovative platform like ours, questions and challenges may arise. Therefore, we’ve gathered some issues recently raised by our clients and collaborators and prepared a guide with clear explanations and practical solutions. Our goal is to ensure you make the most of all Tess AI’s features.
The API world can feel like a maze, but we’re here to simplify it!
You can access the Pareto API documentation at this link here
API, or Application Programming Interface, is a set of rules that allows different software to communicate with each other. In Tess AI, the API allows you to:
Access resources: Use our AI models, create agents, manage your agents, and much more.
Automate tasks: Integrate Tess AI into your workflows and automate processes.
Create personalized solutions: Develop applications and integrations with Tess AI that meet your specific needs.
To start using our API, it is important to understand some basic concepts:
Base URL: It is the main address of the API, the base for all your requests. Tess AI's base URL is: tess.pareto.io (or similar, check the most recent documentation). Important: Make sure to use Tess AI's base URL and not OpenAI's or other AI services' base URL.
Endpoints: These are specific "addresses" within the API that allow you to perform different actions. Each endpoint is responsible for a specific operation, such as:
GET /templates: To retrieve a list of templates.
POST /agents: To execute an agent.
POST /chat/completions: To start a chat conversation with a model.
GET /users/me: To retrieve authenticated user data.
And much more! Check the API documentation for the complete list.
HTTP Methods: These are actions you can perform on an endpoint. The most common ones are:
GET: To retrieve information.
POST: To send data and create or update resources.
PUT: To update existing resources.
DELETE: To remove resources.
Authentication: To use the API, you will need an authentication token (API Key). It is used to identify and authorize your requests. You can get your token from the Tess AI platform, in your user settings.
Data Format: Generally, data is sent and received in JSON (JavaScript Object Notation) format, a lightweight and easy-to-process format.
Root IDs for Conversations: Use the root_id to maintain the history of your conversations. If you do not include a root_id in a new request, a new conversation will begin. The endpoint's response always returns a root_id.
Models: Check the documentation to see which models are available and what their functionalities are.
Token Consumption: Remember that each request uses tokens. Monitor your usage and optimize your calls.
The API also provides functionalities for:
Create, execute, and manage agents: Use the endpoint /Agents to create, retrieve, update, or delete your templates.
Execute and manage agents: Use the endpoint /Agent Files to manage your agents' nutrition data.
Authentication Error (401): Verify that your API token is correct and that you are including it in the header of your request (usually in the Authorization: Bearer <your_token>).
Endpoint Not Found Error (404): Verify that the endpoint you are using is correct and that you are using the appropriate HTTP method.
Data Format Error (400): Verify that you are sending the data in the correct format (usually JSON) and that all required fields are filled.
Request Limit Error (429): If you are receiving this error, you are making too many requests in a short period of time. Try reducing the frequency of your requests or implementing a retry mechanism.
Stay updated:
The Tess AI API is subject to changes. Always refer to the latest documentation.
We are always working to improve our API and provide new features for our developers. Keep an eye on our documentation and updates!
We created this article so you can analyze how each model consumes credits in Tess AI!
The Tess AI API is a powerful tool that enables you to build innovative solutions and expand the capabilities of our platform. Use the documentation, explore the endpoints, follow the tips we listed here, and start transforming your ideas into reality!
If you have any questions or need assistance, don’t hesitate to contact our support team.
See you next time!
Tess AI Team
