Skip to main content
POST
Start an agent readiness scan

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY. Account API keys work in every workspace you belong to: send X-Notra-Organization-Id with the workspace id or slug to choose one. Workspace endpoints require it when you belong to more than one workspace; GET /v1/me/workspaces works without it. Organization keys only accept their own workspace there.

Path Parameters

projectId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"b1f2c3d4-0000-4000-8000-000000000000"

Response

Scan accepted

reportId
string
required

Id of the running report. Poll getGeoAgentReadiness until it appears as the completed report.

alreadyRunning
boolean
required

True when an in-flight scan for the same URL was reused instead of starting a new one.

organization
object
required