API overview

Three endpoints, called from your server with your secret key.

Base URL#

All requests go to https://api.antiro.io.

Authentication#

Send your secret key in the X-API-Key header of every request. Call the API from your server only.

An authenticated request

curl https://api.antiro.io/v1/assessments/<id> \
  -H "X-API-Key: $ANTIRO_SECRET_KEY"

Endpoints#

Method	Path	What it does
`POST`	`/v1/assessments`	Check an order
`GET`	`/v1/assessments/:id`	Read a check
`POST`	`/v1/outcomes`	Report what your team found

Requests#

Send JSON, with Content-Type: application/json. Antiro ignores fields it does not know. Text longer than a field’s limit is cut, not refused: see Field limits.

Responses#

Every response is JSON. A successful POST answers 201, and a successful GET answers 200. Errors share one format.