Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.streampixel.io/llms.txt

Use this file to discover all available pages before exploring further.

All Streampixel API endpoints require an API key for authentication. The key is passed in the request body — not as an Authorization header.

​
Generate an API key

1

Log in to the dashboard

Go to dashboard.streampixel.io and sign in.
2

Open your account menu

Click your account name in the top-right corner.
3

Request the key

Click the Request API Key button.
4

Check your email

The key is sent to your registered email address.
Your API key is shown only once. Copy and store it securely — you won’t be able to view it again.
Requesting a new API key automatically invalidates the previous one. Any integration still using the old key will stop working immediately.

​
Use the API key

Include apiKey in the JSON body of every request: 
curl -X POST https://api.streampixel.io/pixelStripeApi/projects/upload-file \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your-api-key-here",
    "userId": "your-user-id",
    "projectId": "your-project-id",
    "fileUrl": "https://storage.example.com/build.zip"
  }'

​
Authentication errors

StatusMessageCause
401Unauthorized: Invalid API KeyKey is wrong or has been invalidated
401Invalid UseruserId doesn’t match any account
Receiving a 401? Generate a new API key from the dashboard and update your integration.

​
Security best practices

  • Never expose your API key in frontend code, public repos, or client-side bundles.
  • Store it in environment variables or a secrets manager.
  • Rotate the key periodically by requesting a new one from the dashboard.
  • The API only accepts HTTPS — there is no HTTP fallback.

​
Next steps

Find your IDs

Locate your userId and projectId in the dashboard.

Upload a build

Submit your first build with the API key you just generated.