Quickstart Guide

Get up and running with the Browsable API in just a few minutes.

1. Get Your API Key

First, sign up for a Browsable account and get your API key from the dashboard:

1. Go to browsable.app
2. Click "Get your free API key" to sign up
3. Navigate to the API Keys page in your dashboard
4. Copy your API key

2. Make Your First Request

Let's make a simple request to search Reddit:

If you're wiring this up with generated code or an agent, use the machine-readable docs at /openapi.json and /llms.txt.

curl -X POST "https://api.browsable.app/v1/reddit/search" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"programming","_run":{"async":false}}'

3. Understanding the Response

The API returns a JSON response with the following structure:

4. Async vs Sync Mode

By default, API requests run asynchronously. For immediate results, send "_run": {"async": false} in the JSON body:

# Async mode (default) - returns immediately with run_id
curl -X POST "https://api.browsable.app/v1/reddit/search" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"programming"}'

# Sync mode - waits for results (max 25 seconds)
curl -X POST "https://api.browsable.app/v1/reddit/search" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"programming","_run":{"async":false}}'

In async mode, you'll receive a run_id that you can use to check the status later:

# Check run status
curl -X GET "https://api.browsable.app/v1/runs/RUN_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

5. Next Steps