Skip to main content

Quickstart

This quickstart shows the basic request shape you will use when calling the Pixy API.

1. Get an API key

Create or copy an API key from your Pixy workspace.

2. Send a request

curl https://your-api-domain.example.com/api/example \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

3. Read the response

Most responses use JSON.
{
  "success": true
}

Next Steps

  • Review Authentication
  • Add your OpenAPI spec for generated endpoint pages
  • Expand the API reference with real request and response examples