We know that when you're exploring an innovative platform like ours, questions and challenges might pop up. That's why we've pulled together some questions raised recently by our customers and team, and put together a guide with clear explanations and practical solutions. Our goal is to make sure you get the most out of everything Tess AI has to offer.
The world of APIs might look like a maze, but we're here to make it easy!
You can access Pareto's API documentation at this link here
API, or Application Programming Interface, is a set of rules that lets different software talk to each other. In Tess AI, the API lets you:
Access resources: Use our AI templates, create agents, manage your agents and more.
Automate tasks: Integrate Tess AI into your workflows and automate processes.
Create custom solutions: Build apps and integrations with Tess AI that fit your specific needs.
To get started with our API, it's important to understand a few basic concepts:
URL Base: This is the main address of the API, the base for all of your requests. The Tess AI base URL is: tess.pareto.io (or similar, check the latest documentation). Important: Make sure you use the Tess AI base URL and not OpenAI's or any other AI service.
Endpoints: These are specific "addresses" inside the API that let you do different things. Each endpoint handles a specific operation, like:
GET /templates: To get a list of templates.
POST /agents: To run an agent.
POST /chat/completions: To start a chat conversation with a model.
GET /users/me: To get data from the authenticated user.
And a lot more! Check out the API documentation for the complete list.
HTTP Methods: These are actions you can do on an endpoint. The most common are:
GET: To get 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'll need an authentication token (API Key). It's used to identify and authorize your requests. You can get your token on the Tess AI platform, in your user settings.
Data Format: Usually, data is sent and received in JSON (JavaScript Object Notation) format, a lightweight and easy-to-handle format.
Root IDs for Conversations: Use root_id to keep track of your conversation history. If you don't include a root_id in a new request, a new conversation will start. The endpoint's response always returns a root_id.
Models: Check the documentation to see which models are available and what they can do.
Token Usage: Remember that every request uses tokens. Track your usage and optimize your calls.
The API also offers features for:
Create, run, and manage agents: Use the endpoint /Agents to create, get, update, or delete your templates.
Run and manage agents: Use the endpoint /Agent Files to manage your agents' nutrition data
Authentication Error (401): Make sure your API token is correct and that you're including it in your request header (usually in the Authorization: Bearer <seu_token>).
Endpoint Not Found Error (404): Make sure the endpoint you're using is correct and that you're using the right HTTP method.
Data Format Error (400): Check if you're sending the data in the right format (usually JSON) and if all required fields are filled in.
Request Limit Error (429): If you're getting this error, you're making too many requests in a short period of time. Try reducing the frequency of your requests or add a retry mechanism.
Stay up to date:
Tess AI's API might change. Always check the latest documentation.
We're always working to make our API better and bring new features to our developers. Keep an eye on our documentation and updates!
We've put this article together so you can check how each model can spend credits on Tess AI!
The Tess AI API is a powerful tool that lets you build innovative solutions and expand what our platform can do. Use the docs, explore the endpoints, follow the tips we listed here and start turning your ideas into reality!
If you have any questions or need help, don't hesitate to contact our support team.
See you next time!
Tess AI Team
