docs(dosafe): update partner API for unified dos_sk_ key + correct base URL#1
Open
JOY (JOY) wants to merge 1 commit into
Open
docs(dosafe): update partner API for unified dos_sk_ key + correct base URL#1JOY (JOY) wants to merge 1 commit into
JOY (JOY) wants to merge 1 commit into
Conversation
…se URL
The DOSafe partner API docs were stale on three fronts. Brought them in
line with the live gateway + the dos_sk_ unification (DOS-AI #431).
partner-api.md:
- Base URL: app.dosafe.io/api -> api.dos.ai/v1/dosafe. The Next.js
/api/* proxy was removed 2026-04-22; the partner API is served by
the Go gateway at api.dos.ai/v1/dosafe/*. Verified there is no
/check, /detect, /report route under apps/app/src/app/api.
- Auth: X-Api-Key: dsk_... -> Authorization: Bearer dos_sk_... A single
self-serve dos.ai platform key (app.dos.ai/api-keys) now covers every
DOSafe route (DOS-AI #431). Added a migration note that dsk_ still
works during the transition. Dropped per-scope provisioning (dos_sk_
has full access).
- Removed the /detect-audio endpoint: it does not exist on the gateway
(verified main.go route list). Audio / voice-clone detection is the
Call ID voice anti-spoof analyzer at /voice/analyze, powered by
MamBo-3 - pointed readers there instead of the old BEATs+mHuBERT
/detect-audio.
- Added a Pricing & Quota section (free 100/day, then per-call A/B/C
overage from the credit balance, link to dos.ai/pricing +
app.dos.ai/billing). Matches DOS-AI #429.
- Rewrote Getting API Keys: self-serve at app.dos.ai/api-keys instead
of "contact the team".
- Error table: added 402 (insufficient credits) + 429 (free-tier
exhausted, billing unavailable); clarified 403 applies to legacy
dsk_ scopes only.
- Updated the code example + trust-API migration table to the new base
URL + Bearer header.
overview.md:
- Made dos_sk_ Bearer the primary auth (was "X-Api-Key, alternatively
dos_sk_"); demoted X-Api-Key to a legacy transition note.
- Updated the curl examples to the Bearer header.
Also replaced all en-dashes/em-dashes with hyphens in both files (house
style: ASCII hyphen only in user-facing text).
Refs: DOS-AI #431 (unify dos_sk_), #429 (dos.ai/pricing), #436 (free
quota), #440 (detector compose). Base URL + route facts verified against
services/api-gateway/main.go.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Author
Author hand-off (for DOS.AI-Docs maintainers)Authored by JOY's Claude Code session - handed to the team to review + merge (cross-repo policy; I won't self-merge). Docs-only update aligning the DOSafe partner API pages with the live gateway + the Two judgment calls for reviewers:
No code/behaviour - GitBook content only. |
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The DOSafe partner API docs were stale. Brought them in line with the live gateway + the
dos_sk_unification (DOS-AI #431).dosafe/partner-api.mdapp.dosafe.io/api->api.dos.ai/v1/dosafe. The Next.js/api/*proxy was removed 2026-04-22; the partner API is served by the Go gateway. Verified no/check,/detect,/reportroute exists underapps/app/src/app/api.X-Api-Key: dsk_...->Authorization: Bearer dos_sk_.... One self-serve dos.ai platform key (app.dos.ai/api-keys) now covers every DOSafe route (DOS-AI #431). Migration note kept (dsk_ still works during transition). Dropped per-scope provisioning./detect-audio: does not exist on the gateway (verifiedmain.goroutes). Audio / voice-clone detection is the Call ID voice anti-spoof analyzer at/voice/analyze(MamBo-3) - readers pointed there.dosafe/overview.mddos_sk_Bearer the primary auth (was X-Api-Key first); demoted X-Api-Key to a legacy note.House style
Replaced all en/em-dashes with ASCII hyphens in both files.
Fact verification (read from source, not assumed)
services/api-gateway/main.godosafev1 := r.Group("/v1/dosafe", ...)onapi.dos.ai./detect-audioroute;/voice/analyzeexists.dos_sk_accepted on dosafe routes).Test plan
api.dos.ai/v1/dosafe/...Authorization: Bearer dos_sk_...Refs
🤖 Generated with Claude Code