Developer Tools
Create API keys, monitor jobs, review usage, and configure webhooks.
Developer tools live under /{your_org_name}/developers. They are for teams that use Covara programmatically or need operational visibility into extraction work.
API keys
Create, scope, copy, and revoke keys for the Covara API.
Jobs
Monitor extraction jobs, status, attempts, duration, token usage, and cost.
Webhooks
Receive job progress, completion, and failure notifications.
API Keys
Open /{your_org_name}/developers/api-keys.
Click Create Key
Name the key for the system that will use it, such as broker-portal-prod.
Choose scopes
Select only the scopes the integration needs.
Copy the secret once
Covara shows the secret after creation. Store it securely because it cannot be viewed again.
Revoke old keys
Revoke keys that are no longer used or may have been exposed.
Available API Scopes
| Scope | Use it for |
|---|---|
agent:read | Read Vara sessions and messages. |
agent:write | Send messages to Vara. |
documents:read | List documents and inspect processing status. |
documents:write | Create document uploads and URL ingestions. |
reports:read | Read policy reports through Vara. |
reports:compare | Compare reports through Vara. |
extract:read | List policy types and view schemas. |
extract:write | Submit synchronous extraction requests. |
jobs:read | View job status and results. |
jobs:write | Create async extraction jobs. |
usage:read | View token usage and billing data. |
Treat API keys like passwords
Do not paste keys into tickets, chat, or client-side code. Store them in your server-side secret manager.
Jobs And Usage
Open /{your_org_name}/developers/usage. This page is labeled Jobs in the workspace navigation.
The page shows recent extraction jobs with policy type, source, status, attempts, creation time, and duration. It also summarizes token usage, cost, embedding tokens, structured output tokens, and RAG chunk counts when available.
Jobs can be queued, processing, completed, failed, cancelled, or pending. Processing and queued jobs may update automatically when realtime notifications are enabled.
The source column helps distinguish work started from the web app from work started through the API.
Use refresh when you need the latest state immediately. Covara also refetches on reconnect and window focus.
Webhooks
Open /{your_org_name}/developers/webhooks.
Webhooks notify another system when extraction work changes. Add an HTTPS endpoint, choose events, and store the signing secret shown after creation.
| Event | Meaning |
|---|---|
job.completed | Document extraction completed successfully. |
job.failed | Document extraction failed after retries. |
job.progress | Extraction progress changed, such as 25%, 50%, or 75%. |
You can pause, activate, or delete endpoints from the table. Pausing keeps the endpoint configuration but stops delivery until you reactivate it.
API Reference
Use the API Reference for request and response details. Public docs live under www.covara.ai/docs, and docs.covara.ai redirects there.