Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.oneinbox.ai/llms.txt

Use this file to discover all available pages before exploring further.

Base URL

All examples in this documentation use:
https://api.oneinbox.ai
Use this URL in the dashboard, your backend, and browser apps.

Dashboard or browser cannot reach the API

If requests from https://oneinbox-dashboard.vercel.app (or your site) fail in the browser but curl works, check two separate browser rules:
SymptomLikely causeFix
Mixed Content in the consoleHTTPS page calling an HTTP APIUse https://api.oneinbox.ai — browsers block HTTP API calls from HTTPS pages
blocked by CORS policyAPI not returning CORS headersOneInbox returns Access-Control-Allow-Origin: * — redeploy backend v0.2.6+ if you still see CORS errors
CORS and HTTPS are different fixes. Wildcard CORS allows cross-origin reads once the request is allowed. HTTPS is still required so the browser sends the request at all.
  1. HTTPS on api.oneinbox.ai — TLS on port 443 with a reverse proxy (Caddy, ALB, or Cloudflare) forwarding to the API process.
  2. Dashboard env — set the API base URL to https://api.oneinbox.ai (no port in the URL when the proxy handles it).
  3. CORS — already enabled with wildcard origin on the API.

Temporary: curl and server-side only

If HTTPS on port 443 is not live yet, you can still test with curl, Postman, or a backend server using:
http://api.oneinbox.ai:8000
Do not use that HTTP URL from the dashboard or any JavaScript running in the browser.

401 Unauthorized

CheckAction
Header formatAuthorization: Bearer <api_key> — include the word Bearer and a space
Key sourceCreate or copy the key from Dashboard → API Keys
Revoked keyCreate a new key if the old one was deleted

Local docs preview

Run the Mintlify dev server from the docs repo:
cd mintlify
npm install
npm run dev
Open http://localhost:3333 — not port 3000 (often used by Next.js apps).
From the mintlify folder:
npx mintlify broken-links
Fix any reported paths before publishing.