ConverterHQDevelopers
API v1

Konvensi API

Aturan HTTP, ID, pagination, waktu, dan header yang konsisten pada API v1.

Integrasi yang kuat bergantung pada konvensi stabil untuk status, opaque ID, cursor, dan metadata request, bukan detail kebetulan suatu endpoint.

HTTP dan status code

Create asinkron mengembalikan 202 Accepted saat pekerjaan berlanjut; read sukses memakai 200. Error mengikuti Problem Details dengan code mesin yang stabil.

ID dan waktu

Perlakukan file_..., job_..., task_..., dan project_id sebagai string opaque. Timestamp adalah ISO 8601 UTC; jangan mengambil makna dari urutan ID.

Cursor pagination

List memakai cursor opaque. Kirim next_cursor apa adanya, pertahankan filter, dan jangan membuat cursor sendiri.

Header operasional

Kirim Idempotency-Key pada create yang mungkin diulang dan simpan X-Request-ID. Hormati Retry-After dan RateLimit-* sebelum retry.