Getting Started

This guide takes you from zero to your first authenticated request in a few minutes: create an API key in the Evinor app, then call GET /v1/sensors.

• Base URL: https://api.evinor.ai
• Transport: HTTPS only — plain HTTP is not served.
• Authentication: every request carries an API key as a bearer token.

1. Create an API key

API keys are managed from the Evinor web app, under Settings → API keys:

1. Sign in to the Evinor app and open Settings.
2. Select the API keys section.
3. Click Create API key.
4. Give the key a descriptive name (so you can recognize it later) and choose its scopes:
   • Sensors: read (SENSORS_READ) — list and read sensors.
   • Sensors: write (SENSORS_WRITE) — create, update, enable, disable, delete, and rotate the signing secret of sensors.
5. Click Create.

A key's scopes are fixed at creation and cannot be edited afterward — to change scopes, create a new key and revoke the old one. You can hold up to 10 active keys at a time.

One-time reveal

The raw key is shown exactly once, immediately after creation. Copy it and store it somewhere safe (a secrets manager or an environment variable) before you dismiss the dialog — Evinor stores only a hash of the key and can never show it to you again. If you lose it, revoke the key and create a new one.

2. Make your first request

Every request sends the key in the Authorization header as a bearer token. List the sensors on your account:

curl https://api.evinor.ai/v1/sensors \
  -H "Authorization: Bearer evnr_live_your_key_here"

A successful response is a cursor-paginated envelope:

{
  "data": [
    {
      "id": "a1b2c3d4-...",
      "object": "sensor",
      "name": "Series B fundraising in fintech",
      "description": null,
      "enabled": true,
      "created_at": "2026-07-01T09:12:33.000Z",
      "updated_at": "2026-07-01T09:12:33.000Z",
      "filter": {
        "incident_template_id": "…",
        "involved_entity_canonical_ids": [],
        "involved_entity_list_ids": [],
        "required_source_news_outlet_ids": [],
        "min_reports": 1
      }
    }
  ],
  "has_more": false,
  "next_cursor": null
}

If the account has no sensors yet, data is an empty array. See Pagination for how to page through larger result sets.

3. Explore the full API

The complete, interactive endpoint reference — every operation, its parameters, request and response schemas, and per-language code samples — lives at API Reference.

Next steps

• Authentication — key format, header usage, and rotation.
• Errors — the RFC 9457 problem format every error uses.
• Rate limits — the per-key request budget and its headers.
• Receiving webhooks — verify and consume signed sensor deliveries.