The Ultineo AI API
Run the catalogue applications from your own software. The API speaks JSON over HTTPS, authenticates each call with a project key and answers every call in the same envelope.
Built around three resources
- Catalogue
The published applications, most used first, each with the input fields it expects.
- Runs
One call launches an application with its inputs; another reads the run back with its answer.
- Keys
Project keys with scopes, an optional expiry and a status you can switch off.
Authentication and scopes
- A bearer key
Send your project key in the Authorization header of every call, over HTTPS only.
- Scoped to one project
A key is tied to one project and can never read or write the data of another project, whatever the request.
- Stored as a hash
Only a hash of the key is kept, so a key is shown in full once. A lost key is replaced, never recovered.
Launch a run and read its answer
- Create
Name the application and supply one value per input field, keyed by the field name the catalogue returns.
- Follow
Runs are asynchronous: read the run back until its status is finished or failed. Both are final.
- Read
A finished run carries its answer, its duration and its token counts for input and output.
One envelope for every answer
- Same three keys
Every answer carries the status code, a short title and the response, on success and on failure alike.
- Stable messages
Error messages are stable English strings that name the missing scope or the rejected value.
- Plan limits are explicit
A call that the plan does not cover, or that would exceed its allowance, is refused with its own status code.
Getting a key
API access comes with the paid Ultineo AI plans. There is no self-service sign-up yet: our team opens your project and hands you its first key.
Connect your software to Ultineo AI
Tell us what you want to automate and we will open your project and its API key.
Questions about the API
The paid plans. The free plan gives access to the applications without the API.
No. Instructions belong to the application owner. The API returns the input fields, which are what a caller fills in.
Creating a run returns at once with the new status. Read the run back until it is finished to get the answer.
Yes. Each key carries scopes and an optional expiry, and a key can never create another key with a wider scope than its own.