Inspect API

The full Inspect API reference is available in the Inspect section.

Note

See Inspect API Reference for all endpoints, request/response schemas, and examples.

Endpoints Summary

Method	Path	Description	Scope
`POST`	`/v1/inspect`	Trigger an inspect run	`inspect:write`
`GET`	`/v1/inspect/{job_id}`	Get job status and summary	`inspect:read`
`GET`	`/v1/inspect/{job_id}/findings`	List findings (paginated, filterable)	`inspect:read`
`POST`	`/v1/inspect/findings/{id}/snooze`	Snooze a finding	`inspect:write`
`POST`	`/v1/inspect/findings/{id}/mark-fixed`	Mark a finding as fixed	`inspect:write`
`POST`	`/v1/inspect/findings/{id}/mark-false-positive`	Mark as false positive	`inspect:write`
`GET`	`/v1/inspect/credits`	Get credit balance and ledger	`inspect:read`
`POST`	`/v1/inspect/override`	Create override token	`inspect:write`
`POST`	`/v1/inspect/pre-send-check`	Check if template can be sent	`inspect:read`
`GET`	`/v1/inspect/config`	Get workspace inspect config	`inspect:read`
`PUT`	`/v1/inspect/config`	Update workspace inspect config	`inspect:write`

All Inspect endpoints use data-plane authentication:

X-WORKSPACE-ID header -- your workspace UUID
X-API-KEY header -- an API key with inspect:read and/or inspect:write scope

Roles with Inspect access: Owner, Admin, Developer, Marketing.