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

# Quickstart

> Make your first API call in under a minute

export const ScarfPixel = () => <img referrerPolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=831669b6-b4bd-42cb-8832-2122c03e1d5f" alt="" width="1" height="1" style={{
  position: "absolute",
  width: 0,
  height: 0,
  opacity: 0,
  pointerEvents: "none"
}} />;

<ScarfPixel />

## 1. Create an API token

Go to **Settings > API Access** in the [Strix dashboard](https://app.strix.ai/settings/api-access) and create a new personal token with `scans:read` scope.

## 2. List your recent pentests

```bash theme={null}
curl -X GET "https://app.strix.ai/api/v1/scans?limit=5" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
```

You'll get back a JSON response with your most recent pentests:

```json theme={null}
{
  "items": [
    {
      "id": "scan_abc123",
      "title": "Scan of example.com",
      "status": "completed",
      "scan_type": "blackbox",
      "findings": { "total": 7, "critical": 1, "high": 2, "medium": 3, "low": 1 },
      "created_at": "2026-04-07T10:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 5,
    "total_items": 42,
    "total_pages": 9,
    "has_next": true,
    "has_prev": false
  }
}
```

## 3. Update a vulnerability status

Create a token with `vulnerabilities:write` scope, then mark a finding as in-progress:

```bash theme={null}
curl -X PATCH "https://app.strix.ai/api/v1/vulnerabilities/<VULNERABILITY_ID>" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"status":"in_progress","note":"Linked to remediation ticket"}'
```

## 4. Trigger a schedule

If you have pentest schedules configured, trigger one immediately:

```bash theme={null}
curl -X POST "https://app.strix.ai/api/v1/schedules/<SCHEDULE_ID>/trigger" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
```

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/authentication">
    Learn about token types and scopes
  </Card>

  <Card title="Webhooks" icon="webhook" href="/guides/webhooks">
    Subscribe to pentest and vulnerability events
  </Card>
</CardGroup>