post/v1/scans

Create a new scan

Accepts a URL + optional metadata. The scan runs asynchronously; stream progress via the `stream_url` or poll `result_url`.

Request body

urlstring <uri>Required
site_typeanyOfOptional
depthintegerOptional
js_renderbooleanOptional
priorityenum (2)Optional
webhook_urlanyOfOptional
metadataobjectOptional

Responses

202Successful Response
- scan_idstringRequired
- statusenum (5)Required
- created_atstring <date-time>Required
- estimated_duration_secondsintegerOptional
- stream_urlstringRequired
- result_urlstringRequired
- cachedbooleanOptional
422Validation Error
- detailarrayOptional

curl -X POST 'https://api.aide.tr/v1/scans' \
  -H 'Authorization: Bearer $AIDE_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"url":"https://example.com","site_type":null,"depth":1,"js_render":false,"priority":"normal","webhook_url":null,"metadata":null}'

Try it

Hit the live API with your key.

API keyRemember my API key on this device

Request body (JSON)

Copy cURL

Response

No request yet.