> ## 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.

# Overview

> Automate builds, distribution, and webhooks via the REST API.

The REST API lets you automate uploads, distribution, and project management — for CI/CD pipelines, internal tools, and custom integrations.

## Base URL

```
https://api.streampixel.io/pixelStripeApi
```

## What you'll need

|            | Where                                                                                        |
| ---------- | -------------------------------------------------------------------------------------------- |
| API key    | [Dashboard → Settings → API Key](https://dashboard.streampixel.io)                           |
| User ID    | Dashboard URL or [Find your IDs](/resources/api-reference/finding-your-user-and-project-ids) |
| Project ID | Same — find both in your dashboard                                                           |

## Pages in this section

### Getting started

|                                                                                |                                                 |
| ------------------------------------------------------------------------------ | ----------------------------------------------- |
| [API authentication](/resources/api-reference/api-authentication)              | How to pass your key on every request.          |
| [Finding your IDs](/resources/api-reference/finding-your-user-and-project-ids) | Locate user ID and project ID in the dashboard. |
| [Rate limits & errors](/resources/api-reference/rate-limits-and-errors)        | Limits per endpoint and error response format.  |

### Endpoints

| Method | Endpoint                                                                        | What it does                                          |
| ------ | ------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `POST` | [/projects/upload-file](/resources/api-reference/upload-file-api)               | Upload a build by public URL.                         |
| `POST` | [/projects/distribute-file](/resources/api-reference/distribute-file-api)       | Manually release a build (when `autoRelease: false`). |
| `GET`  | [/projects](/resources/api-reference/list-projects)                             | List all your projects.                               |
| `GET`  | [/projects/userStats/\{projectId}](/resources/api-reference/project-user-stats) | Live + queued user counts for a project.              |

### Webhooks

|                                                           |                                                                      |
| --------------------------------------------------------- | -------------------------------------------------------------------- |
| [Webhooks](/resources/api-reference/webhooks)             | Receive HTTP notifications for uploads, approvals, and distribution. |
| [Webhook events](/resources/api-reference/webhook-events) | Full event reference and payload schemas.                            |

## Typical workflow

<Steps>
  <Step title="Upload a build">
    Call [Upload File](/resources/api-reference/upload-file-api) with `autoRelease: true`.
  </Step>

  <Step title="Wait for approval">
    Listen on your [webhook](/resources/api-reference/webhooks) for `build.approved`.
  </Step>

  <Step title="Done">
    Streampixel automatically distributes the build to workers — no extra call.
  </Step>
</Steps>