Translation APIReference
v2.0.0

Translation API · Concept

Common Conventions

Understand public identifiers, timestamps, locales, response structures, and conditional reads.

Public API v2 applies the same wire conventions across account, file, project, quote, delivery, and webhook resources.

Identifiers

Resource IDs are opaque strings with prefixes such as pac_, file_, proj_, quote_, delivery_, wh_, whd_, and evt_. Treat the complete value as an identifier and do not infer sequence or creation time from it.

external_id is caller-defined correlation data. It is isolated by API key environment and resource type.

Timestamps and Languages

Timestamps use RFC 3339 and include a timezone. Language inputs use the active language codes returned by GET /languages; do not assume the catalog from a label displayed elsewhere in the platform.

JSON and Lists

JSON keys use snake_case. Single-resource responses return the resource directly. Paginated lists use:

{
  "object": "list",
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Clients should ignore unknown response properties so compatible additions do not break integrations.

Standard Headers

Every response includes Stepes-Request-Id and Stepes-API-Version. Authenticated responses include RateLimit-Policy and RateLimit. Replayed mutations include Idempotency-Replayed: true.

Successful JSON reads return an ETag. Send it as If-None-Match; unchanged resources return 304 Not Modified without a response body.

Related Reference