Quickstart - Playbook API

This guide will get you up and running with the Airclou API in just a few minutes. We’ll walk through creating an API key, making your first request, and exploring the available endpoints.

Prerequisites

Before you begin, make sure you have:

An Airclou account (sign up if you don’t have one)
Basic knowledge of REST APIs
Your preferred HTTP client (cURL, Postman, or an SDK)

Create an API key

First, you’ll need to create an API key to authenticate your requests:

Log in to your Airclou dashboard
Navigate to Settings → API Keys
Click Create API Key
Give your key a descriptive name (e.g., “Development Key”)
Copy the key immediately — you won’t be able to see it again!

# Your API key will look something like this
ac_live_1234567890abcdef1234567890abcdef

Important: Keep your API keys secure. Never share them publicly or commit them to version control.

Make your first request

Now let’s make a simple request to verify your API key works. We’ll fetch your user profile:

curl https://app.airclou.com/playbook/api/v1/users/me \
  -H "Authorization: Bearer YOUR_API_KEY"

You should receive a response like this:

{
  "id": "usr_1234567890",
  "email": "you@example.com",
  "name": "John Doe",
  "created_at": "2025-01-15T10:30:00Z",
  "role": "owner"
}

Understanding the response

All API responses follow a consistent structure:

Success responses (2xx status codes) return the requested data
Error responses (4xx/5xx status codes) return an error object with details
All timestamps are in ISO 8601 format
All responses include proper HTTP status codes

Next steps

Now that you’ve made your first request, explore these resources:

Authentication — Learn about API keys and security best practices
Pagination — Handle large result sets efficiently
Error Handling — Understand error codes and how to handle them
Users API — Manage users in your organization

Rate limits

The Airclou API has the following rate limits:

100 requests per minute for free accounts
1,000 requests per minute for paid accounts
10,000 requests per minute for enterprise accounts

When you exceed your rate limit, you’ll receive a 429 Too Many Requests response. The response headers include information about when you can retry:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1735824000

Need help?

If you run into any issues: