Skip to main content

Developer glossary

Understand the API before you integrate it.

Use these practical definitions to choose a model, handle task states, verify callbacks, estimate usage and protect user media.

01

Asynchronous generation API

Definition

An API that accepts a media request, returns a durable task ID, and completes outside the original HTTP request.

Implementation note

Persist the task ID before polling or waiting for a webhook. Queued and running are active; succeeded, failed and expired are terminal. Accepted tasks cannot be canceled.

Related page →
02

Idempotency key

Definition

A client-generated identifier that lets repeated submissions resolve to one logical task instead of creating duplicate billable work.

Implementation note

Reuse the same key only for the same validated request. Store it with the task and return the original result when a retry arrives.

Related page →
03

Webhook signature

Definition

A cryptographic value attached to a callback so the receiver can verify that the event came from the API and was not changed in transit.

Implementation note

Verify the raw request body, reject stale timestamps and deduplicate event IDs before changing task or billing state.

Related page →
04

Model schema

Definition

The machine-readable contract describing a model's accepted fields, types, limits, defaults and output shape.

Implementation note

Generate forms and server validation from the published schema, but pin or record the schema version used for each task.

Related page →
05

Reference image

Definition

An input image used to guide identity, composition, style or motion in an image or video generation request.

Implementation note

Collect provenance and consent, validate format and size, and avoid treating a reference as permission to reproduce a real person's likeness.

Related page →
06

Usage-based pricing

Definition

A billing model based on measured usage. Each model states the applicable unit, such as each image, output second, megapixel, token or request.

Implementation note

Show the unit and the pre-run estimate before submission; minimum charges, duration and output count can change the final cost.

Related page →
07

AI model with reduced content filtering

Definition

A model option with fewer content filters that may process a wider range of content; the label is product information, not platform approval.

Implementation note

Implement the age, consent, real-person and jurisdiction controls your own users and service require before submitting a request.

Related page →

Ready to connect a model?

Review model inputs, examples and current pricing, then check the estimate for your actual settings before you run.