Skip to content

docs(dosafe): update partner API for unified dos_sk_ key + correct base URL#1

Open
JOY (JOY) wants to merge 1 commit into
mainfrom
docs/partner-api-unify-key
Open

docs(dosafe): update partner API for unified dos_sk_ key + correct base URL#1
JOY (JOY) wants to merge 1 commit into
mainfrom
docs/partner-api-unify-key

Conversation

@JOY
Copy link
Copy Markdown
Contributor

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.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. Verified no /check, /detect, /report route exists under apps/app/src/app/api.
  • Auth: 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.
  • Removed /detect-audio: does not exist on the gateway (verified main.go routes). Audio / voice-clone detection is the Call ID voice anti-spoof analyzer at /voice/analyze (MamBo-3) - readers pointed there.
  • Added Pricing & Quota: free 100/day, then per-call A/B/C overage from credit balance; links to dos.ai/pricing + app.dos.ai/billing (matches DOS-AI #429).
  • Getting API Keys: self-serve, not "contact the team".
  • Error table: added 402 (insufficient credits) + 429; clarified 403 = legacy dsk_ scopes only.
  • Updated code example + trust-API migration table to new base URL + Bearer.

dosafe/overview.md

  • Made dos_sk_ Bearer the primary auth (was X-Api-Key first); demoted X-Api-Key to a legacy note.
  • Updated curl examples to Bearer.

House style

Replaced all en/em-dashes with ASCII hyphens in both files.

Fact verification (read from source, not assumed)

  • Base URL + routes: services/api-gateway/main.go dosafev1 := r.Group("/v1/dosafe", ...) on api.dos.ai.
  • No /detect-audio route; /voice/analyze exists.
  • Auth scheme: DOS-AI #431 (Bearer dos_sk_ accepted on dosafe routes).

Test plan

  • GitBook renders both pages without broken tables/links
  • All endpoint URLs read api.dos.ai/v1/dosafe/...
  • Auth examples use Authorization: Bearer dos_sk_...
  • Pricing section links resolve (dos.ai/pricing, app.dos.ai/billing, app.dos.ai/api-keys)

Refs

  • DOS-AI #431 (unify dos_sk_), #429 (pricing), #436 (free quota), #440 (detector compose)

🤖 Generated with Claude Code

…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.
@vercel
Copy link
Copy Markdown

vercel Bot commented May 22, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
dos-ai-docs Ready Ready Preview, Comment May 22, 2026 1:09pm

@JOY
Copy link
Copy Markdown
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 dos_sk_ unification (DOS-AI #431). Every factual change was verified against services/api-gateway/main.go (base URL api.dos.ai/v1/dosafe, no /detect-audio route) and the unify PR, not assumed.

Two judgment calls for reviewers:

  1. I kept the dsk_ legacy keys mentioned as "still works during transition". If dsk_ is already dead in your mind (0 keys in prod), I can drop the migration notes entirely.
  2. The Pricing & Quota table mirrors partner_overage_pricing statically - same staleness caveat as the dos.ai/pricing page (DOS-AI #429). If you'd rather link out only, say so.

No code/behaviour - GitBook content only.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant