Skip to content

Developer resources

BishopTech API and agent resources.

A small, honest public REST surface for discovery, published content, user-approved consultation requests, and the interactive readiness audit. Admin, cron, webhook, analytics, and authenticated application routes are intentionally outside this contract.

Public contract

Reachable endpoints

Read capabilities as JSON
BishopTech public API endpoints
MethodPathPurpose
GET/api/capabilitiesDiscover the public capability catalog and side effects.
GET/api/aio-apiRead a lightweight service health response.
GET/api/blog/postsRead published blog posts.
GET/api/blog/posts/{slug}Read one published post by slug.
POST/api/contactSubmit a user-approved contact or consultation request.
POST/api/readiness-check/scanRun a user-requested website readiness scan.

Calling guidance

Permission stays with the user.

Read capabilities first, then use the smallest endpoint that answers the user's request. No API key is required for the documented public operations.

Important: POST /api/contact creates a lead and may send email. POST /api/readiness-check/scan crawls a submitted website and stores a report. Agents must not trigger either side effect without explicit user intent.

For the complete typed contract, use openapi.json. For retrieval and source-priority guidance, use llms.txt.