---
title: "The Try It playground"
url: "/help/buuk/try-it-playground"
updated: "2026-10-22T11:13:53.341Z"
---
# The Try It playground

Every HTTP operation in the generated API reference carries a **Try it** panel beside its documentation: on wide screens it sits in a sticky rail on the right, and on small screens it collapses behind a disclosure. Fill in the request, press **Send request**, and read the real response — status, timing, headers, and body.

## Environments

Requests need a base URL. Add named environments — the first three default to Production, Sandbox, and Staging — each with its own base URL, and the active one drives both the request and the code samples on the same page. Environments live in the reader's browser, not in the workspace, so every teammate keeps their own list.

## Fill in the request

- **Path parameters **are always marked required; the request stays disabled until you fill them in.
- **Query and header parameters **take plain values. Array parameters serialize the way your spec documents them — exploded into repeated keys, or joined with commas.
- **Request bodies **start from the example in your spec: plain JSON gets a prefilled editor, while `multipart/form-data` and `application/x-www-form-urlencoded` bodies render as fields with file pickers for binary inputs.
- **Auth header **takes a full header such as `Authorization: Bearer …`. It is kept in this browser tab only — never stored long-term.

> [!WARNING]
> Try It sends real requests. A `DELETE` against production deletes for real. Point the panel at a sandbox environment whenever an operation changes state.

## Authorization and OAuth

If your spec declares OAuth or OpenID Connect security schemes, the panel shows an **Authorize** block for each scheme: OAuth2 authorization code, OAuth2 implicit, or OpenID Connect discovery.

1. Enter your **Client ID** — pre-filled when the spec carries a client-id extension — and the **Scopes** you want, comma or space separated.
2. Press **Sign in**. Buuk opens the provider in a popup, using the authorization URL from your spec or discovered from the OpenID Connect configuration.
3. Approve the request in the popup. The access token lands back in the panel automatically and fills the auth header, and the status line reads Signed in via OAuth.

If the popup never appears, the status tells you so — allow popups for the site and press **Sign in** again. A failed authorization shows the provider's error in the same spot.

## Response schema validation

After a request, the response card shows the status code, the round-trip time in milliseconds, a headers toggle, and the pretty-printed body. Then a **Schema validation** section compares the response body against the schema your spec documents for that status: a green line when it matches, and itemized errors or warnings — each traced to a field path — when it does not. Out-of-date APIs and out-of-date docs usually agree about that at the same time.

## Where results are kept

Nothing you send or receive is stored in the workspace. Each response lives in the panel until you leave the page; the auth header survives in the tab for the browser session; environments persist in the reader's browser. Sharing a link to an operation shares the documentation, never your tokens.

Requests leave from Buuk's servers through a proxy, not from your browser directly. The proxy rate-limits, refuses private and local addresses, caps bodies and uploads, and times out slow endpoints, so a curious reader cannot turn your docs into a port scanner.

## Related

- Getting the spec that powers this panel: [Import an OpenAPI spec](./import-openapi).
- The example requests beside every operation: [Code samples and SDKs](./code-samples-and-sdks).
- Minting real tokens for your API: [API tokens and MCP](./api-tokens-and-mcp).
- Spec types without HTTP traffic: [Other reference types](./other-reference-types).