Skip to main content
OneShot publishes a complete OpenAPI 3.1 spec covering every public endpoint — tools, payments, compute orchestration, soul marketplace, analytics, and the Stripe Agent Commerce Protocol surface. 82 operations across 19 tag groups, fully versioned.

​
Endpoints

EnvironmentOpenAPI JSONInteractive docs
Productionhttps://win.oneshotagent.com/openapi.jsonhttps://win.oneshotagent.com/docs
Staginghttps://api-stg.oneshotagent.com/openapi.jsonhttps://api-stg.oneshotagent.com/docs
The spec is regenerated on every deploy from the same Zod schemas the API uses at runtime — there is no drift between what the spec describes and what the server accepts.

​
Authentication schemes

Every operation declares its required auth as one of four security schemes:
SchemeUsed byHeader
x402PaymentPaid tool endpoints (email, voice, research, etc.)Authorization: <signed payment header> + X-Quote-ID
agentIdFree read-only endpoints (balance, analytics, inbox, notifications)X-Agent-ID: 0x…
soulKeySoul marketplace seller dashboardAuthorization: Bearer soul_…
acpBearerStripe Agent Commerce Protocol checkoutAuthorization: Bearer … + API-Version: 2026-01-30
Each operation also exposes an x-payment-info vendor extension so agent crawlers can decide whether payment is required before issuing the request.

​
Generating an SDK

The spec follows OpenAPI 3.1 conventions and uses $ref for shared schemas, so every mainstream client generator works out of the box. 
npx @openapitools/openapi-generator-cli generate \
  -i https://win.oneshotagent.com/openapi.json \
  -g typescript-fetch \
  -o ./oneshot-client
For most use cases you should use the official @oneshot-agent/sdk instead of generating your own client — it handles x402 payment signing, async polling, and ETH→USDC swaps automatically.

​
Importing into other tools

  • Postman — File → Import → paste https://win.oneshotagent.com/openapi.json
  • Insomnia — Application → Preferences → Data → Import Data → From URL
  • ChatGPT Custom Actions — paste the JSON URL directly into the actions UI
  • Claude / OpenAI Assistants — provide the URL or JSON as a tool definition

​
What’s in the spec

TagOperationsDescription
Email3Quote, send, analytics
SMS1Send (single + bulk)
Voice1AI voice calls
Research9Deep research + people / company / article search
Enrichment3Email, profile, company enrichment
Verification1Email deliverability
Search2Web search + page reading
Commerce2Search + buy
Build1Generate websites
Browser4Browser automation + persistent profiles
Balance1Agent balance
Notifications3List + mark read
Inbox4Inbound email + SMS
Soul Marketplace25Browse, hire, manage souls
Compute9Multi-step goal orchestration
Analytics4Spend, ROCS, receipts
Jobs1Async job status polling
Stripe ACP6Agent Commerce Protocol checkout
Meta2Health + stats
The spec is the single source of truth for the OneShot API surface. If something is documented here, it works. If it’s not in the spec, it’s either internal infrastructure or hasn’t shipped yet.