Skip to documentation

Opsis API / v1

Account & discovery

Check your account, live limits, service health, and OpenAPI schema.

Check your account

GET/v1/me

Authenticated account information: plan, API access, supported search types, create-request rate limit, subscription balance, prepaid balance, and spendable API credits. This is a useful first request for a new integration.

shell
curl https://api.useopsis.com/v1/me \
  -H "Authorization: Bearer $OPSIS_API_KEY"

Discover the live contract

GET/v1/capabilities

Public endpoint; no key required. Returns search types, response modes, result fields, configured limits, Premium coverage, source counts when available, and documentation links.

shell
curl https://api.useopsis.com/v1/capabilities

Check contract_revision, stream_expiry_event, durable_results, and idempotent_submission when planning persistence or retry behavior. Do not infer these capabilities from HTTP 200 alone.

Check service health

GET/v1/health

Public liveness and lightweight database check. Inspect the body’s status (ok or degraded) and database (ok or error). This is not an individual-module health report.

shell
curl https://api.useopsis.com/v1/health

OpenAPI and interactive reference

Use the OpenAPI JSON schema to inspect typed models or generate a client. The backend also hosts Swagger UI and ReDoc.

These live on api.useopsis.com, separate from this documentation site. Focus your integration on the public /v1 endpoints.