Skip to main content

Base URL

The current public endpoint is:
https://app.pixy.art/api/v1
Send your Automation key in the Authorization header.
Authorization: Bearer YOUR_API_KEY
Get Automation key

Test Your Automation Key

The fastest way to verify your Automation key is working is to call the /me endpoint.
import { Pixy } from '@pixy-art/sdk'

const pixy = new Pixy({
  apiKey: 'YOUR_API_KEY',
})

const me = await pixy.me()

console.log(me.user)
If the key is valid, the API responds with your user context instead of 401 Unauthorized.

Automation Key vs Embed Key

Use an Automation key for server-side Automation API requests. Use an embed key for client-side embedded editor sessions.
Do not use your Automation key in browser-side embed code.
Get Embed key

Notes

Keep Automation keys server-side whenever possible.
Rotate keys if you believe they have been exposed.
Use separate keys for staging and production environments.