Skip to documentation
IA CheckerDocs
⌘K
Open IA Checker
Browse documentation
Private preview

Developer API overview

IA Checker currently exposes product routes to its own web application. A self-serve public developer API is being designed as a separate, versioned contract and is not generally available yet.

View as Markdown

Current state

Selected Business conversations can include private integration access. That work is scoped directly so authentication, data handling, limits and support expectations are explicit.

Contract principles

  • A versioned public namespace that is separate from browser-session routes
  • Scoped API credentials that can be rotated and revoked
  • Idempotency for billable or asynchronous create operations
  • Stable JSON error envelopes and machine-readable request identifiers
  • Distributed rate limits with standard response headers
  • An OpenAPI document generated from the same contract as the service

Candidate capabilities

Potential public API families
FamilyLikely interaction
Text detectionSynchronous request for bounded plain text
Writing transformationsSynchronous request with mode and tone controls
Document extractionUpload followed by asynchronous extraction for complex files
Image detectionAsynchronous job with status and typed result endpoints
Reports and webhooksSigned delivery for completed long-running jobs

These are design targets, not a published endpoint list. Names, availability, quotas and pricing remain subject to the versioned public contract.