docs
API Reference
Authentication

Authentication

ObservIQ uses Bearer token authentication. Every API request must include your API key in the Authorization header.

Getting Your API Key

  1. Register at observ-iq.netlify.app/signup (opens in a new tab)
  2. Your API key is shown once after registration — copy it immediately
  3. Keys follow the format: oiq_ followed by 64 hex characters

Using Your API Key

curl https://your-backend.railway.app/teams/me \
  -H "Authorization: Bearer oiq_your_key_here"
import requests
 
headers = {"Authorization": "Bearer oiq_your_key_here"}
response = requests.get("https://your-backend.railway.app/teams/me", headers=headers)
print(response.json())
⚠️

Never expose your API key in client-side code. Always use it server-side or via the Python SDK.

Endpoints

POST /teams/register

Create a new team and receive your API key.

Request:

{
  "name": "My Startup",
  "email": "dev@mystartup.com"
}

Response:

{
  "id": "uuid",
  "name": "My Startup",
  "email": "dev@mystartup.com",
  "api_key": "oiq_a1b2c3...",
  "plan": "free",
  "message": "Save your API key now — it won't be shown again!"
}

GET /teams/me

Get your team information. Used to verify your API key.

Response:

{
  "id": "uuid",
  "name": "My Startup",
  "email": "dev@mystartup.com",
  "api_key_prefix": "oiq_a1b2c3d4",
  "plan": "free",
  "created_at": "2026-06-25T14:32:01Z"
}

Error Responses

StatusMeaning
401Missing or invalid API key
400Bad request (e.g. email already registered)
500Server error