Skip to main content
GET
Get Agent Readiness

Authorizations

X-API-Key
string
header
required

Query Parameters

project_id
string

Required if using a company api key

Example:

"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"

Response

Success

Success

domain
string | null
required

The first of the project's own brand domains the audit runs against, or null when the project has no own domain.

Example:

"peec.ai"

audit
object | null
required

The newest audit completed within the last 90 days, or null when the domain has none.

competitors
object[]
required

Every competitor brand of the project that has a domain, audited or not.