Opsis API / v1

Quickstart

Create a key, submit a search, and read your first results.

1. Create a secret key

Open API keys, name your integration, and create a key. Copy it before closing the message—it is only shown once. Store it as OPSIS_API_KEY in your server’s environment or secret manager.

API access requires an eligible Pro or Unlimited plan. For Pro, add API credits or explicitly enable subscription-credit fallback before starting a search.

2. Verify your connection

Check your key, API eligibility, and balance without spending search credits.

cURL · account check

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

Look for api_access: true and check available_api_credits. Keep your secret key on your backend, never in browser JavaScript.

3. Submit a search

Send a search type and query. This example uses a fictional address; replace it with an input you’re authorized to investigate.

cURL · create an email search

curl -X POST https://api.useopsis.com/v1/searches \
  -H "Authorization: Bearer $OPSIS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"email","query":"[email protected]"}'

Example response

{
  "run_id": "00000000-0000-4000-8000-000000000001",
  "status": "running"
}

Save the returned run_id. Submission spends credits; checking the existing run does not.

4. Read the results

Use the real run ID returned above in place of this example ID. Poll every 2–5 seconds until status is completed or failed, respecting rate limits.

cURL · retrieve the same run

curl https://api.useopsis.com/v1/searches/00000000-0000-4000-8000-000000000001 \
  -H "Authorization: Bearer $OPSIS_API_KEY"

Results arrive in results; progress tracks module completion. Inspect coverage and results_available before interpreting an empty response as no findings.

For live interfaces, stream results instead of polling. You can attach a stream to this same run without starting another search.