Developer platform · Public beta
Endpoint reference
Contracts for generation, verification, availability, usage, operations, and artifacts.
POST /api/v1/plates/generate
Creates an asynchronous PNG operation for one of the seven supported shapes. Partial renderable text is accepted but is never represented as legally valid.
The operation reports rendered text, dimensions, character geometry, effective branding, service mode, credits charged, artifact URL, checksum, and expiry.
- Provider-branded
- 1 credit
- Custom or no footer
- 2 credits; may downgrade to provider branding
- Artifact retention
- 30 days
POST /api/v1/plates/verify
Returns stable rule checks and advisory content flags without modifying, truncating, uppercasing, or substituting supplied text. A completed rules evaluation costs 1 credit, including failed rules.
POST /api/v1/plates/availability
Returns taken, not_found, or unknown with snapshot ID, retrieval time, and stale status. A usable successful lookup costs 1 credit, including taken. Missing or older-than-72-hour registry data returns uncharged unknown.
GET /api/v1/pricing and /api/v1/usage
Pricing is public. Usage is authenticated and reports balance and aggregated project consumption without exposing secrets or request input.
GET /api/v1/operations/:id
Poll queued or running operations. The authenticated credential must own the project. Polling and retrieving results do not create another billable operation.
GET /api/v1/artifacts/:id
Streams a private generated artifact only to its owning project. Validate Content-Type, Content-Length, and checksum when persisting it.