ORYKSA API, webhooks and developer portal

The ORYKSA API lets developers use your AI employee from their own apps, websites and systems: send customer messages and get replies, keep the knowledge (Brain) in sync, report conversions, and receive webhooks when the AI replies or books an appointment.

Where to start: full documentation in English, Portuguese and Spanish at developer.oryksa.com, with an OpenAPI file, a Postman collection and a "Try it" console.

Create an API key

1. Sign in at developer.oryksa.com with your ORYKSA account and open Keys.
2. Type a name (for example "iOS app") and click Create key.
3. Copy the key right away. For security it is shown only once.

Revoke a key at any time: apps using it stop working immediately. Keep keys on a server, never inside a website or an app.

Webhooks

In the same place add the address (https) that should receive events and pick the events: message replied, booking created, plan limit reached, knowledge updated. Save the signing secret shown once, and use Test to check the delivery.

Conversions

Your site or app can tell ORYKSA when a conversation turned into a result with POST /v1/conversions (sale, lead, signup or booking). You get an alert, and ORYKSA can answer you about it in your dashboard chat.

Plans

The API is a web channel, like the website chat. Each AI reply counts as one interaction of the plan, with the same limits as WhatsApp.