API Overview
The GoVeda API provides programmatic access to patent data, semantic and prior art search, novelty reports, and usage records. Use this guide to set up access and make your first request.
Use the API Reference as the source of truth for interface details that change with the API. This guide stays focused on setup and workflow selection.
Direct REST API access does not require an OpenPatent Pro Subscription. It uses a separate API Credit balance, and eligible accounts receive 10,000 non-expiring API credits after creating their first key.
Make your first request
Create an API key
Open Settings > API Management , create a key, and copy it when it appears. The full value is shown only once. See Manage API keys for expiration, rotation, and revocation guidance.
Store the key outside your code
For a local shell session, read the key without displaying it or saving it in your shell history. Paste the key, press Enter, then export the variable:
read -s GOVEDA_API_KEY
export GOVEDA_API_KEYDo not commit API keys to source control or include them in client-side code.
Check your balance
Call the usage balance endpoint to confirm that authentication works:
curl https://openapi.goveda.com/api/usage/balance \
--header "X-API-Key: $GOVEDA_API_KEY"A successful response confirms that the key works. Read the direct API balance from pools.api; the top-level balance fields are retained for the web credit pool. If authentication fails, consult Authentication and common errors .
Choose a workflow
| What you want to do | Start here | How it runs |
|---|---|---|
| Retrieve patent content, translations, ownership changes, or citations | Patent API | Synchronous |
| Search by meaning, prior art, or assignee | Search API | Synchronous or asynchronous |
| Generate a novelty and patentability report | Report API | Asynchronous |
| Monitor balance, usage records, or usage trends | Usage API | Synchronous |
For asynchronous operations, keep the returned ID and poll the corresponding status endpoint until the operation completes or fails. The API Reference identifies the request body, status endpoint, terminal states, and response schema for each workflow.
Operational reference
The API Reference maintains dedicated sections for:
- Authentication and error codes
- Rate limits and retry behavior
- Current operation pricing
- Breaking changes and release history
Data retention
By default, a synchronous POST /api/search/v2 response includes a persistent search ID and the search appears in your history. When Zero Data Retention is enabled in API Management, the search is not stored and its id is only a request ID for support correlation. Asynchronous searches and reports created while the setting is enabled remain available for retrieval for up to 12 hours. See the API Data Retention policy for the complete scope.