#Resources

This section covers cross-cutting concerns that apply across the entire Transcodely API. These patterns are consistent regardless of which service or endpoint you are calling.

#API Patterns

Transcodely follows a set of consistent conventions inspired by Stripe and other developer-friendly APIs:

• Connect-RPC protocol — all endpoints accept POST with Content-Type: application/json
• snake_case fields — all JSON field names use snake_case, never camelCase
• Lowercase enums — enum values are simple lowercase strings (pending, h264, mp4)
• Prefixed IDs — every resource has a globally unique, type-prefixed identifier (job_, pst_, org_)
• Structured errors — errors include machine-readable codes and field-level details
• Cursor pagination — list endpoints use cursor-based pagination for stable traversal
• Idempotency — mutation endpoints support idempotency keys for safe retries

#In This Section

#Errors

How the API reports errors — Connect-RPC error codes, the ErrorDetails format, field validation violations, and common error scenarios with solutions.

#Idempotency

Safely retry requests without creating duplicate resources. Learn about idempotency keys, replay behavior, and recommended key formats.

#Pagination

Navigate large result sets with cursor-based pagination. Understand PaginationRequest, PaginationResponse, and how to iterate through all pages.

#Metadata

Attach custom key-value data to jobs for your own tracking and reporting. Learn about constraints, reserved keys, and common usage patterns.

#Changelog

A chronological record of API changes, new features, and migration notes.