Skip to main content
The Ochy web dashboard gives you a self-service interface to manage your API keys and webhook configuration. You must have an enterprise account to access these features. Navigate to Channels > API in the sidebar to access it.
Ochy API dashboard showing the API Key, Usage, Credits, and Webhooks tabs
The page has four tabs: API Key, Usage, Credits, and Webhooks.
Only organization admins can generate, rotate, or revoke API keys and configure webhooks.

​
API key management

Your API key authenticates every request to the Partner API. See authentication for how to pass it in your requests.

​
Generate a key

If your organization does not have an active key yet:
1

Open the API Key tab

Navigate to Channels > API in the sidebar, then select the API Key tab.
2

Click Generate API Key

The dashboard creates a new key and displays it in an orange banner at the top of the page.
3

Copy and store your key

Click the copy icon to save the key to your clipboard. Store it in a secure location such as an environment variable or a secrets manager.
The full key is shown only once, immediately after generation. If you navigate away without copying it, you will need to rotate the key to get a new one.

​
Rotate a key

Rotation revokes the current key and generates a replacement in a single step. Use this when you need a fresh key without downtime between revoke and generate.
1

Click Rotate Key

A confirmation dialog warns that existing integrations will stop working immediately.
2

Confirm the rotation

The old key is revoked and a new key appears in the banner. Copy it before leaving the page.
3

Update your integrations

Replace the old key in every service that calls the Ochy API.

​
Revoke a key

Revoking permanently deactivates the key. Any request using the revoked key will receive a 403 Invalid API Key error.
1

Click Revoke Key

A confirmation dialog explains that integrations using this key will stop working.
2

Confirm revocation

The key is deactivated. You can generate a new key at any time from the same tab.

​
Webhook configuration

Webhooks deliver real-time notifications when an analysis changes status, so you don’t need to poll the results endpoint. For full details on events, payload format, and ordering, see the analysis webhooks guide. You can configure your webhook either from this dashboard or via the API with PUT /webhook.

​
Set up a webhook

1

Open the Webhooks tab

Navigate to Channels > API and select the Webhooks tab.
2

Enter your endpoint URL

Provide an HTTPS URL where Ochy will send POST requests. For example: https://your-app.com/webhooks/ochy.
3

Save the webhook

Click Save Webhook. The webhook is enabled automatically.
The URL must use HTTPS. HTTP endpoints are not accepted.

​
Enable or disable

Once a webhook is configured, use the toggle switch on the Webhooks tab to enable or disable delivery without removing the URL.

​
Edit the URL

Click Edit URL to change the endpoint. After editing, click Update Webhook to save.

​
Test the webhook

Click Send Test Event to send a sample payload to your endpoint. The dashboard displays the HTTP status code and response latency so you can verify connectivity.
The test button is only available when the webhook is enabled. Toggle it on first if you need to test.

​
Events reference

When enabled, your endpoint receives POST requests for these analysis lifecycle events:
EventDescription
analysis.startedAnalysis begins processing
analysis.progressProcessing percentage updates (at each 10% milestone)
analysis.completedAnalysis finished successfully
analysis.failedAnalysis encountered an error
Each event payload includes the analysis_id, event_type, status, percentage, a monotonic sequence counter, and a timestamp. See payload format for the full schema.

​
Usage and credits

The remaining two tabs on the API page provide monitoring:
  • Usage — view your API request history and consumption patterns.
  • Credits — check your remaining analysis credits. Each analysis consumes one credit when started (see authentication).
To add credits, contact sales through the Ochy website or from your account.