Quick Start

1. Open API Studio

There are three ways to open the panel:

2. Understanding the UI

The panel is split into key areas. Here's what each part does:

3. Send Your First Request

1. 1

   In the URL bar, enter:

   https://jsonplaceholder.typicode.com/posts/1

2. 2 Leave the method as GET (default)
3. 3 Click Send or press Cmd+Enter

The response appears on the right with a green 200 OK status.

POST https://jsonplaceholder.typicode.com/posts
Body (JSON):
{
  "title": "Hello from API Studio",
  "body": "Testing the offline API client",
  "userId": 1
}

4. Reading the Response

The Request tab shows exactly what was sent — useful for debugging auth and variable issues

5. Create an Environment

Environments let you use {{variables}} in your URLs, headers, and body — switch between dev/staging/production without editing requests.

1. 1 Click the Environments tab in the sidebar
2. 2 Click + New Environment, name it "Development"
3. 3 Add a variable: key = base_url, value = https://jsonplaceholder.typicode.com
4. 4 Select it from the environment dropdown in the top bar
5. 5 Now use {{base_url}}/posts/1 in the URL bar

Variables are color-coded: green = resolved, orange = unresolved (not found in active environment)

6. Save to a Collection

Collections organize your requests into named groups with folders. Saved requests can be re-opened, run in batch, and shared via git.

1. 1 Click the Collections tab in the sidebar
2. 2 Type a name (e.g. "JSONPlaceholder") and press Enter to create a collection
3. 3 In the request builder, click Save (or Cmd+S)
4. 4 Pick the target collection and folder, give the request a name

Collections are stored in .openpost/collections.json — commit this to share with your team

7. Export Code

Generate ready-to-use code from any request in 15 languages.

1. 1 Click the </> button in the request builder (next to Send)
2. 2 Choose a language from the dropdown (cURL, Python, JavaScript, Go, etc.)
3. 3 Click Copy to clipboard — variables are resolved in the output

8. Try More Protocols

API Studio isn't just REST. Use the protocol selector to switch modes:

https://countries.trevorblades.com/graphql

wss://echo.websocket.org

https://sse.dev/test

grpc://localhost:50051