Modelyx AI API: AI agents inside your applications
An API is a way to reach an AI from your own program instead of a chat window. In Modelyx, the API runs your agents: you pass the agent ID and a request and get an answer that follows its instructions, knowledge and tools.
Starting credits after sign-up
How it works
- 1
Create a key in settings, in the API keys section, and set its expiry date.
- 2
Send a POST request to /api/v1/responses: the agent’s ID or slug in the model field, the task in the input field.
- 3
Turn on stream to get the answer in parts, and pass previous_response_id to continue a dialog.
- 4
Describe your system’s functions — the agent will ask to call them when needed.
What you get
The request runs with the instructions, skills, connected services and knowledge base of the chosen agent.
Streaming (server-sent events) lets you show progress in your interface instead of waiting for the full answer.
With function calling, the agent can find an order, check stock or create a ticket in your system.
Try requests in the interactive reference, or generate a client in your language from the OpenAPI description.
Example requests
Paste a request into Modelyx and adjust the details to your case.
Classify the incoming request into the categories “order”, “return”, “complaint”, “other” and return JSON with the category and a short summary
Draft a reply to the customer’s email in our tone, using the agent’s knowledge base
Where it helps
Limitations
- API runs use credits the same way as regular chats.
- The model field takes one of your agents, so you need to create the agent in Modelyx first.
- Anyone with the key can run your agents on your credits — keep it in a secrets manager, not in client-side code.
FAQ
What is an AI API?
It’s a way to send requests to AI from your own program or script. In Modelyx, this is how your agents run: you pass the agent ID and the task and get its answer.
What goes into the model field?
The ID or slug of your agent. The ID is the last part of the agent page’s address.
Can a dialog be continued?
Yes. Pass the ID of the previous response in previous_response_id, and the agent takes the earlier messages into account.
Can I use the API for free?
API calls use credits under the same rules as work in the web app. After sign-up you get starter credits — enough to try it out.
Learn more in the knowledge base
Related features
Try it on your own task
Describe your task in plain words — Modelyx picks the model and returns a finished result. Starting credits after sign-up.
Start for free