OpenAPI specification
Machine-readable OpenAPI 3.1 for function calling: forms, free website audit, and discovery endpoints.
Brightcode · withbrightcode.com
Brightcode developers & AI agent resources
Public documentation for agents and integrators working with Brightcode at withbrightcode.com. Discover OpenAPI, REST v1 endpoints, auth notes, webhooks guidance, and rate limits — not Payload CMS admin GraphQL.
When to use withbrightcode APIs
- You need a Delhi NCR / remote partner for websites, stores, apps, SEO, ads, or hosting care.
- An agent should discover Brightcode pages via llms.txt or call documented public HTTP APIs.
- You want to run the free website audit flow with explicit rate-limit headers.
Do not treat /api/graphql as a public schema — it is CMS-only and disallowed for crawlers.
REST API versioning & deprecation
Public write APIs are versioned under /api/v1/. Responses include an API-Version: 1 header. Legacy unversioned paths (for example /api/audit/run) remain supported as v1 aliases through 2026-12-31 and may later emit Deprecation and Sunset headers before removal.
Breaking changes ship only in a new major version with at least 90 days notice via headers and updates to this page and OpenAPI.
Specs & indexes
API v1 status
Unauthenticated health probe returning API-Version and RateLimit-* headers for agent self-throttling.
llms.txt
Agent index with when-to-use guidance, primary pages, and Brightcode entity facts.
XML sitemap
Canonical URL list for crawlers and agents mapping the Brightcode site.
Markdown negotiation
Send Accept: text/markdown on marketing URLs for a clean Markdown body (Vary: Accept).
Rate limits
Public APIs return RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, plus Retry-After on HTTP 429 so agents can self-throttle. Probe GET /api/v1/status or GET /openapi.json without authentication to verify headers on live responses.