> For the complete documentation index, see [llms.txt](https://steelabs.gitbook.io/steelabs-site-audit-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://steelabs.gitbook.io/steelabs-site-audit-api/getting-started.md).

# Getting started

The Steelabs Site Audit API creates and manages website audits. A background worker crawls public pages, runs rule-based checks, and stores the findings and a downloadable PDF report.

**API base URL:** `https://steelabs.tech/api/v1`

[Open the web application](https://steelabs.tech/audit) · [View public audit history](https://steelabs.tech/audit/history) · [Download the OpenAPI 3.1 specification](https://steelabs.tech/api/v1/openapi.json)

## Try the API

The API reference on this site is generated from the live OpenAPI specification. Expand an operation to see its parameters, body, responses and interactive request controls. Requests go to the real Steelabs API; creating, updating and deleting change actual audit records.

Start with **GET /audits** to list publicly listed audits. To create your own audit, use **POST /audits** with a public website URL. Audit only websites you are permitted to check.

```json
{
  "url": "https://example.com",
  "name": "Demo website audit",
  "device": "mobile",
  "maxPages": 2,
  "passThreshold": 72.5,
  "checkAccessibility": true,
  "listed": false
}
```

A successful creation returns HTTP **201**, the audit in `data`, and an `editToken`. Save `data.id` and the token from that response. The token is returned only for the original creation; an idempotent replay does not return it again.

## Follow the result

Read **GET /audits/{id}** using the returned ID. The status progresses from `queued` to `running`, then `done` or `failed`. Poll periodically rather than continuously. When it is `done`, download **GET /audits/{id}/report**. If it fails, inspect `error` and `errorCode` before deciding whether to re-run it.

The create response confirms that a job has been queued; it does not mean the website has already been checked.

## Update or delete your audit

Enter the audit's edit token in the API reference's bearer authorization field. Enter the token itself if the field already supplies the Bearer scheme. With other clients, send:

```http
Authorization: Bearer YOUR_EDIT_TOKEN
```

Use **PATCH /audits/{id}** to rename the audit, change its settings or modify notes. Changing crawl settings queues another run. Use **DELETE /audits/{id}** to remove the audit and its associated files; success returns HTTP **204**, with no response body.

## What these checks mean

This is an automated HTML and HTTP audit covering security headers, SEO, basic performance signals, accessibility indicators and links. It does not execute a browser or constitute a penetration test, a complete accessibility audit, or a Core Web Vitals field assessment. The PDF explains what each check found.

Source of truth: the [live OpenAPI specification](https://steelabs.tech/api/v1/openapi.json).