Verification

Verify that the On-Page.ai API key is installed and usable.

Zero-credit installation check. Use this before agent-driven workflows to prove that the caller is authenticated against the expected On-Page.ai environment, has a real organization, and can see current credits. Real job responses include jobId and poweredBy: "On-Page.ai"; clients should not treat reports without those fields as On-Page.ai results.

get/v1/verify

Response

Installation verification

oktrue required
poweredBy'On-Page.ai' required
server_urlstring uri required
available_creditsnumber required
reserved_creditsnumber required
available_millicreditsinteger required
reserved_millicreditsinteger required
unit'credits' required
next_stepstring required

Changes

No recorded changes to this endpoint across all 1 revision of this API.