API client
Every hosted reference has Try it: a form for each operation that sends a real request to your API and shows the answer, checked against the response schema your document gives. Readers bring their own credentials.
Two ways to send
- Direct, on every plan: the request goes from the reader's browser straight to your API, so your API must answer CORS for our origin.
- Through the proxy, on Pro and up: for an API without CORS, our server makes the request to a host you've verified and hands the answer back.
Direct and proxy says what each one sends and refuses.
Who has it
Members always have Try it in the workspace. Readers of the published reference have it unless an owner or admin turns it off on the project's Try it page, which is also where the proxy is switched on.
In this section
- Direct and proxy: the two modes, their limits and errors.
- CORS for Try it: the headers your API sends for direct mode.
- Verified hosts: proving you control a host the proxy may call.
- Shared collections: saved requests, and Examples for readers.
- Import and export: our format both ways, and Postman out.
- Secrets: what a saved request may never hold.
Where this comes from
app/reference/_lib/playground/client.tsapp/reference/_lib/playground/proxy.tsapp/r/_lib/respond.tsapp/workspace/[ws]/[project]/playground/page.tsx