> ## Documentation Index
> Fetch the complete documentation index at: https://docs.binarly.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Started

> Welcome to the Binarly Transparency Platform API

The Binarly Transparency Platform API allows you to automate firmware security analysis, integrate vulnerability scanning into your CI/CD pipelines, and retrieve detailed security insights programmatically.

## Choose Your Path

Select the authentication method that matches your use case to get started quickly.

<img src="https://mintcdn.com/binarly-bee2cf27/6V1U5G3a8j111qJt/images/authentication/authentication-overview.jpg?fit=max&auto=format&n=6V1U5G3a8j111qJt&q=85&s=f785ddc47725439bdb089dbe426854c4" width="600" alt="Authentication Overview" data-path="images/authentication/authentication-overview.jpg" />

<CardGroup cols={2}>
  <Card title="CI/CD & Automation" icon="robot" href="/api-reference/authentication/create-api-client">
    I need to integrate Binarly into a build pipeline (Jenkins, GitLab, GitHub Actions).

    **Go here to set up machine-to-machine authentication.**
  </Card>

  <Card title="Custom Engineering" icon="terminal" href="/api-reference/authentication/generate-token">
    I need to run ad-hoc queries, test endpoints, or build a custom script.

    **Go here to generate a personal access token.**
  </Card>
</CardGroup>

## Interactive Documentation

Explore our full API reference and test endpoints directly in the browser using our Swagger UI.

**Swagger UI URL**:
`https://<YOUR_DASHBOARD>/api/v4/swagger/`

> **Note**: Replace `<YOUR_DASHBOARD>` in the URL above with your specific dashboard domain (e.g., `dashboard-myorg.binarly.cloud`) to access the interactive documentation for your instance.

## New to Binarly?

If you're just getting started, check out the [First Scan Guide](/user-guides/get-started/first-scan) for a walkthrough of the dashboard interface.