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

# Rover API

> Autonomous GitHub exploration jobs — submit, list, stream, and cancel.

# Rover API

Rover runs **multi-step GitHub research** jobs (fast or deep mode) on behalf of your tenant. All routes require API key authentication and are scoped to your account.

Prefix: `/rover`

## Create job

```
POST /rover/jobs
```

JSON body (simplified):

```json theme={null}
{
  "question": "Where is OAuth implemented?",
  "repos": ["org/repo"],
  "mode": "fast"
}
```

* `mode`: `fast` or `deep`
* `repos`: optional list of `owner/repo` strings

**Response:** `201` with job id and status.

## Get job

```
GET /rover/jobs/{job_id}
```

## List jobs

```
GET /rover/jobs?page=1&per_page=20
```

## Stream progress (SSE)

```
GET /rover/jobs/{job_id}/stream
```

Server-Sent Events; event shapes are defined by the live API. Use this from a browser or SSE-aware client.

## Cancel job

```
DELETE /rover/jobs/{job_id}
```

Only jobs that are not already completed or failed can be cancelled.

<RequestExample>
  ```bash theme={null}
  curl -X POST https://api.trygroundai.com/rover/jobs \
    -H "Authorization: Bearer gnd_your_api_key" \
    -H "Content-Type: application/json" \
    -d '{"question":"How does auth work?","mode":"fast"}'
  ```
</RequestExample>