Getting Started

Welcome to the API documentation. This guide covers authentication, available endpoints, and common usage patterns.

Base URL

https://api.example.com/v1

Authentication

All API requests require a Bearer token in the Authorization header. Obtain your token from the dashboard.

curl -H "Authorization: Bearer YOUR_TOKEN" \
     https://api.example.com/v1/status

Response Format

All responses are JSON. Successful responses include a data field. Errors include error and message fields.

{
  "status": "ok",
  "data": { "version": "1.0", "uptime": "72h" }
}