Use the public API

The public API automates the same business operations as the portal, within the permissions of the account that owns the key.

Create a key

1. Open your profile menu.
2. Choose API keys.
3. Create a key and immediately store it in your secrets manager.
4. Revoke any key that is no longer used.

A key does not grant additional permissions. If its owner's roles or access change, API calls use the new scope.

Browse OpenAPI

Choose API documentation from the profile or keys page. Routes unavailable to the signed-in user are hidden.

Each operation documents:

• accepted fields and their format;
• required values;
• JSON body examples;
• possible responses and errors;
• expected permissions.

Configure a bot through sub-resources

Bot configuration is divided into specialised routes to avoid an excessively large request body: identity, AI, SIP, protection, skills and integrations. Use the sub-route for the part you are actually changing.

Trigger an outbound call

The public API does not provide a direct POST /api/v1/outbound-calls route. An external integration creates an outbound campaign, including when it needs to call only one contact. Send that contact in contacts and use schedule: true to make it immediately eligible, or add scheduled_at to select a future time.

The creation response contains the campaign and call identifiers. Then monitor each call with GET /api/v1/outbound-campaigns/calls/{call_id}. A scheduled status means the call is queued; it does not confirm that dialling started or that the recipient answered.

The Create an outbound campaign guide contains a complete JSON example. Actions initiated by bot skills use internal mechanisms tied to an existing conversation and are not accessible with a public API key.

Synchronise an Odoo connection language

Call POST /api/v1/bots/{id}/skills/odoo/languages with the connection parameters, or only its connectionKey when it is already saved. The response contains the active languages returned by Odoo. Then use one of those codes in connections[].executionLanguage with PATCH /api/v1/bots/{id}/skills/odoo. This language is injected into context.lang for every call and does not change the bot language. Secrets sent to the discovery route are not stored.

Best practices

• Never embed a key in browser-side code.
• Use HTTPS.
• Handle errors and rate limits.
• Do not blindly replay a creation request after a network timeout: first check whether your system already stored the returned identifiers.
• Test in the development environment.
• Do not log secrets or complete personal data.