Skip to main content

1. Create your API key

Go to app.ryvo.so/developers, click New API key, give it a name (for example “n8n production”) and copy the full token.
The token is shown only once. If you lose it, revoke that key and create a new one.

2. Find the agent_id

In the portal go to Agents and copy the ID of the agent you want to use. It looks like agent_xxx....

3. Trigger your first call

Expected response:

4. (Optional) Get the result by webhook

If you want to know how the call ended, set up a webhook in app.ryvo.so/developers. You will receive a POST with events like this one:
Read Webhooks → Verify signatures to confirm the event comes from Ryvo and not from an attacker.

Next steps

Error handling

The codes we return and what each one means.

Idempotency

How to avoid firing 2 calls when you retry.

Events

The full list of events and their payloads.

API reference

Every endpoint in detail.