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

# nunu.ai API Reference

> Programmatically integrate nunu.ai into your CI/CD pipelines, manage test runs, and upload game builds.

## Getting Started

Integrate nunu.ai's AI-powered game testing into your development workflow.

<CardGroup cols={2}>
  <Card title="Introduction" icon="book-open" href="/api-reference/introduction">
    Overview of the API, base URL, and response formats
  </Card>

  <Card title="Authentication" icon="key" href="/api-reference/authentication">
    Create and manage API keys with scoped permissions
  </Card>
</CardGroup>

## API Endpoints

<CardGroup cols={2}>
  <Card title="Runs" icon="play" href="/api-reference/runs/list-runs">
    Start tests, monitor progress, retrieve results, and access bug reports
  </Card>

  <Card title="Builds" icon="box" href="/api-reference/builds/initiate-upload">
    Upload and manage game builds in nunu.ai's cloud storage
  </Card>
</CardGroup>

## Quick Reference

### Runs

| Endpoint                                              | Method | Description                                 |
| ----------------------------------------------------- | ------ | ------------------------------------------- |
| [`/runs`](/api-reference/runs/list-runs)              | GET    | List runs with filtering and pagination     |
| [`/runs`](/api-reference/runs/start-run)              | POST   | Start a test or test plan                   |
| [`/runs/{runId}`](/api-reference/runs/get-run)        | GET    | Get detailed run information with artifacts |
| [`/runs/{runId}/bugs`](/api-reference/runs/list-bugs) | GET    | List bugs found in a run                    |
| [`/runs/stop`](/api-reference/runs/stop-runs)         | POST   | Stop one or more running tests              |

### Builds

| Endpoint                                                           | Method | Description                         |
| ------------------------------------------------------------------ | ------ | ----------------------------------- |
| [`/builds/upload`](/api-reference/builds/initiate-upload)          | POST   | Initiate a multipart build upload   |
| [`/builds/upload/parts`](/api-reference/builds/get-upload-parts)   | GET    | Get presigned URLs for upload parts |
| [`/builds/upload/complete`](/api-reference/builds/complete-upload) | POST   | Complete the upload                 |
| [`/builds/upload`](/api-reference/builds/cancel-upload)            | DELETE | Cancel an in-progress upload        |

## Authentication

All API requests require an API key in the `X-Api-Key` header:

```bash theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
curl -X GET "https://nunu.ai/api/v1/project/your-project-id/runs" \
  -H "X-Api-Key: YOUR_API_TOKEN"
```

Get your API keys from **Project Admin → API Keys** in the nunu.ai dashboard.

<Card title="Learn more about authentication" icon="shield-check" href="/api-reference/authentication">
  API key management, permissions, and security best practices
</Card>