/
Open Explorer

Concepts

Learn the mental model before route-by-route implementation

Concepts are the shared layer for understanding auth boundaries, accepted work, retries, and lifecycle behavior. Use this hub first, then move into API reference pages for exact headers, payloads, and status contracts.

Reading the concepts layer first reduces duplicate implementation logic across single render, jobs, and batch integrations. It also keeps reference pages focused on contracts instead of repeating the same mental model on every route.

Recommended path

  1. Start with auth models to choose the right credential family.
  2. Read execution model to handle immediate completion and accepted work as two valid outcomes.
  3. Use idempotency and jobs and lifecycle to shape retries and follow up behavior.
Start with auth modelsOpen API reference

Read These First

Begin with the concepts that prevent the most integration confusion

Read these four pages before deep reference work. This sequence prevents auth mismatches, clarifies accepted work handling, and keeps retries safe.

  1. Auth models - choose API key, hybrid bearer auth, or signed link auth by route family.
  2. Execution model - treat immediate output and accepted work as two normal success outcomes.
  3. Idempotency - reuse one key for true retries and avoid duplicate create work.
  4. Jobs and lifecycle - follow queued work through terminal state and output readiness.

Directory

Concept directory

Use this directory when you need a focused explanation of shared API behavior. All links below point to the canonical concepts pages.

  • Auth models: map credential type to route family and avoid cross-family auth mistakes.
  • Execution model: understand accepted versus finished work and how each changes client flow.
  • Idempotency: apply safe replay behavior and detect conflicting key reuse.
  • Jobs and lifecycle: read status transitions, terminal outcomes, and download readiness rules.

Concept To Reference Map

Move from shared understanding into exact route contracts

Use this map when you are ready to implement. Start with the concept, then open the reference page that defines the request and response contract for the routes you are building.