Skip to content
Submit a Support Ticket
  • There are no suggestions because the search field is empty.

How do I authenticate with the Sophiie API?

Every documented Sophiie API endpoint is authenticated with an API key sent as a bearer token. You generate the key at Settings → Workspace → API token in your dashboard.

Steps

  1. Go to Settings → Workspace → API token. You'll need to be an owner or admin on a paid plan to generate a key.
  2. Generate your API key. The key itself is your bearer token — there's no separate token-exchange step.
  3. Add the key to the Authorization header of every request. Here's how with cURL:

`` curl https://api.sophiie.ai/v1/... \ -H "Authorization: Bearer xxxx" ``

Always keep your API key safe. If you suspect it has been compromised, disable it (reversible) or revoke it (permanent) from the same page.

Live and test keys

  • Production keys start with sk_live; non-production keys start with sk_test.
  • The production server is https://api.sophiie.ai. A development server is available at https://api.dev.sophiie.ai.

What an authentication error looks like

Errors come back in a consistent envelope: {"success": false, "message": ..., "error": {"status": ..., "message": ...}}. The ones you'll meet while authenticating:

| Status | Message | What it means | |---|---|---| | 401 | Invalid or expired token | The key is missing, unknown or expired | | 401 | API key expired. | The key has passed its expiry | | 403 | API key is disabled. | The key was disabled — re-enable it or use another | | 403 | Insufficient permissions. | The key isn't allowed to do what you asked | | 429 | Rate limit exceeded. Please try again later. | You've hit the rate limit — check the Retry-After header | | 429 | Plan usage exceeded. | Your plan's usage allowance is used up |

Common Questions

Do any endpoints work without a key?

No. Every documented v1 endpoint requires the bearer token — there's no point testing unauthenticated calls.

What's the API rate limit?

60 requests per minute per API key, the same for everyone on every plan, and it can't be raised. If you're hitting 429s, slow your requests down and respect the Retry-After header.

Where can I read the full API docs?

The authentication reference lives at https://docs.sophiie.ai/docs/api-reference/auth.

Need More Help?

If you can't see the API token page or your key isn't behaving as documented, ask Sophiie Assistant in your dashboard first — she can guide you. Still stuck? Email support@sophiie.ai or call +61 7 5620 4640.