ConverterHQDevelopers
Dihasilkan dari kontrak OpenAPI publik terpilih

Referensi API REST

Periksa parameter, autentikasi, kolom bertingkat, skema respons, galat, dan contoh yang dapat dijalankan. Rute pengguna akhir, SEO, dan administrasi tidak disertakan.

74 endpoint ditampilkan74 total operasi17 tag3.1.0 skema
GET/v1/capabilitiesList CapabilitiesCapabilities#

List Capabilities. Capability responses are the source of truth for supported format pairs, settings, limits and estimates. Validate pair-specific options before submitting production work. No authentication is required.

AutentikasiPublik / tanpa persyaratan keamanan khusus operasi

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
input_formatqueryanyOf<string | null>opsional—
output_formatqueryanyOf<string | null>opsional—
includequeryanyOf<string | null>opsional
Comma-separated expansions. Use `options` or `options.details` for pair-specific option metadata.
—
limitqueryintegeropsional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opsional—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
dataobject[]wajib——
data[]objectopsional——
data[].supportedbooleanwajib——
data[].input_formatstringwajib——
data[].output_formatstringwajib——
data[].maturitystringopsional—
enum: "stable", "disabled"default: "stable"
data[].settings_scopestringopsionalSettings are scoped to the customer-visible conversion task. For a Job, every named convert Task owns an independent options.settings namespace; hidden engine steps are never public namespaces.
default: "conversion-task"
data[].routeobjectopsional——
data[].route.multi_stepbooleanopsionalTrue when ConverterHQ currently implements the pair with more than one hidden engine step. Hidden step names are not part of API v1.
default: false
data[].route.requires_explicit_tasks_forstring[]opsionalSetting names that collide across hidden stages and therefore cannot be accepted safely on the implicit pair-level task. Split the stages into named convert Tasks when independent values are required.—
data[].options_versionanyOf<string | null>opsionalStable hash of the currently exposed settings schema for this pair. Refresh capabilities when this value changes instead of guessing pair-specific option names.—
data[].options_version · variant 1stringopsional——
data[].options_version · variant 2nullopsional——
data[].optionsobject[]opsionalSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
data[].options[]objectopsional——
data[].options[].namestringwajib——
data[].options[].typestringwajib——
data[].options[].labelstringwajib——
data[].options[].descriptionanyOf<string | null>opsional——
data[].options[].description · variant 1stringopsional——
data[].options[].description · variant 2nullopsional——
data[].options[].requiredbooleanopsional—
default: false
data[].options[].advancedbooleanopsional—
default: false
data[].options[].groupanyOf<string | null>opsional——
data[].options[].group · variant 1stringopsional——
data[].options[].group · variant 2nullopsional——
data[].options[].defaultunknownopsional——
data[].options[].possible_valuesanyOf<unknown[] | null>opsional——
data[].options[].possible_values · variant 1unknown[]opsional——
data[].options[].possible_values · variant 2nullopsional——
data[].options[].minimumanyOf<integer | number | null>opsional——
data[].options[].minimum · variant 1integeropsional——
data[].options[].minimum · variant 2numberopsional——
data[].options[].minimum · variant 3nullopsional——
data[].options[].maximumanyOf<integer | number | null>opsional——
data[].options[].maximum · variant 1integeropsional——
data[].options[].maximum · variant 2numberopsional——
data[].options[].maximum · variant 3nullopsional——
data[].options[].depends_onobject[]opsional——
data[].options[].conflicts_withstring[]opsional——
data[].options[].schemaanyOf<object | null>opsional——
data[].options[].schema · variant 1objectopsional——
data[].options[].schema · variant 2nullopsional——
data[].options_schemaobjectopsionalStrict JSON Schema for the settings accepted by this pair-level conversion task.—
data[].limitsobjectopsional——
data[].billingobjectopsional——
paginationobjectwajib——
pagination.nextanyOf<string | null>opsional——
pagination.next · variant 1stringopsional——
pagination.next · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/capabilities/{from_format}/to/{to_format}Get CapabilityCapabilities#

Get Capability. Capability responses are the source of truth for supported format pairs, settings, limits and estimates. Validate pair-specific options before submitting production work. No authentication is required.

AutentikasiPublik / tanpa persyaratan keamanan khusus operasi

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
from_formatpathstringwajib—
to_formatpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
supportedbooleanwajib——
input_formatstringwajib——
output_formatstringwajib——
maturitystringopsional—
enum: "stable", "disabled"default: "stable"
settings_scopestringopsionalSettings are scoped to the customer-visible conversion task. For a Job, every named convert Task owns an independent options.settings namespace; hidden engine steps are never public namespaces.
default: "conversion-task"
routeobjectopsional——
route.multi_stepbooleanopsionalTrue when ConverterHQ currently implements the pair with more than one hidden engine step. Hidden step names are not part of API v1.
default: false
route.requires_explicit_tasks_forstring[]opsionalSetting names that collide across hidden stages and therefore cannot be accepted safely on the implicit pair-level task. Split the stages into named convert Tasks when independent values are required.—
options_versionanyOf<string | null>opsionalStable hash of the currently exposed settings schema for this pair. Refresh capabilities when this value changes instead of guessing pair-specific option names.—
options_version · variant 1stringopsional——
options_version · variant 2nullopsional——
optionsobject[]opsionalSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
options[]objectopsional——
options[].namestringwajib——
options[].typestringwajib——
options[].labelstringwajib——
options[].descriptionanyOf<string | null>opsional——
options[].description · variant 1stringopsional——
options[].description · variant 2nullopsional——
options[].requiredbooleanopsional—
default: false
options[].advancedbooleanopsional—
default: false
options[].groupanyOf<string | null>opsional——
options[].group · variant 1stringopsional——
options[].group · variant 2nullopsional——
options[].defaultunknownopsional——
options[].possible_valuesanyOf<unknown[] | null>opsional——
options[].possible_values · variant 1unknown[]opsional——
options[].possible_values · variant 2nullopsional——
options[].minimumanyOf<integer | number | null>opsional——
options[].minimum · variant 1integeropsional——
options[].minimum · variant 2numberopsional——
options[].minimum · variant 3nullopsional——
options[].maximumanyOf<integer | number | null>opsional——
options[].maximum · variant 1integeropsional——
options[].maximum · variant 2numberopsional——
options[].maximum · variant 3nullopsional——
options[].depends_onobject[]opsional——
options[].conflicts_withstring[]opsional——
options[].schemaanyOf<object | null>opsional——
options[].schema · variant 1objectopsional——
options[].schema · variant 2nullopsional——
options_schemaobjectopsionalStrict JSON Schema for the settings accepted by this pair-level conversion task.—
limitsobjectopsional——
billingobjectopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/commercialCommercial SnapshotAuthentication · Commercial#

Return the account's authoritative product-commercial read model. ConverterHQ does not calculate quota remaining or credit balances locally; HQTools owns those ledgers and returns a product-scoped snapshot through the ConverterHQ service identity.

Autentikasi
ConverterHQBearerhttp / bearer

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
account_idstringwajib——
productstringwajib——
api_enabledbooleanwajib——
plansstring[]wajib——
effective_planobjectwajib——
effective_plan.codestringwajib——
effective_plan.namestringwajib——
effective_plan.familyanyOf<string | null>opsional——
effective_plan.family · variant 1stringopsional——
effective_plan.family · variant 2nullopsional——
effective_plan.billing_intervalanyOf<string | null>opsional——
effective_plan.billing_interval · variant 1stringopsional——
effective_plan.billing_interval · variant 2nullopsional——
creditsobjectwajib——
credits.availablestringwajib——
credits.reservedstringwajib——
credits.debtstringwajib——
quotaanyOf<object | null>opsional——
quota · variant 1objectopsional——
quota · variant 1.keystringwajib——
quota · variant 1.periodstringwajib——
quota · variant 1.period_keystringwajib——
quota · variant 1.limitstringwajib——
quota · variant 1.usedstringwajib——
quota · variant 1.remainingstringwajib——
quota · variant 1.period_startstringwajib—
format: date-time
quota · variant 1.period_endstringwajib—
format: date-time
quota · variant 2nullopsional——
subscriptionsobject[]wajib——
subscriptions[]objectopsional——
subscriptions[].idstringwajib——
subscriptions[].planstringwajib——
subscriptions[].statusstringwajib——
subscriptions[].billing_intervalanyOf<string | null>opsional——
subscriptions[].billing_interval · variant 1stringopsional——
subscriptions[].billing_interval · variant 2nullopsional——
subscriptions[].current_period_startanyOf<string | null>opsional——
subscriptions[].current_period_start · variant 1stringopsional—
format: date-time
subscriptions[].current_period_start · variant 2nullopsional——
subscriptions[].current_period_endanyOf<string | null>opsional——
subscriptions[].current_period_end · variant 1stringopsional—
format: date-time
subscriptions[].current_period_end · variant 2nullopsional——
subscriptions[].next_billed_atanyOf<string | null>opsional——
subscriptions[].next_billed_at · variant 1stringopsional—
format: date-time
subscriptions[].next_billed_at · variant 2nullopsional——
passesobject[]wajib——
passes[]objectopsional——
passes[].idstringwajib——
passes[].offerstringwajib——
passes[].planstringwajib——
passes[].starts_atstringwajib—
format: date-time
passes[].expires_atstringwajib—
format: date-time
generated_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/connectionsList ConnectionsConnections#

List Connections. Connections are project-owned provider configuration. Secret material is never returned after creation; test operations validate connectivity without changing ownership. Required scopes: converterhq.connections.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
limitqueryintegeropsional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opsional—
providerqueryanyOf<string | null>opsional—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
dataobject[]wajib——
data[]objectopsional——
data[].idstringwajib——
data[].namestringwajib——
data[].providerstringwajib—
enum: "s3", "gcs", "azure", "sftp"
data[].config_summaryobjectwajib——
data[].enabledbooleanwajib——
data[].created_atstringwajib—
format: date-time
data[].updated_atstringwajib—
format: date-time
paginationobjectwajib——
pagination.nextanyOf<string | null>opsional——
pagination.next · variant 1stringopsional——
pagination.next · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/connectionsCreate ConnectionConnections#

Create Connection. Connections are project-owned provider configuration. Secret material is never returned after creation; test operations validate connectivity without changing ownership. Required scopes: converterhq.connections.write.

Autentikasi
ConverterHQBearerhttp / bearer

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
namestringwajib—
min length: 1max length: 255
providerstringwajib—
enum: "s3", "gcs", "azure", "sftp"
configobjectwajib——

Respons

201Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
namestringwajib——
providerstringwajib—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectwajib——
enabledbooleanwajib——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
DELETE/v1/connections/{connection_id}Delete ConnectionConnections#

Delete Connection. Connections are project-owned provider configuration. Secret material is never returned after creation; test operations validate connectivity without changing ownership. Required scopes: converterhq.connections.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
connection_idpathstringwajib—

Respons

204Successful Response

Tidak ada isi respons.

400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/connections/{connection_id}Get ConnectionConnections#

Get Connection. Connections are project-owned provider configuration. Secret material is never returned after creation; test operations validate connectivity without changing ownership. Required scopes: converterhq.connections.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
connection_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
namestringwajib——
providerstringwajib—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectwajib——
enabledbooleanwajib——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
PATCH/v1/connections/{connection_id}Update ConnectionConnections#

Update Connection. Connections are project-owned provider configuration. Secret material is never returned after creation; test operations validate connectivity without changing ownership. Required scopes: converterhq.connections.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
connection_idpathstringwajib—

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
nameanyOf<string | null>opsional——
name · variant 1stringopsional—
min length: 1max length: 255
name · variant 2nullopsional——
configanyOf<object | null>opsional——
config · variant 1objectopsional——
config · variant 2nullopsional——
enabledanyOf<boolean | null>opsional——
enabled · variant 1booleanopsional——
enabled · variant 2nullopsional——

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
namestringwajib——
providerstringwajib—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectwajib——
enabledbooleanwajib——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/connections/{connection_id}/testTest ConnectionConnections#

Test Connection. Connections are project-owned provider configuration. Secret material is never returned after creation; test operations validate connectivity without changing ownership. Required scopes: converterhq.connections.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
connection_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
okbooleanwajib——
providerstringwajib——
detailsobjectopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/convertConvertConversions#

Convert. Simple conversions use the same durable Job runtime as advanced jobs. A request may complete synchronously inside the Prefer wait window or return an asynchronous Job handle; live work is metered against the caller project. Required scopes: converterhq.files.write, converterhq.jobs.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
PreferheaderanyOf<string | null>opsional—
Idempotency-KeyheaderanyOf<string | null>opsional—

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
inputobjectwajib——
input.file_idanyOf<string | null>opsional—
default: null
input.file_id · variant 1stringopsional——
input.file_id · variant 2nullopsional——
input.urlanyOf<string | null>opsional—
default: null
input.url · variant 1stringopsional——
input.url · variant 2nullopsional——
input_formatanyOf<string | null>opsional—
default: null
input_format · variant 1stringopsional——
input_format · variant 2nullopsional——
output_formatstringwajib—
min length: 1max length: 64
optionsobjectopsional——
filenameanyOf<string | null>opsional—
default: null
filename · variant 1stringopsional—
max length: 512
filename · variant 2nullopsional——
metadataobjectopsional——
client_reference_idanyOf<string | null>opsional—
default: null
client_reference_id · variant 1stringopsional—
max length: 255
client_reference_id · variant 2nullopsional——
retention_secondsanyOf<integer | null>opsional—
default: null
retention_seconds · variant 1integeropsional—
min: 0max: 86400
retention_seconds · variant 2nullopsional——
multipart/form-data
KolomJenisWajibDeskripsiBatasan
filestringwajibInput file, up to 4 MiB.
format: binary
input_formatstringopsionalOptional source format when it cannot be detected.—
output_formatstringwajibRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringopsionalJSON object containing pair-specific conversion options.—
metadatastringopsionalJSON object copied to the created Job.—
filenamestringopsionalOptional output filename hint.—
client_reference_idstringopsionalOptional caller-defined reference.—
retention_secondsintegeropsional—
min: 0max: 86400

Respons

200Conversion completed within the requested wait window.
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
job_idstringwajib——
statusstringwajib——
progressintegerwajib——
input_formatanyOf<string | null>opsional——
input_format · variant 1stringopsional——
input_format · variant 2nullopsional——
output_formatstringwajib——
output_fileanyOf<object | null>opsional——
output_file · variant 1objectopsional——
output_file · variant 1.idstringwajib——
output_file · variant 1.statusstringwajib——
output_file · variant 1.rolestringwajib——
output_file · variant 1.filenamestringwajib——
output_file · variant 1.content_typeanyOf<string | null>opsional——
output_file · variant 1.content_type · variant 1stringopsional——
output_file · variant 1.content_type · variant 2nullopsional——
output_file · variant 1.detected_content_typeanyOf<string | null>opsional——
output_file · variant 1.detected_content_type · variant 1stringopsional——
output_file · variant 1.detected_content_type · variant 2nullopsional——
output_file · variant 1.detected_formatanyOf<string | null>opsional——
output_file · variant 1.detected_format · variant 1stringopsional——
output_file · variant 1.detected_format · variant 2nullopsional——
output_file · variant 1.size_bytesanyOf<integer | null>opsional——
output_file · variant 1.size_bytes · variant 1integeropsional——
output_file · variant 1.size_bytes · variant 2nullopsional——
output_file · variant 1.checksum_sha256anyOf<string | null>opsional——
output_file · variant 1.checksum_sha256 · variant 1stringopsional——
output_file · variant 1.checksum_sha256 · variant 2nullopsional——
output_file · variant 1.source_typestringwajib——
output_file · variant 1.created_atstringwajib—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>opsional——
output_file · variant 1.ready_at · variant 1stringopsional—
format: date-time
output_file · variant 1.ready_at · variant 2nullopsional——
output_file · variant 1.expires_atanyOf<string | null>opsional——
output_file · variant 1.expires_at · variant 1stringopsional—
format: date-time
output_file · variant 1.expires_at · variant 2nullopsional——
output_file · variant 1.metadataobjectopsional——
output_file · variant 1.uploadanyOf<object | null>opsional——
output_file · variant 1.upload · variant 1objectopsional——
output_file · variant 1.upload · variant 1.methodstringopsional—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringwajib——
output_file · variant 1.upload · variant 1.expires_atstringwajib—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectopsional——
output_file · variant 1.upload · variant 2nullopsional——
output_file · variant 1.download_urlanyOf<string | null>opsional——
output_file · variant 1.download_url · variant 1stringopsional——
output_file · variant 1.download_url · variant 2nullopsional——
output_file · variant 1.download_expires_atanyOf<string | null>opsional——
output_file · variant 1.download_expires_at · variant 1stringopsional—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullopsional——
output_file · variant 2nullopsional——
created_atstringwajib—
format: date-time
202Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
job_idstringwajib——
statusstringwajib——
progressintegerwajib——
input_formatanyOf<string | null>opsional——
input_format · variant 1stringopsional——
input_format · variant 2nullopsional——
output_formatstringwajib——
output_fileanyOf<object | null>opsional——
output_file · variant 1objectopsional——
output_file · variant 1.idstringwajib——
output_file · variant 1.statusstringwajib——
output_file · variant 1.rolestringwajib——
output_file · variant 1.filenamestringwajib——
output_file · variant 1.content_typeanyOf<string | null>opsional——
output_file · variant 1.content_type · variant 1stringopsional——
output_file · variant 1.content_type · variant 2nullopsional——
output_file · variant 1.detected_content_typeanyOf<string | null>opsional——
output_file · variant 1.detected_content_type · variant 1stringopsional——
output_file · variant 1.detected_content_type · variant 2nullopsional——
output_file · variant 1.detected_formatanyOf<string | null>opsional——
output_file · variant 1.detected_format · variant 1stringopsional——
output_file · variant 1.detected_format · variant 2nullopsional——
output_file · variant 1.size_bytesanyOf<integer | null>opsional——
output_file · variant 1.size_bytes · variant 1integeropsional——
output_file · variant 1.size_bytes · variant 2nullopsional——
output_file · variant 1.checksum_sha256anyOf<string | null>opsional——
output_file · variant 1.checksum_sha256 · variant 1stringopsional——
output_file · variant 1.checksum_sha256 · variant 2nullopsional——
output_file · variant 1.source_typestringwajib——
output_file · variant 1.created_atstringwajib—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>opsional——
output_file · variant 1.ready_at · variant 1stringopsional—
format: date-time
output_file · variant 1.ready_at · variant 2nullopsional——
output_file · variant 1.expires_atanyOf<string | null>opsional——
output_file · variant 1.expires_at · variant 1stringopsional—
format: date-time
output_file · variant 1.expires_at · variant 2nullopsional——
output_file · variant 1.metadataobjectopsional——
output_file · variant 1.uploadanyOf<object | null>opsional——
output_file · variant 1.upload · variant 1objectopsional——
output_file · variant 1.upload · variant 1.methodstringopsional—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringwajib——
output_file · variant 1.upload · variant 1.expires_atstringwajib—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectopsional——
output_file · variant 1.upload · variant 2nullopsional——
output_file · variant 1.download_urlanyOf<string | null>opsional——
output_file · variant 1.download_url · variant 1stringopsional——
output_file · variant 1.download_url · variant 2nullopsional——
output_file · variant 1.download_expires_atanyOf<string | null>opsional——
output_file · variant 1.download_expires_at · variant 1stringopsional—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullopsional——
output_file · variant 2nullopsional——
created_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/convert/{from_format}/to/{to_format}Convert PairConversions#

Convert Pair. Simple conversions use the same durable Job runtime as advanced jobs. A request may complete synchronously inside the Prefer wait window or return an asynchronous Job handle; live work is metered against the caller project. Required scopes: converterhq.files.write, converterhq.jobs.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
from_formatpathstringwajib—
to_formatpathstringwajib—
PreferheaderanyOf<string | null>opsional—
Idempotency-KeyheaderanyOf<string | null>opsional—

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
inputobjectwajib——
input.file_idanyOf<string | null>opsional—
default: null
input.file_id · variant 1stringopsional——
input.file_id · variant 2nullopsional——
input.urlanyOf<string | null>opsional—
default: null
input.url · variant 1stringopsional——
input.url · variant 2nullopsional——
input_formatanyOf<string | null>opsional—
default: null
input_format · variant 1stringopsional——
input_format · variant 2nullopsional——
output_formatstringwajib—
min length: 1max length: 64
optionsobjectopsional——
filenameanyOf<string | null>opsional—
default: null
filename · variant 1stringopsional—
max length: 512
filename · variant 2nullopsional——
metadataobjectopsional——
client_reference_idanyOf<string | null>opsional—
default: null
client_reference_id · variant 1stringopsional—
max length: 255
client_reference_id · variant 2nullopsional——
retention_secondsanyOf<integer | null>opsional—
default: null
retention_seconds · variant 1integeropsional—
min: 0max: 86400
retention_seconds · variant 2nullopsional——
multipart/form-data
KolomJenisWajibDeskripsiBatasan
filestringwajibInput file, up to 4 MiB.
format: binary
input_formatstringopsionalOptional source format when it cannot be detected.—
output_formatstringopsionalRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringopsionalJSON object containing pair-specific conversion options.—
metadatastringopsionalJSON object copied to the created Job.—
filenamestringopsionalOptional output filename hint.—
client_reference_idstringopsionalOptional caller-defined reference.—
retention_secondsintegeropsional—
min: 0max: 86400

Respons

200Conversion completed within the requested wait window.
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
job_idstringwajib——
statusstringwajib——
progressintegerwajib——
input_formatanyOf<string | null>opsional——
input_format · variant 1stringopsional——
input_format · variant 2nullopsional——
output_formatstringwajib——
output_fileanyOf<object | null>opsional——
output_file · variant 1objectopsional——
output_file · variant 1.idstringwajib——
output_file · variant 1.statusstringwajib——
output_file · variant 1.rolestringwajib——
output_file · variant 1.filenamestringwajib——
output_file · variant 1.content_typeanyOf<string | null>opsional——
output_file · variant 1.content_type · variant 1stringopsional——
output_file · variant 1.content_type · variant 2nullopsional——
output_file · variant 1.detected_content_typeanyOf<string | null>opsional——
output_file · variant 1.detected_content_type · variant 1stringopsional——
output_file · variant 1.detected_content_type · variant 2nullopsional——
output_file · variant 1.detected_formatanyOf<string | null>opsional——
output_file · variant 1.detected_format · variant 1stringopsional——
output_file · variant 1.detected_format · variant 2nullopsional——
output_file · variant 1.size_bytesanyOf<integer | null>opsional——
output_file · variant 1.size_bytes · variant 1integeropsional——
output_file · variant 1.size_bytes · variant 2nullopsional——
output_file · variant 1.checksum_sha256anyOf<string | null>opsional——
output_file · variant 1.checksum_sha256 · variant 1stringopsional——
output_file · variant 1.checksum_sha256 · variant 2nullopsional——
output_file · variant 1.source_typestringwajib——
output_file · variant 1.created_atstringwajib—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>opsional——
output_file · variant 1.ready_at · variant 1stringopsional—
format: date-time
output_file · variant 1.ready_at · variant 2nullopsional——
output_file · variant 1.expires_atanyOf<string | null>opsional——
output_file · variant 1.expires_at · variant 1stringopsional—
format: date-time
output_file · variant 1.expires_at · variant 2nullopsional——
output_file · variant 1.metadataobjectopsional——
output_file · variant 1.uploadanyOf<object | null>opsional——
output_file · variant 1.upload · variant 1objectopsional——
output_file · variant 1.upload · variant 1.methodstringopsional—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringwajib——
output_file · variant 1.upload · variant 1.expires_atstringwajib—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectopsional——
output_file · variant 1.upload · variant 2nullopsional——
output_file · variant 1.download_urlanyOf<string | null>opsional——
output_file · variant 1.download_url · variant 1stringopsional——
output_file · variant 1.download_url · variant 2nullopsional——
output_file · variant 1.download_expires_atanyOf<string | null>opsional——
output_file · variant 1.download_expires_at · variant 1stringopsional—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullopsional——
output_file · variant 2nullopsional——
created_atstringwajib—
format: date-time
202Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
job_idstringwajib——
statusstringwajib——
progressintegerwajib——
input_formatanyOf<string | null>opsional——
input_format · variant 1stringopsional——
input_format · variant 2nullopsional——
output_formatstringwajib——
output_fileanyOf<object | null>opsional——
output_file · variant 1objectopsional——
output_file · variant 1.idstringwajib——
output_file · variant 1.statusstringwajib——
output_file · variant 1.rolestringwajib——
output_file · variant 1.filenamestringwajib——
output_file · variant 1.content_typeanyOf<string | null>opsional——
output_file · variant 1.content_type · variant 1stringopsional——
output_file · variant 1.content_type · variant 2nullopsional——
output_file · variant 1.detected_content_typeanyOf<string | null>opsional——
output_file · variant 1.detected_content_type · variant 1stringopsional——
output_file · variant 1.detected_content_type · variant 2nullopsional——
output_file · variant 1.detected_formatanyOf<string | null>opsional——
output_file · variant 1.detected_format · variant 1stringopsional——
output_file · variant 1.detected_format · variant 2nullopsional——
output_file · variant 1.size_bytesanyOf<integer | null>opsional——
output_file · variant 1.size_bytes · variant 1integeropsional——
output_file · variant 1.size_bytes · variant 2nullopsional——
output_file · variant 1.checksum_sha256anyOf<string | null>opsional——
output_file · variant 1.checksum_sha256 · variant 1stringopsional——
output_file · variant 1.checksum_sha256 · variant 2nullopsional——
output_file · variant 1.source_typestringwajib——
output_file · variant 1.created_atstringwajib—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>opsional——
output_file · variant 1.ready_at · variant 1stringopsional—
format: date-time
output_file · variant 1.ready_at · variant 2nullopsional——
output_file · variant 1.expires_atanyOf<string | null>opsional——
output_file · variant 1.expires_at · variant 1stringopsional—
format: date-time
output_file · variant 1.expires_at · variant 2nullopsional——
output_file · variant 1.metadataobjectopsional——
output_file · variant 1.uploadanyOf<object | null>opsional——
output_file · variant 1.upload · variant 1objectopsional——
output_file · variant 1.upload · variant 1.methodstringopsional—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringwajib——
output_file · variant 1.upload · variant 1.expires_atstringwajib—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectopsional——
output_file · variant 1.upload · variant 2nullopsional——
output_file · variant 1.download_urlanyOf<string | null>opsional——
output_file · variant 1.download_url · variant 1stringopsional——
output_file · variant 1.download_url · variant 2nullopsional——
output_file · variant 1.download_expires_atanyOf<string | null>opsional——
output_file · variant 1.download_expires_at · variant 1stringopsional—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullopsional——
output_file · variant 2nullopsional——
created_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/estimatesEstimate ConversionCapabilities#

Estimate Conversion. Capability responses are the source of truth for supported format pairs, settings, limits and estimates. Validate pair-specific options before submitting production work. Required scopes: converterhq.capabilities.read.

Autentikasi
ConverterHQBearerhttp / bearer

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
input_formatstringwajib——
output_formatstringwajib——
size_bytesanyOf<integer | null>opsional——
size_bytes · variant 1integeropsional—
min: 0
size_bytes · variant 2nullopsional——
page_countanyOf<integer | null>opsional——
page_count · variant 1integeropsional—
min: 0
page_count · variant 2nullopsional——
duration_secondsanyOf<number | null>opsional——
duration_seconds · variant 1numberopsional—
min: 0
duration_seconds · variant 2nullopsional——
optionsobjectopsional——

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
supportedbooleanwajib——
recommended_modestringwajib—
enum: "sync", "async"
creditsobjectwajib——
warningsstring[]opsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/event-typesEvent TypesDiscovery#

Event Types. Discovery metadata enumerates stable public API primitives used by clients and integrations. No authentication is required.

AutentikasiPublik / tanpa persyaratan keamanan khusus operasi

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
dataobject[]wajib——
data[]objectopsional——
data[].typestringwajib——
data[].descriptionstringwajib——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/filesList FilesFiles#

List Files. Files are project-owned resources. Local bytes upload directly to signed object storage; the API receives metadata and manages upload completion, retention and signed download access. Required scopes: converterhq.files.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
limitqueryintegeropsional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opsional—
statusqueryanyOf<string | null>opsional—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
dataobject[]wajib——
data[]objectopsional——
data[].idstringwajib——
data[].statusstringwajib——
data[].rolestringwajib——
data[].filenamestringwajib——
data[].content_typeanyOf<string | null>opsional——
data[].content_type · variant 1stringopsional——
data[].content_type · variant 2nullopsional——
data[].detected_content_typeanyOf<string | null>opsional——
data[].detected_content_type · variant 1stringopsional——
data[].detected_content_type · variant 2nullopsional——
data[].detected_formatanyOf<string | null>opsional——
data[].detected_format · variant 1stringopsional——
data[].detected_format · variant 2nullopsional——
data[].size_bytesanyOf<integer | null>opsional——
data[].size_bytes · variant 1integeropsional——
data[].size_bytes · variant 2nullopsional——
data[].checksum_sha256anyOf<string | null>opsional——
data[].checksum_sha256 · variant 1stringopsional——
data[].checksum_sha256 · variant 2nullopsional——
data[].source_typestringwajib——
data[].created_atstringwajib—
format: date-time
data[].ready_atanyOf<string | null>opsional——
data[].ready_at · variant 1stringopsional—
format: date-time
data[].ready_at · variant 2nullopsional——
data[].expires_atanyOf<string | null>opsional——
data[].expires_at · variant 1stringopsional—
format: date-time
data[].expires_at · variant 2nullopsional——
data[].metadataobjectopsional——
data[].uploadanyOf<object | null>opsional——
data[].upload · variant 1objectopsional——
data[].upload · variant 1.methodstringopsional—
default: "PUT"
data[].upload · variant 1.urlstringwajib——
data[].upload · variant 1.expires_atstringwajib—
format: date-time
data[].upload · variant 1.headersobjectopsional——
data[].upload · variant 2nullopsional——
data[].download_urlanyOf<string | null>opsional——
data[].download_url · variant 1stringopsional——
data[].download_url · variant 2nullopsional——
data[].download_expires_atanyOf<string | null>opsional——
data[].download_expires_at · variant 1stringopsional—
format: date-time
data[].download_expires_at · variant 2nullopsional——
paginationobjectwajib——
pagination.nextanyOf<string | null>opsional——
pagination.next · variant 1stringopsional——
pagination.next · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/filesCreate FileFiles#

Create File. Files are project-owned resources. Local bytes upload directly to signed object storage; the API receives metadata and manages upload completion, retention and signed download access. Required scopes: converterhq.files.write.

Autentikasi
ConverterHQBearerhttp / bearer

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
filenamestringwajib—
min length: 1max length: 512
size_bytesanyOf<integer | null>opsional——
size_bytes · variant 1integeropsional—
min: 0
size_bytes · variant 2nullopsional——
content_typeanyOf<string | null>opsional——
content_type · variant 1stringopsional—
max length: 255
content_type · variant 2nullopsional——
checksum_sha256anyOf<string | null>opsional——
checksum_sha256 · variant 1stringopsional—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullopsional——
retention_secondsanyOf<integer | null>opsional——
retention_seconds · variant 1integeropsional—
min: 0max: 86400
retention_seconds · variant 2nullopsional——
metadataobjectopsional——

Respons

201Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
statusstringwajib——
rolestringwajib——
filenamestringwajib——
content_typeanyOf<string | null>opsional——
content_type · variant 1stringopsional——
content_type · variant 2nullopsional——
detected_content_typeanyOf<string | null>opsional——
detected_content_type · variant 1stringopsional——
detected_content_type · variant 2nullopsional——
detected_formatanyOf<string | null>opsional——
detected_format · variant 1stringopsional——
detected_format · variant 2nullopsional——
size_bytesanyOf<integer | null>opsional——
size_bytes · variant 1integeropsional——
size_bytes · variant 2nullopsional——
checksum_sha256anyOf<string | null>opsional——
checksum_sha256 · variant 1stringopsional——
checksum_sha256 · variant 2nullopsional——
source_typestringwajib——
created_atstringwajib—
format: date-time
ready_atanyOf<string | null>opsional——
ready_at · variant 1stringopsional—
format: date-time
ready_at · variant 2nullopsional——
expires_atanyOf<string | null>opsional——
expires_at · variant 1stringopsional—
format: date-time
expires_at · variant 2nullopsional——
metadataobjectopsional——
uploadanyOf<object | null>opsional——
upload · variant 1objectopsional——
upload · variant 1.methodstringopsional—
default: "PUT"
upload · variant 1.urlstringwajib——
upload · variant 1.expires_atstringwajib—
format: date-time
upload · variant 1.headersobjectopsional——
upload · variant 2nullopsional——
download_urlanyOf<string | null>opsional——
download_url · variant 1stringopsional——
download_url · variant 2nullopsional——
download_expires_atanyOf<string | null>opsional——
download_expires_at · variant 1stringopsional—
format: date-time
download_expires_at · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
DELETE/v1/files/{file_id}Delete FileFiles#

Delete File. Files are project-owned resources. Local bytes upload directly to signed object storage; the API receives metadata and manages upload completion, retention and signed download access. Required scopes: converterhq.files.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
file_idpathstringwajib—

Respons

204Successful Response

Tidak ada isi respons.

400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/files/{file_id}Get FileFiles#

Get File. Files are project-owned resources. Local bytes upload directly to signed object storage; the API receives metadata and manages upload completion, retention and signed download access. Required scopes: converterhq.files.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
file_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
statusstringwajib——
rolestringwajib——
filenamestringwajib——
content_typeanyOf<string | null>opsional——
content_type · variant 1stringopsional——
content_type · variant 2nullopsional——
detected_content_typeanyOf<string | null>opsional——
detected_content_type · variant 1stringopsional——
detected_content_type · variant 2nullopsional——
detected_formatanyOf<string | null>opsional——
detected_format · variant 1stringopsional——
detected_format · variant 2nullopsional——
size_bytesanyOf<integer | null>opsional——
size_bytes · variant 1integeropsional——
size_bytes · variant 2nullopsional——
checksum_sha256anyOf<string | null>opsional——
checksum_sha256 · variant 1stringopsional——
checksum_sha256 · variant 2nullopsional——
source_typestringwajib——
created_atstringwajib—
format: date-time
ready_atanyOf<string | null>opsional——
ready_at · variant 1stringopsional—
format: date-time
ready_at · variant 2nullopsional——
expires_atanyOf<string | null>opsional——
expires_at · variant 1stringopsional—
format: date-time
expires_at · variant 2nullopsional——
metadataobjectopsional——
uploadanyOf<object | null>opsional——
upload · variant 1objectopsional——
upload · variant 1.methodstringopsional—
default: "PUT"
upload · variant 1.urlstringwajib——
upload · variant 1.expires_atstringwajib—
format: date-time
upload · variant 1.headersobjectopsional——
upload · variant 2nullopsional——
download_urlanyOf<string | null>opsional——
download_url · variant 1stringopsional——
download_url · variant 2nullopsional——
download_expires_atanyOf<string | null>opsional——
download_expires_at · variant 1stringopsional—
format: date-time
download_expires_at · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/files/{file_id}/completeComplete FileFiles#

Complete File. Files are project-owned resources. Local bytes upload directly to signed object storage; the API receives metadata and manages upload completion, retention and signed download access. Required scopes: converterhq.files.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
file_idpathstringwajib—

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
checksum_sha256anyOf<string | null>opsional——
checksum_sha256 · variant 1stringopsional—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullopsional——

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
statusstringwajib——
rolestringwajib——
filenamestringwajib——
content_typeanyOf<string | null>opsional——
content_type · variant 1stringopsional——
content_type · variant 2nullopsional——
detected_content_typeanyOf<string | null>opsional——
detected_content_type · variant 1stringopsional——
detected_content_type · variant 2nullopsional——
detected_formatanyOf<string | null>opsional——
detected_format · variant 1stringopsional——
detected_format · variant 2nullopsional——
size_bytesanyOf<integer | null>opsional——
size_bytes · variant 1integeropsional——
size_bytes · variant 2nullopsional——
checksum_sha256anyOf<string | null>opsional——
checksum_sha256 · variant 1stringopsional——
checksum_sha256 · variant 2nullopsional——
source_typestringwajib——
created_atstringwajib—
format: date-time
ready_atanyOf<string | null>opsional——
ready_at · variant 1stringopsional—
format: date-time
ready_at · variant 2nullopsional——
expires_atanyOf<string | null>opsional——
expires_at · variant 1stringopsional—
format: date-time
expires_at · variant 2nullopsional——
metadataobjectopsional——
uploadanyOf<object | null>opsional——
upload · variant 1objectopsional——
upload · variant 1.methodstringopsional—
default: "PUT"
upload · variant 1.urlstringwajib——
upload · variant 1.expires_atstringwajib—
format: date-time
upload · variant 1.headersobjectopsional——
upload · variant 2nullopsional——
download_urlanyOf<string | null>opsional——
download_url · variant 1stringopsional——
download_url · variant 2nullopsional——
download_expires_atanyOf<string | null>opsional——
download_expires_at · variant 1stringopsional—
format: date-time
download_expires_at · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
DELETE/v1/files/{file_id}/multipartAbort Multipart FileFiles#

Abort Multipart File. Files are project-owned resources. Local bytes upload directly to signed object storage; the API receives metadata and manages upload completion, retention and signed download access. Required scopes: converterhq.files.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
file_idpathstringwajib—

Respons

204Successful Response

Tidak ada isi respons.

400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/files/{file_id}/multipartStart Multipart UploadFiles#

Start Multipart Upload. Files are project-owned resources. Local bytes upload directly to signed object storage; the API receives metadata and manages upload completion, retention and signed download access. Required scopes: converterhq.files.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
file_idpathstringwajib—

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
part_sizeanyOf<integer | null>opsional——
part_size · variant 1integeropsional—
min: 5242880max: 5368709120
part_size · variant 2nullopsional——

Respons

201Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
file_idstringwajib——
upload_idstringwajib——
part_sizeintegerwajib——
max_partsintegeropsional—
default: 10000
expires_atstringwajib—
format: date-time
partsobject[]opsional——
parts[]objectopsional——
parts[].part_numberintegerwajib——
parts[].urlstringwajib——
parts[].expires_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/files/{file_id}/multipart/completeComplete Multipart FileFiles#

Complete Multipart File. Files are project-owned resources. Local bytes upload directly to signed object storage; the API receives metadata and manages upload completion, retention and signed download access. Required scopes: converterhq.files.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
file_idpathstringwajib—

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
partsobject[]wajib—
min items: 1max items: 10000
parts[]objectopsional——
parts[].part_numberintegerwajib—
min: 1max: 10000
parts[].etagstringwajib—
min length: 1max length: 512
checksum_sha256anyOf<string | null>opsional——
checksum_sha256 · variant 1stringopsional—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullopsional——

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
statusstringwajib——
rolestringwajib——
filenamestringwajib——
content_typeanyOf<string | null>opsional——
content_type · variant 1stringopsional——
content_type · variant 2nullopsional——
detected_content_typeanyOf<string | null>opsional——
detected_content_type · variant 1stringopsional——
detected_content_type · variant 2nullopsional——
detected_formatanyOf<string | null>opsional——
detected_format · variant 1stringopsional——
detected_format · variant 2nullopsional——
size_bytesanyOf<integer | null>opsional——
size_bytes · variant 1integeropsional——
size_bytes · variant 2nullopsional——
checksum_sha256anyOf<string | null>opsional——
checksum_sha256 · variant 1stringopsional——
checksum_sha256 · variant 2nullopsional——
source_typestringwajib——
created_atstringwajib—
format: date-time
ready_atanyOf<string | null>opsional——
ready_at · variant 1stringopsional—
format: date-time
ready_at · variant 2nullopsional——
expires_atanyOf<string | null>opsional——
expires_at · variant 1stringopsional—
format: date-time
expires_at · variant 2nullopsional——
metadataobjectopsional——
uploadanyOf<object | null>opsional——
upload · variant 1objectopsional——
upload · variant 1.methodstringopsional—
default: "PUT"
upload · variant 1.urlstringwajib——
upload · variant 1.expires_atstringwajib—
format: date-time
upload · variant 1.headersobjectopsional——
upload · variant 2nullopsional——
download_urlanyOf<string | null>opsional——
download_url · variant 1stringopsional——
download_url · variant 2nullopsional——
download_expires_atanyOf<string | null>opsional——
download_expires_at · variant 1stringopsional—
format: date-time
download_expires_at · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/files/{file_id}/multipart/partsSign Multipart PartsFiles#

Sign Multipart Parts. Files are project-owned resources. Local bytes upload directly to signed object storage; the API receives metadata and manages upload completion, retention and signed download access. Required scopes: converterhq.files.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
file_idpathstringwajib—

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
part_numbersinteger[]wajib—
min items: 1max items: 1000

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
file_idstringwajib——
upload_idstringwajib——
part_sizeintegerwajib——
max_partsintegeropsional—
default: 10000
expires_atstringwajib—
format: date-time
partsobject[]opsional——
parts[]objectopsional——
parts[].part_numberintegerwajib——
parts[].urlstringwajib——
parts[].expires_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/formatsList FormatsCapabilities#

List Formats. Capability responses are the source of truth for supported format pairs, settings, limits and estimates. Validate pair-specific options before submitting production work. No authentication is required.

AutentikasiPublik / tanpa persyaratan keamanan khusus operasi

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
limitqueryintegeropsional
default: 500min: 1max: 500

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
dataobject[]wajib——
data[]objectopsional——
data[].slugstringwajib——
data[].labelstringwajib——
data[].categorystringwajib——
data[].mime_typesstring[]wajib——
data[].extensionsstring[]wajib——
paginationobjectwajib——
pagination.nextanyOf<string | null>opsional——
pagination.next · variant 1stringopsional——
pagination.next · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/formats/{slug}Get FormatCapabilities#

Get Format. Capability responses are the source of truth for supported format pairs, settings, limits and estimates. Validate pair-specific options before submitting production work. No authentication is required.

AutentikasiPublik / tanpa persyaratan keamanan khusus operasi

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
slugpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
slugstringwajib——
labelstringwajib——
categorystringwajib——
mime_typesstring[]wajib——
extensionsstring[]wajib——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/formats/{slug}/inputsFormat InputsCapabilities#

Format Inputs. Capability responses are the source of truth for supported format pairs, settings, limits and estimates. Validate pair-specific options before submitting production work. No authentication is required.

AutentikasiPublik / tanpa persyaratan keamanan khusus operasi

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
slugpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
dataobject[]wajib——
data[]objectopsional——
data[].slugstringwajib——
data[].labelstringwajib——
data[].categorystringwajib——
data[].mime_typesstring[]wajib——
data[].extensionsstring[]wajib——
paginationobjectwajib——
pagination.nextanyOf<string | null>opsional——
pagination.next · variant 1stringopsional——
pagination.next · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/formats/{slug}/outputsFormat OutputsCapabilities#

Format Outputs. Capability responses are the source of truth for supported format pairs, settings, limits and estimates. Validate pair-specific options before submitting production work. No authentication is required.

AutentikasiPublik / tanpa persyaratan keamanan khusus operasi

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
slugpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
dataobject[]wajib——
data[]objectopsional——
data[].slugstringwajib——
data[].labelstringwajib——
data[].categorystringwajib——
data[].mime_typesstring[]wajib——
data[].extensionsstring[]wajib——
paginationobjectwajib——
pagination.nextanyOf<string | null>opsional——
pagination.next · variant 1stringopsional——
pagination.next · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/jobsList JobsJobs#

List Jobs. Jobs and Tasks are durable, project-scoped resources. Mutating requests support idempotent retry semantics where documented; terminal state is authoritative for completion and billing settlement. Required scopes: converterhq.jobs.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
limitqueryintegeropsional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opsional—
statusqueryanyOf<string | null>opsional—
tagqueryanyOf<string | null>opsional—
originqueryanyOf<string | null>opsional—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
dataobject[]wajib——
data[]objectopsional——
data[].idstringwajib——
data[].kindstringwajib——
data[].statusstringwajib——
data[].progressintegerwajib——
data[].taganyOf<string | null>opsional——
data[].tag · variant 1stringopsional——
data[].tag · variant 2nullopsional——
data[].client_reference_idanyOf<string | null>opsional——
data[].client_reference_id · variant 1stringopsional——
data[].client_reference_id · variant 2nullopsional——
data[].metadataobjectopsional——
data[].prioritystringwajib——
data[].concurrency_limitintegeropsional—
default: 1
data[].originstringwajib——
data[].created_atstringwajib—
format: date-time
data[].started_atanyOf<string | null>opsional——
data[].started_at · variant 1stringopsional—
format: date-time
data[].started_at · variant 2nullopsional——
data[].completed_atanyOf<string | null>opsional——
data[].completed_at · variant 1stringopsional—
format: date-time
data[].completed_at · variant 2nullopsional——
data[].error_codeanyOf<string | null>opsional——
data[].error_code · variant 1stringopsional——
data[].error_code · variant 2nullopsional——
data[].error_messageanyOf<string | null>opsional——
data[].error_message · variant 1stringopsional——
data[].error_message · variant 2nullopsional——
data[].tasksobject[]opsional——
data[].tasks[]objectopsional——
data[].tasks[].idstringwajib——
data[].tasks[].job_idstringwajib——
data[].tasks[].namestringwajib——
data[].tasks[].operationstringwajib——
data[].tasks[].statusstringwajib——
data[].tasks[].progressintegerwajib——
data[].tasks[].inputobjectwajib——
data[].tasks[].optionsobjectwajib——
data[].tasks[].resultobjectwajib——
data[].tasks[].requiredbooleanwajib——
data[].tasks[].runtime_classstringwajib——
data[].tasks[].prioritystringwajib——
data[].tasks[].attempt_countintegerwajib——
data[].tasks[].max_attemptsintegerwajib——
data[].tasks[].error_codeanyOf<string | null>opsional——
data[].tasks[].error_code · variant 1stringopsional——
data[].tasks[].error_code · variant 2nullopsional——
data[].tasks[].error_messageanyOf<string | null>opsional——
data[].tasks[].error_message · variant 1stringopsional——
data[].tasks[].error_message · variant 2nullopsional——
data[].tasks[].created_atstringwajib—
format: date-time
data[].tasks[].queued_atanyOf<string | null>opsional——
data[].tasks[].queued_at · variant 1stringopsional—
format: date-time
data[].tasks[].queued_at · variant 2nullopsional——
data[].tasks[].started_atanyOf<string | null>opsional——
data[].tasks[].started_at · variant 1stringopsional—
format: date-time
data[].tasks[].started_at · variant 2nullopsional——
data[].tasks[].completed_atanyOf<string | null>opsional——
data[].tasks[].completed_at · variant 1stringopsional—
format: date-time
data[].tasks[].completed_at · variant 2nullopsional——
data[].tasks[].attemptsobject[]opsional——
data[].tasks[].attempts[]objectopsional——
data[].tasks[].attempts[].idstringwajib——
data[].tasks[].attempts[].attempt_numberintegerwajib——
data[].tasks[].attempts[].statusstringwajib——
data[].tasks[].attempts[].worker_idanyOf<string | null>opsional——
data[].tasks[].attempts[].worker_id · variant 1stringopsional——
data[].tasks[].attempts[].worker_id · variant 2nullopsional——
data[].tasks[].attempts[].runtime_classanyOf<string | null>opsional——
data[].tasks[].attempts[].runtime_class · variant 1stringopsional——
data[].tasks[].attempts[].runtime_class · variant 2nullopsional——
data[].tasks[].attempts[].regionanyOf<string | null>opsional——
data[].tasks[].attempts[].region · variant 1stringopsional——
data[].tasks[].attempts[].region · variant 2nullopsional——
data[].tasks[].attempts[].engineanyOf<string | null>opsional——
data[].tasks[].attempts[].engine · variant 1stringopsional——
data[].tasks[].attempts[].engine · variant 2nullopsional——
data[].tasks[].attempts[].engine_versionanyOf<string | null>opsional——
data[].tasks[].attempts[].engine_version · variant 1stringopsional——
data[].tasks[].attempts[].engine_version · variant 2nullopsional——
data[].tasks[].attempts[].input_bytesanyOf<integer | null>opsional——
data[].tasks[].attempts[].input_bytes · variant 1integeropsional——
data[].tasks[].attempts[].input_bytes · variant 2nullopsional——
data[].tasks[].attempts[].output_bytesanyOf<integer | null>opsional——
data[].tasks[].attempts[].output_bytes · variant 1integeropsional——
data[].tasks[].attempts[].output_bytes · variant 2nullopsional——
data[].tasks[].attempts[].wall_msanyOf<integer | null>opsional——
data[].tasks[].attempts[].wall_ms · variant 1integeropsional——
data[].tasks[].attempts[].wall_ms · variant 2nullopsional——
data[].tasks[].attempts[].cpu_msanyOf<integer | null>opsional——
data[].tasks[].attempts[].cpu_ms · variant 1integeropsional——
data[].tasks[].attempts[].cpu_ms · variant 2nullopsional——
data[].tasks[].attempts[].peak_memory_mbanyOf<integer | null>opsional——
data[].tasks[].attempts[].peak_memory_mb · variant 1integeropsional——
data[].tasks[].attempts[].peak_memory_mb · variant 2nullopsional——
data[].tasks[].attempts[].temp_bytesanyOf<integer | null>opsional——
data[].tasks[].attempts[].temp_bytes · variant 1integeropsional——
data[].tasks[].attempts[].temp_bytes · variant 2nullopsional——
data[].tasks[].attempts[].error_codeanyOf<string | null>opsional——
data[].tasks[].attempts[].error_code · variant 1stringopsional——
data[].tasks[].attempts[].error_code · variant 2nullopsional——
data[].tasks[].attempts[].error_messageanyOf<string | null>opsional——
data[].tasks[].attempts[].error_message · variant 1stringopsional——
data[].tasks[].attempts[].error_message · variant 2nullopsional——
data[].tasks[].attempts[].estimated_creditsanyOf<string | null>opsional——
data[].tasks[].attempts[].estimated_credits · variant 1stringopsional——
data[].tasks[].attempts[].estimated_credits · variant 2nullopsional——
data[].tasks[].attempts[].settled_creditsanyOf<string | null>opsional——
data[].tasks[].attempts[].settled_credits · variant 1stringopsional——
data[].tasks[].attempts[].settled_credits · variant 2nullopsional——
data[].tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opsional——
data[].tasks[].attempts[].external_side_effect_started_at · variant 1stringopsional—
format: date-time
data[].tasks[].attempts[].external_side_effect_started_at · variant 2nullopsional——
data[].tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opsional——
data[].tasks[].attempts[].external_side_effect_committed_at · variant 1stringopsional—
format: date-time
data[].tasks[].attempts[].external_side_effect_committed_at · variant 2nullopsional——
data[].tasks[].attempts[].started_atstringwajib—
format: date-time
data[].tasks[].attempts[].completed_atanyOf<string | null>opsional——
data[].tasks[].attempts[].completed_at · variant 1stringopsional—
format: date-time
data[].tasks[].attempts[].completed_at · variant 2nullopsional——
paginationobjectwajib——
pagination.nextanyOf<string | null>opsional——
pagination.next · variant 1stringopsional——
pagination.next · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/jobsCreate Job RouteJobs#

Create Job Route. Jobs and Tasks are durable, project-scoped resources. Mutating requests support idempotent retry semantics where documented; terminal state is authoritative for completion and billing settlement. Required scopes: converterhq.jobs.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
Idempotency-KeyheaderanyOf<string | null>opsional—

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
tasksobjectwajib——
taganyOf<string | null>opsional——
tag · variant 1stringopsional—
max length: 255
tag · variant 2nullopsional——
client_reference_idanyOf<string | null>opsional——
client_reference_id · variant 1stringopsional—
max length: 255
client_reference_id · variant 2nullopsional——
metadataobjectopsional——
prioritystringopsional—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>opsional——
retention_seconds · variant 1integeropsional—
min: 0max: 86400
retention_seconds · variant 2nullopsional——

Respons

201Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
kindstringwajib——
statusstringwajib——
progressintegerwajib——
taganyOf<string | null>opsional——
tag · variant 1stringopsional——
tag · variant 2nullopsional——
client_reference_idanyOf<string | null>opsional——
client_reference_id · variant 1stringopsional——
client_reference_id · variant 2nullopsional——
metadataobjectopsional——
prioritystringwajib——
concurrency_limitintegeropsional—
default: 1
originstringwajib——
created_atstringwajib—
format: date-time
started_atanyOf<string | null>opsional——
started_at · variant 1stringopsional—
format: date-time
started_at · variant 2nullopsional——
completed_atanyOf<string | null>opsional——
completed_at · variant 1stringopsional—
format: date-time
completed_at · variant 2nullopsional——
error_codeanyOf<string | null>opsional——
error_code · variant 1stringopsional——
error_code · variant 2nullopsional——
error_messageanyOf<string | null>opsional——
error_message · variant 1stringopsional——
error_message · variant 2nullopsional——
tasksobject[]opsional——
tasks[]objectopsional——
tasks[].idstringwajib——
tasks[].job_idstringwajib——
tasks[].namestringwajib——
tasks[].operationstringwajib——
tasks[].statusstringwajib——
tasks[].progressintegerwajib——
tasks[].inputobjectwajib——
tasks[].optionsobjectwajib——
tasks[].resultobjectwajib——
tasks[].requiredbooleanwajib——
tasks[].runtime_classstringwajib——
tasks[].prioritystringwajib——
tasks[].attempt_countintegerwajib——
tasks[].max_attemptsintegerwajib——
tasks[].error_codeanyOf<string | null>opsional——
tasks[].error_code · variant 1stringopsional——
tasks[].error_code · variant 2nullopsional——
tasks[].error_messageanyOf<string | null>opsional——
tasks[].error_message · variant 1stringopsional——
tasks[].error_message · variant 2nullopsional——
tasks[].created_atstringwajib—
format: date-time
tasks[].queued_atanyOf<string | null>opsional——
tasks[].queued_at · variant 1stringopsional—
format: date-time
tasks[].queued_at · variant 2nullopsional——
tasks[].started_atanyOf<string | null>opsional——
tasks[].started_at · variant 1stringopsional—
format: date-time
tasks[].started_at · variant 2nullopsional——
tasks[].completed_atanyOf<string | null>opsional——
tasks[].completed_at · variant 1stringopsional—
format: date-time
tasks[].completed_at · variant 2nullopsional——
tasks[].attemptsobject[]opsional——
tasks[].attempts[]objectopsional——
tasks[].attempts[].idstringwajib——
tasks[].attempts[].attempt_numberintegerwajib——
tasks[].attempts[].statusstringwajib——
tasks[].attempts[].worker_idanyOf<string | null>opsional——
tasks[].attempts[].worker_id · variant 1stringopsional——
tasks[].attempts[].worker_id · variant 2nullopsional——
tasks[].attempts[].runtime_classanyOf<string | null>opsional——
tasks[].attempts[].runtime_class · variant 1stringopsional——
tasks[].attempts[].runtime_class · variant 2nullopsional——
tasks[].attempts[].regionanyOf<string | null>opsional——
tasks[].attempts[].region · variant 1stringopsional——
tasks[].attempts[].region · variant 2nullopsional——
tasks[].attempts[].engineanyOf<string | null>opsional——
tasks[].attempts[].engine · variant 1stringopsional——
tasks[].attempts[].engine · variant 2nullopsional——
tasks[].attempts[].engine_versionanyOf<string | null>opsional——
tasks[].attempts[].engine_version · variant 1stringopsional——
tasks[].attempts[].engine_version · variant 2nullopsional——
tasks[].attempts[].input_bytesanyOf<integer | null>opsional——
tasks[].attempts[].input_bytes · variant 1integeropsional——
tasks[].attempts[].input_bytes · variant 2nullopsional——
tasks[].attempts[].output_bytesanyOf<integer | null>opsional——
tasks[].attempts[].output_bytes · variant 1integeropsional——
tasks[].attempts[].output_bytes · variant 2nullopsional——
tasks[].attempts[].wall_msanyOf<integer | null>opsional——
tasks[].attempts[].wall_ms · variant 1integeropsional——
tasks[].attempts[].wall_ms · variant 2nullopsional——
tasks[].attempts[].cpu_msanyOf<integer | null>opsional——
tasks[].attempts[].cpu_ms · variant 1integeropsional——
tasks[].attempts[].cpu_ms · variant 2nullopsional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opsional——
tasks[].attempts[].peak_memory_mb · variant 1integeropsional——
tasks[].attempts[].peak_memory_mb · variant 2nullopsional——
tasks[].attempts[].temp_bytesanyOf<integer | null>opsional——
tasks[].attempts[].temp_bytes · variant 1integeropsional——
tasks[].attempts[].temp_bytes · variant 2nullopsional——
tasks[].attempts[].error_codeanyOf<string | null>opsional——
tasks[].attempts[].error_code · variant 1stringopsional——
tasks[].attempts[].error_code · variant 2nullopsional——
tasks[].attempts[].error_messageanyOf<string | null>opsional——
tasks[].attempts[].error_message · variant 1stringopsional——
tasks[].attempts[].error_message · variant 2nullopsional——
tasks[].attempts[].estimated_creditsanyOf<string | null>opsional——
tasks[].attempts[].estimated_credits · variant 1stringopsional——
tasks[].attempts[].estimated_credits · variant 2nullopsional——
tasks[].attempts[].settled_creditsanyOf<string | null>opsional——
tasks[].attempts[].settled_credits · variant 1stringopsional——
tasks[].attempts[].settled_credits · variant 2nullopsional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opsional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopsional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opsional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopsional——
tasks[].attempts[].started_atstringwajib—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opsional——
tasks[].attempts[].completed_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/jobs/{job_id}Get JobJobs#

Get Job. Jobs and Tasks are durable, project-scoped resources. Mutating requests support idempotent retry semantics where documented; terminal state is authoritative for completion and billing settlement. Required scopes: converterhq.jobs.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
job_idpathstringwajib—
include_attemptsquerybooleanopsional
default: false

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
kindstringwajib——
statusstringwajib——
progressintegerwajib——
taganyOf<string | null>opsional——
tag · variant 1stringopsional——
tag · variant 2nullopsional——
client_reference_idanyOf<string | null>opsional——
client_reference_id · variant 1stringopsional——
client_reference_id · variant 2nullopsional——
metadataobjectopsional——
prioritystringwajib——
concurrency_limitintegeropsional—
default: 1
originstringwajib——
created_atstringwajib—
format: date-time
started_atanyOf<string | null>opsional——
started_at · variant 1stringopsional—
format: date-time
started_at · variant 2nullopsional——
completed_atanyOf<string | null>opsional——
completed_at · variant 1stringopsional—
format: date-time
completed_at · variant 2nullopsional——
error_codeanyOf<string | null>opsional——
error_code · variant 1stringopsional——
error_code · variant 2nullopsional——
error_messageanyOf<string | null>opsional——
error_message · variant 1stringopsional——
error_message · variant 2nullopsional——
tasksobject[]opsional——
tasks[]objectopsional——
tasks[].idstringwajib——
tasks[].job_idstringwajib——
tasks[].namestringwajib——
tasks[].operationstringwajib——
tasks[].statusstringwajib——
tasks[].progressintegerwajib——
tasks[].inputobjectwajib——
tasks[].optionsobjectwajib——
tasks[].resultobjectwajib——
tasks[].requiredbooleanwajib——
tasks[].runtime_classstringwajib——
tasks[].prioritystringwajib——
tasks[].attempt_countintegerwajib——
tasks[].max_attemptsintegerwajib——
tasks[].error_codeanyOf<string | null>opsional——
tasks[].error_code · variant 1stringopsional——
tasks[].error_code · variant 2nullopsional——
tasks[].error_messageanyOf<string | null>opsional——
tasks[].error_message · variant 1stringopsional——
tasks[].error_message · variant 2nullopsional——
tasks[].created_atstringwajib—
format: date-time
tasks[].queued_atanyOf<string | null>opsional——
tasks[].queued_at · variant 1stringopsional—
format: date-time
tasks[].queued_at · variant 2nullopsional——
tasks[].started_atanyOf<string | null>opsional——
tasks[].started_at · variant 1stringopsional—
format: date-time
tasks[].started_at · variant 2nullopsional——
tasks[].completed_atanyOf<string | null>opsional——
tasks[].completed_at · variant 1stringopsional—
format: date-time
tasks[].completed_at · variant 2nullopsional——
tasks[].attemptsobject[]opsional——
tasks[].attempts[]objectopsional——
tasks[].attempts[].idstringwajib——
tasks[].attempts[].attempt_numberintegerwajib——
tasks[].attempts[].statusstringwajib——
tasks[].attempts[].worker_idanyOf<string | null>opsional——
tasks[].attempts[].worker_id · variant 1stringopsional——
tasks[].attempts[].worker_id · variant 2nullopsional——
tasks[].attempts[].runtime_classanyOf<string | null>opsional——
tasks[].attempts[].runtime_class · variant 1stringopsional——
tasks[].attempts[].runtime_class · variant 2nullopsional——
tasks[].attempts[].regionanyOf<string | null>opsional——
tasks[].attempts[].region · variant 1stringopsional——
tasks[].attempts[].region · variant 2nullopsional——
tasks[].attempts[].engineanyOf<string | null>opsional——
tasks[].attempts[].engine · variant 1stringopsional——
tasks[].attempts[].engine · variant 2nullopsional——
tasks[].attempts[].engine_versionanyOf<string | null>opsional——
tasks[].attempts[].engine_version · variant 1stringopsional——
tasks[].attempts[].engine_version · variant 2nullopsional——
tasks[].attempts[].input_bytesanyOf<integer | null>opsional——
tasks[].attempts[].input_bytes · variant 1integeropsional——
tasks[].attempts[].input_bytes · variant 2nullopsional——
tasks[].attempts[].output_bytesanyOf<integer | null>opsional——
tasks[].attempts[].output_bytes · variant 1integeropsional——
tasks[].attempts[].output_bytes · variant 2nullopsional——
tasks[].attempts[].wall_msanyOf<integer | null>opsional——
tasks[].attempts[].wall_ms · variant 1integeropsional——
tasks[].attempts[].wall_ms · variant 2nullopsional——
tasks[].attempts[].cpu_msanyOf<integer | null>opsional——
tasks[].attempts[].cpu_ms · variant 1integeropsional——
tasks[].attempts[].cpu_ms · variant 2nullopsional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opsional——
tasks[].attempts[].peak_memory_mb · variant 1integeropsional——
tasks[].attempts[].peak_memory_mb · variant 2nullopsional——
tasks[].attempts[].temp_bytesanyOf<integer | null>opsional——
tasks[].attempts[].temp_bytes · variant 1integeropsional——
tasks[].attempts[].temp_bytes · variant 2nullopsional——
tasks[].attempts[].error_codeanyOf<string | null>opsional——
tasks[].attempts[].error_code · variant 1stringopsional——
tasks[].attempts[].error_code · variant 2nullopsional——
tasks[].attempts[].error_messageanyOf<string | null>opsional——
tasks[].attempts[].error_message · variant 1stringopsional——
tasks[].attempts[].error_message · variant 2nullopsional——
tasks[].attempts[].estimated_creditsanyOf<string | null>opsional——
tasks[].attempts[].estimated_credits · variant 1stringopsional——
tasks[].attempts[].estimated_credits · variant 2nullopsional——
tasks[].attempts[].settled_creditsanyOf<string | null>opsional——
tasks[].attempts[].settled_credits · variant 1stringopsional——
tasks[].attempts[].settled_credits · variant 2nullopsional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opsional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopsional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opsional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopsional——
tasks[].attempts[].started_atstringwajib—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opsional——
tasks[].attempts[].completed_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/jobs/{job_id}/cancelCancel JobJobs#

Cancel Job. Jobs and Tasks are durable, project-scoped resources. Mutating requests support idempotent retry semantics where documented; terminal state is authoritative for completion and billing settlement. Required scopes: converterhq.jobs.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
job_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
kindstringwajib——
statusstringwajib——
progressintegerwajib——
taganyOf<string | null>opsional——
tag · variant 1stringopsional——
tag · variant 2nullopsional——
client_reference_idanyOf<string | null>opsional——
client_reference_id · variant 1stringopsional——
client_reference_id · variant 2nullopsional——
metadataobjectopsional——
prioritystringwajib——
concurrency_limitintegeropsional—
default: 1
originstringwajib——
created_atstringwajib—
format: date-time
started_atanyOf<string | null>opsional——
started_at · variant 1stringopsional—
format: date-time
started_at · variant 2nullopsional——
completed_atanyOf<string | null>opsional——
completed_at · variant 1stringopsional—
format: date-time
completed_at · variant 2nullopsional——
error_codeanyOf<string | null>opsional——
error_code · variant 1stringopsional——
error_code · variant 2nullopsional——
error_messageanyOf<string | null>opsional——
error_message · variant 1stringopsional——
error_message · variant 2nullopsional——
tasksobject[]opsional——
tasks[]objectopsional——
tasks[].idstringwajib——
tasks[].job_idstringwajib——
tasks[].namestringwajib——
tasks[].operationstringwajib——
tasks[].statusstringwajib——
tasks[].progressintegerwajib——
tasks[].inputobjectwajib——
tasks[].optionsobjectwajib——
tasks[].resultobjectwajib——
tasks[].requiredbooleanwajib——
tasks[].runtime_classstringwajib——
tasks[].prioritystringwajib——
tasks[].attempt_countintegerwajib——
tasks[].max_attemptsintegerwajib——
tasks[].error_codeanyOf<string | null>opsional——
tasks[].error_code · variant 1stringopsional——
tasks[].error_code · variant 2nullopsional——
tasks[].error_messageanyOf<string | null>opsional——
tasks[].error_message · variant 1stringopsional——
tasks[].error_message · variant 2nullopsional——
tasks[].created_atstringwajib—
format: date-time
tasks[].queued_atanyOf<string | null>opsional——
tasks[].queued_at · variant 1stringopsional—
format: date-time
tasks[].queued_at · variant 2nullopsional——
tasks[].started_atanyOf<string | null>opsional——
tasks[].started_at · variant 1stringopsional—
format: date-time
tasks[].started_at · variant 2nullopsional——
tasks[].completed_atanyOf<string | null>opsional——
tasks[].completed_at · variant 1stringopsional—
format: date-time
tasks[].completed_at · variant 2nullopsional——
tasks[].attemptsobject[]opsional——
tasks[].attempts[]objectopsional——
tasks[].attempts[].idstringwajib——
tasks[].attempts[].attempt_numberintegerwajib——
tasks[].attempts[].statusstringwajib——
tasks[].attempts[].worker_idanyOf<string | null>opsional——
tasks[].attempts[].worker_id · variant 1stringopsional——
tasks[].attempts[].worker_id · variant 2nullopsional——
tasks[].attempts[].runtime_classanyOf<string | null>opsional——
tasks[].attempts[].runtime_class · variant 1stringopsional——
tasks[].attempts[].runtime_class · variant 2nullopsional——
tasks[].attempts[].regionanyOf<string | null>opsional——
tasks[].attempts[].region · variant 1stringopsional——
tasks[].attempts[].region · variant 2nullopsional——
tasks[].attempts[].engineanyOf<string | null>opsional——
tasks[].attempts[].engine · variant 1stringopsional——
tasks[].attempts[].engine · variant 2nullopsional——
tasks[].attempts[].engine_versionanyOf<string | null>opsional——
tasks[].attempts[].engine_version · variant 1stringopsional——
tasks[].attempts[].engine_version · variant 2nullopsional——
tasks[].attempts[].input_bytesanyOf<integer | null>opsional——
tasks[].attempts[].input_bytes · variant 1integeropsional——
tasks[].attempts[].input_bytes · variant 2nullopsional——
tasks[].attempts[].output_bytesanyOf<integer | null>opsional——
tasks[].attempts[].output_bytes · variant 1integeropsional——
tasks[].attempts[].output_bytes · variant 2nullopsional——
tasks[].attempts[].wall_msanyOf<integer | null>opsional——
tasks[].attempts[].wall_ms · variant 1integeropsional——
tasks[].attempts[].wall_ms · variant 2nullopsional——
tasks[].attempts[].cpu_msanyOf<integer | null>opsional——
tasks[].attempts[].cpu_ms · variant 1integeropsional——
tasks[].attempts[].cpu_ms · variant 2nullopsional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opsional——
tasks[].attempts[].peak_memory_mb · variant 1integeropsional——
tasks[].attempts[].peak_memory_mb · variant 2nullopsional——
tasks[].attempts[].temp_bytesanyOf<integer | null>opsional——
tasks[].attempts[].temp_bytes · variant 1integeropsional——
tasks[].attempts[].temp_bytes · variant 2nullopsional——
tasks[].attempts[].error_codeanyOf<string | null>opsional——
tasks[].attempts[].error_code · variant 1stringopsional——
tasks[].attempts[].error_code · variant 2nullopsional——
tasks[].attempts[].error_messageanyOf<string | null>opsional——
tasks[].attempts[].error_message · variant 1stringopsional——
tasks[].attempts[].error_message · variant 2nullopsional——
tasks[].attempts[].estimated_creditsanyOf<string | null>opsional——
tasks[].attempts[].estimated_credits · variant 1stringopsional——
tasks[].attempts[].estimated_credits · variant 2nullopsional——
tasks[].attempts[].settled_creditsanyOf<string | null>opsional——
tasks[].attempts[].settled_credits · variant 1stringopsional——
tasks[].attempts[].settled_credits · variant 2nullopsional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opsional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopsional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opsional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopsional——
tasks[].attempts[].started_atstringwajib—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opsional——
tasks[].attempts[].completed_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/jobs/{job_id}/eventsJob EventsRealtime#

Job Events. Realtime endpoints expose short-lived authorization or server-sent lifecycle events. Reconnect using the documented event cursor rather than assuming a single uninterrupted stream. Required scopes: converterhq.jobs.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
job_idpathstringwajib—
timeoutqueryintegeropsional
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>opsional—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
bodyunknownwajib——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/jobs/{job_id}/retryRetry JobJobs#

Retry Job. Jobs and Tasks are durable, project-scoped resources. Mutating requests support idempotent retry semantics where documented; terminal state is authoritative for completion and billing settlement. Required scopes: converterhq.jobs.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
job_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
kindstringwajib——
statusstringwajib——
progressintegerwajib——
taganyOf<string | null>opsional——
tag · variant 1stringopsional——
tag · variant 2nullopsional——
client_reference_idanyOf<string | null>opsional——
client_reference_id · variant 1stringopsional——
client_reference_id · variant 2nullopsional——
metadataobjectopsional——
prioritystringwajib——
concurrency_limitintegeropsional—
default: 1
originstringwajib——
created_atstringwajib—
format: date-time
started_atanyOf<string | null>opsional——
started_at · variant 1stringopsional—
format: date-time
started_at · variant 2nullopsional——
completed_atanyOf<string | null>opsional——
completed_at · variant 1stringopsional—
format: date-time
completed_at · variant 2nullopsional——
error_codeanyOf<string | null>opsional——
error_code · variant 1stringopsional——
error_code · variant 2nullopsional——
error_messageanyOf<string | null>opsional——
error_message · variant 1stringopsional——
error_message · variant 2nullopsional——
tasksobject[]opsional——
tasks[]objectopsional——
tasks[].idstringwajib——
tasks[].job_idstringwajib——
tasks[].namestringwajib——
tasks[].operationstringwajib——
tasks[].statusstringwajib——
tasks[].progressintegerwajib——
tasks[].inputobjectwajib——
tasks[].optionsobjectwajib——
tasks[].resultobjectwajib——
tasks[].requiredbooleanwajib——
tasks[].runtime_classstringwajib——
tasks[].prioritystringwajib——
tasks[].attempt_countintegerwajib——
tasks[].max_attemptsintegerwajib——
tasks[].error_codeanyOf<string | null>opsional——
tasks[].error_code · variant 1stringopsional——
tasks[].error_code · variant 2nullopsional——
tasks[].error_messageanyOf<string | null>opsional——
tasks[].error_message · variant 1stringopsional——
tasks[].error_message · variant 2nullopsional——
tasks[].created_atstringwajib—
format: date-time
tasks[].queued_atanyOf<string | null>opsional——
tasks[].queued_at · variant 1stringopsional—
format: date-time
tasks[].queued_at · variant 2nullopsional——
tasks[].started_atanyOf<string | null>opsional——
tasks[].started_at · variant 1stringopsional—
format: date-time
tasks[].started_at · variant 2nullopsional——
tasks[].completed_atanyOf<string | null>opsional——
tasks[].completed_at · variant 1stringopsional—
format: date-time
tasks[].completed_at · variant 2nullopsional——
tasks[].attemptsobject[]opsional——
tasks[].attempts[]objectopsional——
tasks[].attempts[].idstringwajib——
tasks[].attempts[].attempt_numberintegerwajib——
tasks[].attempts[].statusstringwajib——
tasks[].attempts[].worker_idanyOf<string | null>opsional——
tasks[].attempts[].worker_id · variant 1stringopsional——
tasks[].attempts[].worker_id · variant 2nullopsional——
tasks[].attempts[].runtime_classanyOf<string | null>opsional——
tasks[].attempts[].runtime_class · variant 1stringopsional——
tasks[].attempts[].runtime_class · variant 2nullopsional——
tasks[].attempts[].regionanyOf<string | null>opsional——
tasks[].attempts[].region · variant 1stringopsional——
tasks[].attempts[].region · variant 2nullopsional——
tasks[].attempts[].engineanyOf<string | null>opsional——
tasks[].attempts[].engine · variant 1stringopsional——
tasks[].attempts[].engine · variant 2nullopsional——
tasks[].attempts[].engine_versionanyOf<string | null>opsional——
tasks[].attempts[].engine_version · variant 1stringopsional——
tasks[].attempts[].engine_version · variant 2nullopsional——
tasks[].attempts[].input_bytesanyOf<integer | null>opsional——
tasks[].attempts[].input_bytes · variant 1integeropsional——
tasks[].attempts[].input_bytes · variant 2nullopsional——
tasks[].attempts[].output_bytesanyOf<integer | null>opsional——
tasks[].attempts[].output_bytes · variant 1integeropsional——
tasks[].attempts[].output_bytes · variant 2nullopsional——
tasks[].attempts[].wall_msanyOf<integer | null>opsional——
tasks[].attempts[].wall_ms · variant 1integeropsional——
tasks[].attempts[].wall_ms · variant 2nullopsional——
tasks[].attempts[].cpu_msanyOf<integer | null>opsional——
tasks[].attempts[].cpu_ms · variant 1integeropsional——
tasks[].attempts[].cpu_ms · variant 2nullopsional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opsional——
tasks[].attempts[].peak_memory_mb · variant 1integeropsional——
tasks[].attempts[].peak_memory_mb · variant 2nullopsional——
tasks[].attempts[].temp_bytesanyOf<integer | null>opsional——
tasks[].attempts[].temp_bytes · variant 1integeropsional——
tasks[].attempts[].temp_bytes · variant 2nullopsional——
tasks[].attempts[].error_codeanyOf<string | null>opsional——
tasks[].attempts[].error_code · variant 1stringopsional——
tasks[].attempts[].error_code · variant 2nullopsional——
tasks[].attempts[].error_messageanyOf<string | null>opsional——
tasks[].attempts[].error_message · variant 1stringopsional——
tasks[].attempts[].error_message · variant 2nullopsional——
tasks[].attempts[].estimated_creditsanyOf<string | null>opsional——
tasks[].attempts[].estimated_credits · variant 1stringopsional——
tasks[].attempts[].estimated_credits · variant 2nullopsional——
tasks[].attempts[].settled_creditsanyOf<string | null>opsional——
tasks[].attempts[].settled_credits · variant 1stringopsional——
tasks[].attempts[].settled_credits · variant 2nullopsional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opsional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopsional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opsional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopsional——
tasks[].attempts[].started_atstringwajib—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opsional——
tasks[].attempts[].completed_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/jobs/{job_id}/waitWait JobJobs#

Wait Job. Jobs and Tasks are durable, project-scoped resources. Mutating requests support idempotent retry semantics where documented; terminal state is authoritative for completion and billing settlement. Required scopes: converterhq.jobs.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
job_idpathstringwajib—
timeoutqueryintegeropsional
default: 20min: 0max: 30

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
kindstringwajib——
statusstringwajib——
progressintegerwajib——
taganyOf<string | null>opsional——
tag · variant 1stringopsional——
tag · variant 2nullopsional——
client_reference_idanyOf<string | null>opsional——
client_reference_id · variant 1stringopsional——
client_reference_id · variant 2nullopsional——
metadataobjectopsional——
prioritystringwajib——
concurrency_limitintegeropsional—
default: 1
originstringwajib——
created_atstringwajib—
format: date-time
started_atanyOf<string | null>opsional——
started_at · variant 1stringopsional—
format: date-time
started_at · variant 2nullopsional——
completed_atanyOf<string | null>opsional——
completed_at · variant 1stringopsional—
format: date-time
completed_at · variant 2nullopsional——
error_codeanyOf<string | null>opsional——
error_code · variant 1stringopsional——
error_code · variant 2nullopsional——
error_messageanyOf<string | null>opsional——
error_message · variant 1stringopsional——
error_message · variant 2nullopsional——
tasksobject[]opsional——
tasks[]objectopsional——
tasks[].idstringwajib——
tasks[].job_idstringwajib——
tasks[].namestringwajib——
tasks[].operationstringwajib——
tasks[].statusstringwajib——
tasks[].progressintegerwajib——
tasks[].inputobjectwajib——
tasks[].optionsobjectwajib——
tasks[].resultobjectwajib——
tasks[].requiredbooleanwajib——
tasks[].runtime_classstringwajib——
tasks[].prioritystringwajib——
tasks[].attempt_countintegerwajib——
tasks[].max_attemptsintegerwajib——
tasks[].error_codeanyOf<string | null>opsional——
tasks[].error_code · variant 1stringopsional——
tasks[].error_code · variant 2nullopsional——
tasks[].error_messageanyOf<string | null>opsional——
tasks[].error_message · variant 1stringopsional——
tasks[].error_message · variant 2nullopsional——
tasks[].created_atstringwajib—
format: date-time
tasks[].queued_atanyOf<string | null>opsional——
tasks[].queued_at · variant 1stringopsional—
format: date-time
tasks[].queued_at · variant 2nullopsional——
tasks[].started_atanyOf<string | null>opsional——
tasks[].started_at · variant 1stringopsional—
format: date-time
tasks[].started_at · variant 2nullopsional——
tasks[].completed_atanyOf<string | null>opsional——
tasks[].completed_at · variant 1stringopsional—
format: date-time
tasks[].completed_at · variant 2nullopsional——
tasks[].attemptsobject[]opsional——
tasks[].attempts[]objectopsional——
tasks[].attempts[].idstringwajib——
tasks[].attempts[].attempt_numberintegerwajib——
tasks[].attempts[].statusstringwajib——
tasks[].attempts[].worker_idanyOf<string | null>opsional——
tasks[].attempts[].worker_id · variant 1stringopsional——
tasks[].attempts[].worker_id · variant 2nullopsional——
tasks[].attempts[].runtime_classanyOf<string | null>opsional——
tasks[].attempts[].runtime_class · variant 1stringopsional——
tasks[].attempts[].runtime_class · variant 2nullopsional——
tasks[].attempts[].regionanyOf<string | null>opsional——
tasks[].attempts[].region · variant 1stringopsional——
tasks[].attempts[].region · variant 2nullopsional——
tasks[].attempts[].engineanyOf<string | null>opsional——
tasks[].attempts[].engine · variant 1stringopsional——
tasks[].attempts[].engine · variant 2nullopsional——
tasks[].attempts[].engine_versionanyOf<string | null>opsional——
tasks[].attempts[].engine_version · variant 1stringopsional——
tasks[].attempts[].engine_version · variant 2nullopsional——
tasks[].attempts[].input_bytesanyOf<integer | null>opsional——
tasks[].attempts[].input_bytes · variant 1integeropsional——
tasks[].attempts[].input_bytes · variant 2nullopsional——
tasks[].attempts[].output_bytesanyOf<integer | null>opsional——
tasks[].attempts[].output_bytes · variant 1integeropsional——
tasks[].attempts[].output_bytes · variant 2nullopsional——
tasks[].attempts[].wall_msanyOf<integer | null>opsional——
tasks[].attempts[].wall_ms · variant 1integeropsional——
tasks[].attempts[].wall_ms · variant 2nullopsional——
tasks[].attempts[].cpu_msanyOf<integer | null>opsional——
tasks[].attempts[].cpu_ms · variant 1integeropsional——
tasks[].attempts[].cpu_ms · variant 2nullopsional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opsional——
tasks[].attempts[].peak_memory_mb · variant 1integeropsional——
tasks[].attempts[].peak_memory_mb · variant 2nullopsional——
tasks[].attempts[].temp_bytesanyOf<integer | null>opsional——
tasks[].attempts[].temp_bytes · variant 1integeropsional——
tasks[].attempts[].temp_bytes · variant 2nullopsional——
tasks[].attempts[].error_codeanyOf<string | null>opsional——
tasks[].attempts[].error_code · variant 1stringopsional——
tasks[].attempts[].error_code · variant 2nullopsional——
tasks[].attempts[].error_messageanyOf<string | null>opsional——
tasks[].attempts[].error_message · variant 1stringopsional——
tasks[].attempts[].error_message · variant 2nullopsional——
tasks[].attempts[].estimated_creditsanyOf<string | null>opsional——
tasks[].attempts[].estimated_credits · variant 1stringopsional——
tasks[].attempts[].estimated_credits · variant 2nullopsional——
tasks[].attempts[].settled_creditsanyOf<string | null>opsional——
tasks[].attempts[].settled_credits · variant 1stringopsional——
tasks[].attempts[].settled_credits · variant 2nullopsional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opsional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopsional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opsional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopsional——
tasks[].attempts[].started_atstringwajib—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opsional——
tasks[].attempts[].completed_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/jobs/validateValidate JobJobs#

Validate Job. Jobs and Tasks are durable, project-scoped resources. Mutating requests support idempotent retry semantics where documented; terminal state is authoritative for completion and billing settlement. Required scopes: converterhq.jobs.write.

Autentikasi
ConverterHQBearerhttp / bearer

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
tasksobjectwajib——
taganyOf<string | null>opsional——
tag · variant 1stringopsional—
max length: 255
tag · variant 2nullopsional——
client_reference_idanyOf<string | null>opsional——
client_reference_id · variant 1stringopsional—
max length: 255
client_reference_id · variant 2nullopsional——
metadataobjectopsional——
prioritystringopsional—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>opsional——
retention_seconds · variant 1integeropsional—
min: 0max: 86400
retention_seconds · variant 2nullopsional——

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
validbooleanwajib——
task_countintegerwajib——
execution_orderstring[]wajib——
root_tasksstring[]wajib——
warningsstring[]opsional——
estimated_creditsanyOf<object | null>opsional——
estimated_credits · variant 1objectopsional——
estimated_credits · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/logsList LogsLogs#

List Logs. Request logs are project-scoped operational records intended for troubleshooting and correlation with request and Job identifiers. Required scopes: converterhq.logs.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
limitqueryintegeropsional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opsional—
status_codequeryanyOf<integer | null>opsional—
path_prefixqueryanyOf<string | null>opsional—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
dataobject[]wajib——
data[]objectopsional——
data[].request_idstringwajib——
data[].methodstringwajib——
data[].pathstringwajib——
data[].status_codeintegerwajib——
data[].latency_msintegerwajib——
data[].api_key_idanyOf<string | null>opsional——
data[].api_key_id · variant 1stringopsional——
data[].api_key_id · variant 2nullopsional——
data[].auth_typestringwajib——
data[].user_agentanyOf<string | null>opsional——
data[].user_agent · variant 1stringopsional——
data[].user_agent · variant 2nullopsional——
data[].created_atstringwajib——
paginationobjectwajib——
pagination.nextanyOf<string | null>opsional——
pagination.next · variant 1stringopsional——
pagination.next · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/logs/{request_id}Retrieve LogLogs#

Retrieve Log. Request logs are project-scoped operational records intended for troubleshooting and correlation with request and Job identifiers. Required scopes: converterhq.logs.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
request_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
request_idstringwajib——
methodstringwajib——
pathstringwajib——
status_codeintegerwajib——
latency_msintegerwajib——
api_key_idanyOf<string | null>opsional——
api_key_id · variant 1stringopsional——
api_key_id · variant 2nullopsional——
auth_typestringwajib——
user_agentanyOf<string | null>opsional——
user_agent · variant 1stringopsional——
user_agent · variant 2nullopsional——
created_atstringwajib——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/meCurrent PrincipalAuthentication#

Describe the authenticated ConverterHQ API principal. This intentionally exposes account/scopes and safe API-limit metadata rather than personal profile data or the raw commercial feature map. OAuth integrations use it as a lightweight connection/authentication test.

Autentikasi
ConverterHQBearerhttp / bearer

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
account_idstringwajib——
actor_idstringwajib——
auth_typestringwajib——
environmentstringwajib——
access_tierstringopsional—
enum: "sandbox", "paid"default: "paid"
scopesstring[]wajib——
roleanyOf<string | null>opsional——
role · variant 1stringopsional——
role · variant 2nullopsional——
authorized_partyanyOf<string | null>opsional——
authorized_party · variant 1stringopsional——
authorized_party · variant 2nullopsional——
limitsanyOf<object | null>opsional——
limits · variant 1objectopsional——
limits · variant 1.monthly_callsanyOf<integer | null>opsional——
limits · variant 1.monthly_calls · variant 1integeropsional——
limits · variant 1.monthly_calls · variant 2nullopsional——
limits · variant 1.rate_limit_per_minuteanyOf<integer | null>opsional——
limits · variant 1.rate_limit_per_minute · variant 1integeropsional——
limits · variant 1.rate_limit_per_minute · variant 2nullopsional——
limits · variant 1.daily_requestsanyOf<integer | null>opsional——
limits · variant 1.daily_requests · variant 1integeropsional——
limits · variant 1.daily_requests · variant 2nullopsional——
limits · variant 1.concurrencyanyOf<integer | null>opsional——
limits · variant 1.concurrency · variant 1integeropsional——
limits · variant 1.concurrency · variant 2nullopsional——
limits · variant 1.max_file_mbanyOf<integer | null>opsional——
limits · variant 1.max_file_mb · variant 1integeropsional——
limits · variant 1.max_file_mb · variant 2nullopsional——
limits · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/operationsOperationsDiscovery#

Operations. Discovery metadata enumerates stable public API primitives used by clients and integrations. No authentication is required.

AutentikasiPublik / tanpa persyaratan keamanan khusus operasi

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
dataobject[]wajib——
data[]objectopsional——
data[].operationstringwajib——
data[].categorystringwajib—
enum: "import", "processing", "export"
data[].descriptionstringwajib——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/projectCurrent ProjectAuthentication · Authentication#

Describe the project namespace carried by the current credential. Project-bound API keys resolve implicitly. Legacy API keys and OAuth tokens remain account-scoped until explicit OAuth project selection is introduced.

Autentikasi
ConverterHQBearerhttp / bearer

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
account_idstringwajib——
environmentstringwajib——
scopedbooleanwajib——
project_idanyOf<string | null>opsional——
project_id · variant 1stringopsional——
project_id · variant 2nullopsional——
project_nameanyOf<string | null>opsional——
project_name · variant 1stringopsional——
project_name · variant 2nullopsional——
project_sluganyOf<string | null>opsional——
project_slug · variant 1stringopsional——
project_slug · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/project/legacy-migrationPreview Legacy MigrationAuthentication · Projects#

Preview account/environment resources still in the legacy namespace.

Autentikasi
ConverterHQBearerhttp / bearer

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
bodyobjectwajib——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/project/legacy-migrationMigrate Legacy Project ResourcesAuthentication · Projects#

Atomically claim legacy durable resources into the current API-key project.

Autentikasi
ConverterHQBearerhttp / bearer

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
confirm_project_idstringwajib—
min length: 1max length: 64

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
bodyobjectwajib——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/realtime/tokensCreate Realtime TokenRealtime#

Create Realtime Token. Realtime endpoints expose short-lived authorization or server-sent lifecycle events. Reconnect using the documented event cursor rather than assuming a single uninterrupted stream. Required scopes: converterhq.realtime.connect.

Autentikasi
ConverterHQBearerhttp / bearer

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
tokenstringwajib——
expires_atstringwajib—
format: date-time
websocket_urlstringwajib——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/sandbox/fixturesFixturesSandbox#

Fixtures. Sandbox fixtures exercise lifecycle behavior without charging production entitlements. Fixture success does not by itself prove semantic conversion quality. Required scopes: converterhq.jobs.read.

Autentikasi
ConverterHQBearerhttp / bearer

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
bodyobjectwajib——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/sandbox/fixtures/{fixture_id}FixtureSandbox#

Fixture. Sandbox fixtures exercise lifecycle behavior without charging production entitlements. Fixture success does not by itself prove semantic conversion quality. Required scopes: converterhq.jobs.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
fixture_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
bodyobjectwajib——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/signed-url-basesList BasesSigned URLs#

List Bases. Signed URL bases create short-lived conversion entry points without exposing the underlying API credential. Bases remain project-scoped and revocable. Required scopes: converterhq.signed_urls.read.

Autentikasi
ConverterHQBearerhttp / bearer

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
bodyobject[]wajib——
items[]objectopsional——
items[].idstringwajib——
items[].namestringwajib——
items[].workflow_idanyOf<string | null>opsional——
items[].workflow_id · variant 1stringopsional——
items[].workflow_id · variant 2nullopsional——
items[].workflow_versionanyOf<integer | null>opsional——
items[].workflow_version · variant 1integeropsional——
items[].workflow_version · variant 2nullopsional——
items[].inline_definitionanyOf<object | null>opsional——
items[].inline_definition · variant 1objectopsional——
items[].inline_definition · variant 2nullopsional——
items[].variables_schemaobjectwajib——
items[].allowed_source_hostsstring[]wajib——
items[].max_file_size_bytesanyOf<integer | null>opsional——
items[].max_file_size_bytes · variant 1integeropsional——
items[].max_file_size_bytes · variant 2nullopsional——
items[].max_credits_per_requestanyOf<string | null>opsional——
items[].max_credits_per_request · variant 1stringopsional——
items[].max_credits_per_request · variant 2nullopsional——
items[].max_usesanyOf<integer | null>opsional——
items[].max_uses · variant 1integeropsional——
items[].max_uses · variant 2nullopsional——
items[].use_countintegerwajib——
items[].cache_ttl_secondsintegerwajib——
items[].enabledbooleanwajib——
items[].created_atstringwajib—
format: date-time
items[].updated_atstringwajib—
format: date-time
items[].signing_secretanyOf<string | null>opsional——
items[].signing_secret · variant 1stringopsional——
items[].signing_secret · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/signed-url-basesCreate BaseSigned URLs#

Create Base. Signed URL bases create short-lived conversion entry points without exposing the underlying API credential. Bases remain project-scoped and revocable. Required scopes: converterhq.signed_urls.write.

Autentikasi
ConverterHQBearerhttp / bearer

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
namestringwajib—
min length: 1max length: 255
workflow_idanyOf<string | null>opsional——
workflow_id · variant 1stringopsional——
workflow_id · variant 2nullopsional——
inline_definitionanyOf<object | null>opsional——
inline_definition · variant 1objectopsional——
inline_definition · variant 1.tasksobjectwajib——
inline_definition · variant 1.taganyOf<string | null>opsional——
inline_definition · variant 1.tag · variant 1stringopsional—
max length: 255
inline_definition · variant 1.tag · variant 2nullopsional——
inline_definition · variant 1.client_reference_idanyOf<string | null>opsional——
inline_definition · variant 1.client_reference_id · variant 1stringopsional—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nullopsional——
inline_definition · variant 1.metadataobjectopsional——
inline_definition · variant 1.prioritystringopsional—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>opsional——
inline_definition · variant 1.retention_seconds · variant 1integeropsional—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nullopsional——
inline_definition · variant 2nullopsional——
variables_schemaobjectopsional——
allowed_source_hostsstring[]opsional——
max_file_size_bytesanyOf<integer | null>opsional——
max_file_size_bytes · variant 1integeropsional——
max_file_size_bytes · variant 2nullopsional——
max_credits_per_requestanyOf<string | null>opsional——
max_credits_per_request · variant 1stringopsional—
max length: 64
max_credits_per_request · variant 2nullopsional——
max_usesanyOf<integer | null>opsional——
max_uses · variant 1integeropsional——
max_uses · variant 2nullopsional——
cache_ttl_secondsintegeropsional—
default: 0min: 0max: 86400

Respons

201Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
namestringwajib——
workflow_idanyOf<string | null>opsional——
workflow_id · variant 1stringopsional——
workflow_id · variant 2nullopsional——
workflow_versionanyOf<integer | null>opsional——
workflow_version · variant 1integeropsional——
workflow_version · variant 2nullopsional——
inline_definitionanyOf<object | null>opsional——
inline_definition · variant 1objectopsional——
inline_definition · variant 2nullopsional——
variables_schemaobjectwajib——
allowed_source_hostsstring[]wajib——
max_file_size_bytesanyOf<integer | null>opsional——
max_file_size_bytes · variant 1integeropsional——
max_file_size_bytes · variant 2nullopsional——
max_credits_per_requestanyOf<string | null>opsional——
max_credits_per_request · variant 1stringopsional——
max_credits_per_request · variant 2nullopsional——
max_usesanyOf<integer | null>opsional——
max_uses · variant 1integeropsional——
max_uses · variant 2nullopsional——
use_countintegerwajib——
cache_ttl_secondsintegerwajib——
enabledbooleanwajib——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
signing_secretanyOf<string | null>opsional——
signing_secret · variant 1stringopsional——
signing_secret · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
DELETE/v1/signed-url-bases/{base_id}Delete BaseSigned URLs#

Delete Base. Signed URL bases create short-lived conversion entry points without exposing the underlying API credential. Bases remain project-scoped and revocable. Required scopes: converterhq.signed_urls.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
base_idpathstringwajib—

Respons

204Successful Response

Tidak ada isi respons.

400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/signed-url-bases/{base_id}Get BaseSigned URLs#

Get Base. Signed URL bases create short-lived conversion entry points without exposing the underlying API credential. Bases remain project-scoped and revocable. Required scopes: converterhq.signed_urls.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
base_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
namestringwajib——
workflow_idanyOf<string | null>opsional——
workflow_id · variant 1stringopsional——
workflow_id · variant 2nullopsional——
workflow_versionanyOf<integer | null>opsional——
workflow_version · variant 1integeropsional——
workflow_version · variant 2nullopsional——
inline_definitionanyOf<object | null>opsional——
inline_definition · variant 1objectopsional——
inline_definition · variant 2nullopsional——
variables_schemaobjectwajib——
allowed_source_hostsstring[]wajib——
max_file_size_bytesanyOf<integer | null>opsional——
max_file_size_bytes · variant 1integeropsional——
max_file_size_bytes · variant 2nullopsional——
max_credits_per_requestanyOf<string | null>opsional——
max_credits_per_request · variant 1stringopsional——
max_credits_per_request · variant 2nullopsional——
max_usesanyOf<integer | null>opsional——
max_uses · variant 1integeropsional——
max_uses · variant 2nullopsional——
use_countintegerwajib——
cache_ttl_secondsintegerwajib——
enabledbooleanwajib——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
signing_secretanyOf<string | null>opsional——
signing_secret · variant 1stringopsional——
signing_secret · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
PATCH/v1/signed-url-bases/{base_id}Update BaseSigned URLs#

Update Base. Signed URL bases create short-lived conversion entry points without exposing the underlying API credential. Bases remain project-scoped and revocable. Required scopes: converterhq.signed_urls.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
base_idpathstringwajib—

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
nameanyOf<string | null>opsional——
name · variant 1stringopsional—
min length: 1max length: 255
name · variant 2nullopsional——
workflow_idanyOf<string | null>opsional——
workflow_id · variant 1stringopsional——
workflow_id · variant 2nullopsional——
inline_definitionanyOf<object | null>opsional——
inline_definition · variant 1objectopsional——
inline_definition · variant 1.tasksobjectwajib——
inline_definition · variant 1.taganyOf<string | null>opsional——
inline_definition · variant 1.tag · variant 1stringopsional—
max length: 255
inline_definition · variant 1.tag · variant 2nullopsional——
inline_definition · variant 1.client_reference_idanyOf<string | null>opsional——
inline_definition · variant 1.client_reference_id · variant 1stringopsional—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nullopsional——
inline_definition · variant 1.metadataobjectopsional——
inline_definition · variant 1.prioritystringopsional—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>opsional——
inline_definition · variant 1.retention_seconds · variant 1integeropsional—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nullopsional——
inline_definition · variant 2nullopsional——
variables_schemaanyOf<object | null>opsional——
variables_schema · variant 1objectopsional——
variables_schema · variant 2nullopsional——
allowed_source_hostsanyOf<string[] | null>opsional——
allowed_source_hosts · variant 1string[]opsional——
allowed_source_hosts · variant 2nullopsional——
max_file_size_bytesanyOf<integer | null>opsional——
max_file_size_bytes · variant 1integeropsional——
max_file_size_bytes · variant 2nullopsional——
max_credits_per_requestanyOf<string | null>opsional——
max_credits_per_request · variant 1stringopsional—
max length: 64
max_credits_per_request · variant 2nullopsional——
max_usesanyOf<integer | null>opsional——
max_uses · variant 1integeropsional——
max_uses · variant 2nullopsional——
cache_ttl_secondsanyOf<integer | null>opsional——
cache_ttl_seconds · variant 1integeropsional—
min: 0max: 86400
cache_ttl_seconds · variant 2nullopsional——
enabledanyOf<boolean | null>opsional——
enabled · variant 1booleanopsional——
enabled · variant 2nullopsional——

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
namestringwajib——
workflow_idanyOf<string | null>opsional——
workflow_id · variant 1stringopsional——
workflow_id · variant 2nullopsional——
workflow_versionanyOf<integer | null>opsional——
workflow_version · variant 1integeropsional——
workflow_version · variant 2nullopsional——
inline_definitionanyOf<object | null>opsional——
inline_definition · variant 1objectopsional——
inline_definition · variant 2nullopsional——
variables_schemaobjectwajib——
allowed_source_hostsstring[]wajib——
max_file_size_bytesanyOf<integer | null>opsional——
max_file_size_bytes · variant 1integeropsional——
max_file_size_bytes · variant 2nullopsional——
max_credits_per_requestanyOf<string | null>opsional——
max_credits_per_request · variant 1stringopsional——
max_credits_per_request · variant 2nullopsional——
max_usesanyOf<integer | null>opsional——
max_uses · variant 1integeropsional——
max_uses · variant 2nullopsional——
use_countintegerwajib——
cache_ttl_secondsintegerwajib——
enabledbooleanwajib——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
signing_secretanyOf<string | null>opsional——
signing_secret · variant 1stringopsional——
signing_secret · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/signed-url-bases/{base_id}/rotate-secretRotate SecretSigned URLs#

Rotate Secret. Signed URL bases create short-lived conversion entry points without exposing the underlying API credential. Bases remain project-scoped and revocable. Required scopes: converterhq.signed_urls.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
base_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
namestringwajib——
workflow_idanyOf<string | null>opsional——
workflow_id · variant 1stringopsional——
workflow_id · variant 2nullopsional——
workflow_versionanyOf<integer | null>opsional——
workflow_version · variant 1integeropsional——
workflow_version · variant 2nullopsional——
inline_definitionanyOf<object | null>opsional——
inline_definition · variant 1objectopsional——
inline_definition · variant 2nullopsional——
variables_schemaobjectwajib——
allowed_source_hostsstring[]wajib——
max_file_size_bytesanyOf<integer | null>opsional——
max_file_size_bytes · variant 1integeropsional——
max_file_size_bytes · variant 2nullopsional——
max_credits_per_requestanyOf<string | null>opsional——
max_credits_per_request · variant 1stringopsional——
max_credits_per_request · variant 2nullopsional——
max_usesanyOf<integer | null>opsional——
max_uses · variant 1integeropsional——
max_uses · variant 2nullopsional——
use_countintegerwajib——
cache_ttl_secondsintegerwajib——
enabledbooleanwajib——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
signing_secretanyOf<string | null>opsional——
signing_secret · variant 1stringopsional——
signing_secret · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/signed-url-bases/{base_id}/urlsCreate Signed UrlSigned URLs#

Create Signed Url. Signed URL bases create short-lived conversion entry points without exposing the underlying API credential. Bases remain project-scoped and revocable. Required scopes: converterhq.signed_urls.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
base_idpathstringwajib—

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
variablesobjectopsional——
expires_inintegeropsional—
default: 3600min: 60max: 86400
cache_keyanyOf<string | null>opsional——
cache_key · variant 1stringopsional—
max length: 255
cache_key · variant 2nullopsional——

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
urlstringwajib——
expires_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/system/healthCheck public API healthOperations#

Returns a lightweight liveness signal for the public ConverterHQ API. This endpoint is intentionally unauthenticated so status monitors and customers can distinguish API reachability from credential failures.

AutentikasiPublik / tanpa persyaratan keamanan khusus operasi

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
statusstringwajib—
enum: "ok", "degraded"
servicestringopsional—
default: "converterhq-api"
api_versionstringopsional—
default: "v1"
timestampstringwajib—
format: date-time
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/system/platform-statsGet real ConverterHQ platform activityOperations#

Returns a five-minute cached aggregate of successful conversions and input bytes processed. Values come from successful conversion usage events in the canonical ledger rather than synthetic counters and are safe to display on public trust surfaces.

AutentikasiPublik / tanpa persyaratan keamanan khusus operasi

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
successful_conversionsintegerwajib——
input_bytes_processedintegerwajib——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/tasks/{task_id}Get TaskJobs#

Get Task. Jobs and Tasks are durable, project-scoped resources. Mutating requests support idempotent retry semantics where documented; terminal state is authoritative for completion and billing settlement. Required scopes: converterhq.tasks.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
task_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
job_idstringwajib——
namestringwajib——
operationstringwajib——
statusstringwajib——
progressintegerwajib——
inputobjectwajib——
optionsobjectwajib——
resultobjectwajib——
requiredbooleanwajib——
runtime_classstringwajib——
prioritystringwajib——
attempt_countintegerwajib——
max_attemptsintegerwajib——
error_codeanyOf<string | null>opsional——
error_code · variant 1stringopsional——
error_code · variant 2nullopsional——
error_messageanyOf<string | null>opsional——
error_message · variant 1stringopsional——
error_message · variant 2nullopsional——
created_atstringwajib—
format: date-time
queued_atanyOf<string | null>opsional——
queued_at · variant 1stringopsional—
format: date-time
queued_at · variant 2nullopsional——
started_atanyOf<string | null>opsional——
started_at · variant 1stringopsional—
format: date-time
started_at · variant 2nullopsional——
completed_atanyOf<string | null>opsional——
completed_at · variant 1stringopsional—
format: date-time
completed_at · variant 2nullopsional——
attemptsobject[]opsional——
attempts[]objectopsional——
attempts[].idstringwajib——
attempts[].attempt_numberintegerwajib——
attempts[].statusstringwajib——
attempts[].worker_idanyOf<string | null>opsional——
attempts[].worker_id · variant 1stringopsional——
attempts[].worker_id · variant 2nullopsional——
attempts[].runtime_classanyOf<string | null>opsional——
attempts[].runtime_class · variant 1stringopsional——
attempts[].runtime_class · variant 2nullopsional——
attempts[].regionanyOf<string | null>opsional——
attempts[].region · variant 1stringopsional——
attempts[].region · variant 2nullopsional——
attempts[].engineanyOf<string | null>opsional——
attempts[].engine · variant 1stringopsional——
attempts[].engine · variant 2nullopsional——
attempts[].engine_versionanyOf<string | null>opsional——
attempts[].engine_version · variant 1stringopsional——
attempts[].engine_version · variant 2nullopsional——
attempts[].input_bytesanyOf<integer | null>opsional——
attempts[].input_bytes · variant 1integeropsional——
attempts[].input_bytes · variant 2nullopsional——
attempts[].output_bytesanyOf<integer | null>opsional——
attempts[].output_bytes · variant 1integeropsional——
attempts[].output_bytes · variant 2nullopsional——
attempts[].wall_msanyOf<integer | null>opsional——
attempts[].wall_ms · variant 1integeropsional——
attempts[].wall_ms · variant 2nullopsional——
attempts[].cpu_msanyOf<integer | null>opsional——
attempts[].cpu_ms · variant 1integeropsional——
attempts[].cpu_ms · variant 2nullopsional——
attempts[].peak_memory_mbanyOf<integer | null>opsional——
attempts[].peak_memory_mb · variant 1integeropsional——
attempts[].peak_memory_mb · variant 2nullopsional——
attempts[].temp_bytesanyOf<integer | null>opsional——
attempts[].temp_bytes · variant 1integeropsional——
attempts[].temp_bytes · variant 2nullopsional——
attempts[].error_codeanyOf<string | null>opsional——
attempts[].error_code · variant 1stringopsional——
attempts[].error_code · variant 2nullopsional——
attempts[].error_messageanyOf<string | null>opsional——
attempts[].error_message · variant 1stringopsional——
attempts[].error_message · variant 2nullopsional——
attempts[].estimated_creditsanyOf<string | null>opsional——
attempts[].estimated_credits · variant 1stringopsional——
attempts[].estimated_credits · variant 2nullopsional——
attempts[].settled_creditsanyOf<string | null>opsional——
attempts[].settled_credits · variant 1stringopsional——
attempts[].settled_credits · variant 2nullopsional——
attempts[].external_side_effect_started_atanyOf<string | null>opsional——
attempts[].external_side_effect_started_at · variant 1stringopsional—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullopsional——
attempts[].external_side_effect_committed_atanyOf<string | null>opsional——
attempts[].external_side_effect_committed_at · variant 1stringopsional—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullopsional——
attempts[].started_atstringwajib—
format: date-time
attempts[].completed_atanyOf<string | null>opsional——
attempts[].completed_at · variant 1stringopsional—
format: date-time
attempts[].completed_at · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/tasks/{task_id}/cancelCancel TaskJobs#

Cancel Task. Jobs and Tasks are durable, project-scoped resources. Mutating requests support idempotent retry semantics where documented; terminal state is authoritative for completion and billing settlement. Required scopes: converterhq.tasks.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
task_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
job_idstringwajib——
namestringwajib——
operationstringwajib——
statusstringwajib——
progressintegerwajib——
inputobjectwajib——
optionsobjectwajib——
resultobjectwajib——
requiredbooleanwajib——
runtime_classstringwajib——
prioritystringwajib——
attempt_countintegerwajib——
max_attemptsintegerwajib——
error_codeanyOf<string | null>opsional——
error_code · variant 1stringopsional——
error_code · variant 2nullopsional——
error_messageanyOf<string | null>opsional——
error_message · variant 1stringopsional——
error_message · variant 2nullopsional——
created_atstringwajib—
format: date-time
queued_atanyOf<string | null>opsional——
queued_at · variant 1stringopsional—
format: date-time
queued_at · variant 2nullopsional——
started_atanyOf<string | null>opsional——
started_at · variant 1stringopsional—
format: date-time
started_at · variant 2nullopsional——
completed_atanyOf<string | null>opsional——
completed_at · variant 1stringopsional—
format: date-time
completed_at · variant 2nullopsional——
attemptsobject[]opsional——
attempts[]objectopsional——
attempts[].idstringwajib——
attempts[].attempt_numberintegerwajib——
attempts[].statusstringwajib——
attempts[].worker_idanyOf<string | null>opsional——
attempts[].worker_id · variant 1stringopsional——
attempts[].worker_id · variant 2nullopsional——
attempts[].runtime_classanyOf<string | null>opsional——
attempts[].runtime_class · variant 1stringopsional——
attempts[].runtime_class · variant 2nullopsional——
attempts[].regionanyOf<string | null>opsional——
attempts[].region · variant 1stringopsional——
attempts[].region · variant 2nullopsional——
attempts[].engineanyOf<string | null>opsional——
attempts[].engine · variant 1stringopsional——
attempts[].engine · variant 2nullopsional——
attempts[].engine_versionanyOf<string | null>opsional——
attempts[].engine_version · variant 1stringopsional——
attempts[].engine_version · variant 2nullopsional——
attempts[].input_bytesanyOf<integer | null>opsional——
attempts[].input_bytes · variant 1integeropsional——
attempts[].input_bytes · variant 2nullopsional——
attempts[].output_bytesanyOf<integer | null>opsional——
attempts[].output_bytes · variant 1integeropsional——
attempts[].output_bytes · variant 2nullopsional——
attempts[].wall_msanyOf<integer | null>opsional——
attempts[].wall_ms · variant 1integeropsional——
attempts[].wall_ms · variant 2nullopsional——
attempts[].cpu_msanyOf<integer | null>opsional——
attempts[].cpu_ms · variant 1integeropsional——
attempts[].cpu_ms · variant 2nullopsional——
attempts[].peak_memory_mbanyOf<integer | null>opsional——
attempts[].peak_memory_mb · variant 1integeropsional——
attempts[].peak_memory_mb · variant 2nullopsional——
attempts[].temp_bytesanyOf<integer | null>opsional——
attempts[].temp_bytes · variant 1integeropsional——
attempts[].temp_bytes · variant 2nullopsional——
attempts[].error_codeanyOf<string | null>opsional——
attempts[].error_code · variant 1stringopsional——
attempts[].error_code · variant 2nullopsional——
attempts[].error_messageanyOf<string | null>opsional——
attempts[].error_message · variant 1stringopsional——
attempts[].error_message · variant 2nullopsional——
attempts[].estimated_creditsanyOf<string | null>opsional——
attempts[].estimated_credits · variant 1stringopsional——
attempts[].estimated_credits · variant 2nullopsional——
attempts[].settled_creditsanyOf<string | null>opsional——
attempts[].settled_credits · variant 1stringopsional——
attempts[].settled_credits · variant 2nullopsional——
attempts[].external_side_effect_started_atanyOf<string | null>opsional——
attempts[].external_side_effect_started_at · variant 1stringopsional—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullopsional——
attempts[].external_side_effect_committed_atanyOf<string | null>opsional——
attempts[].external_side_effect_committed_at · variant 1stringopsional—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullopsional——
attempts[].started_atstringwajib—
format: date-time
attempts[].completed_atanyOf<string | null>opsional——
attempts[].completed_at · variant 1stringopsional—
format: date-time
attempts[].completed_at · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/tasks/{task_id}/eventsTask EventsRealtime#

Task Events. Realtime endpoints expose short-lived authorization or server-sent lifecycle events. Reconnect using the documented event cursor rather than assuming a single uninterrupted stream. Required scopes: converterhq.tasks.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
task_idpathstringwajib—
timeoutqueryintegeropsional
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>opsional—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
bodyunknownwajib——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/tasks/{task_id}/retryRetry TaskJobs#

Retry Task. Jobs and Tasks are durable, project-scoped resources. Mutating requests support idempotent retry semantics where documented; terminal state is authoritative for completion and billing settlement. Required scopes: converterhq.tasks.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
task_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
job_idstringwajib——
namestringwajib——
operationstringwajib——
statusstringwajib——
progressintegerwajib——
inputobjectwajib——
optionsobjectwajib——
resultobjectwajib——
requiredbooleanwajib——
runtime_classstringwajib——
prioritystringwajib——
attempt_countintegerwajib——
max_attemptsintegerwajib——
error_codeanyOf<string | null>opsional——
error_code · variant 1stringopsional——
error_code · variant 2nullopsional——
error_messageanyOf<string | null>opsional——
error_message · variant 1stringopsional——
error_message · variant 2nullopsional——
created_atstringwajib—
format: date-time
queued_atanyOf<string | null>opsional——
queued_at · variant 1stringopsional—
format: date-time
queued_at · variant 2nullopsional——
started_atanyOf<string | null>opsional——
started_at · variant 1stringopsional—
format: date-time
started_at · variant 2nullopsional——
completed_atanyOf<string | null>opsional——
completed_at · variant 1stringopsional—
format: date-time
completed_at · variant 2nullopsional——
attemptsobject[]opsional——
attempts[]objectopsional——
attempts[].idstringwajib——
attempts[].attempt_numberintegerwajib——
attempts[].statusstringwajib——
attempts[].worker_idanyOf<string | null>opsional——
attempts[].worker_id · variant 1stringopsional——
attempts[].worker_id · variant 2nullopsional——
attempts[].runtime_classanyOf<string | null>opsional——
attempts[].runtime_class · variant 1stringopsional——
attempts[].runtime_class · variant 2nullopsional——
attempts[].regionanyOf<string | null>opsional——
attempts[].region · variant 1stringopsional——
attempts[].region · variant 2nullopsional——
attempts[].engineanyOf<string | null>opsional——
attempts[].engine · variant 1stringopsional——
attempts[].engine · variant 2nullopsional——
attempts[].engine_versionanyOf<string | null>opsional——
attempts[].engine_version · variant 1stringopsional——
attempts[].engine_version · variant 2nullopsional——
attempts[].input_bytesanyOf<integer | null>opsional——
attempts[].input_bytes · variant 1integeropsional——
attempts[].input_bytes · variant 2nullopsional——
attempts[].output_bytesanyOf<integer | null>opsional——
attempts[].output_bytes · variant 1integeropsional——
attempts[].output_bytes · variant 2nullopsional——
attempts[].wall_msanyOf<integer | null>opsional——
attempts[].wall_ms · variant 1integeropsional——
attempts[].wall_ms · variant 2nullopsional——
attempts[].cpu_msanyOf<integer | null>opsional——
attempts[].cpu_ms · variant 1integeropsional——
attempts[].cpu_ms · variant 2nullopsional——
attempts[].peak_memory_mbanyOf<integer | null>opsional——
attempts[].peak_memory_mb · variant 1integeropsional——
attempts[].peak_memory_mb · variant 2nullopsional——
attempts[].temp_bytesanyOf<integer | null>opsional——
attempts[].temp_bytes · variant 1integeropsional——
attempts[].temp_bytes · variant 2nullopsional——
attempts[].error_codeanyOf<string | null>opsional——
attempts[].error_code · variant 1stringopsional——
attempts[].error_code · variant 2nullopsional——
attempts[].error_messageanyOf<string | null>opsional——
attempts[].error_message · variant 1stringopsional——
attempts[].error_message · variant 2nullopsional——
attempts[].estimated_creditsanyOf<string | null>opsional——
attempts[].estimated_credits · variant 1stringopsional——
attempts[].estimated_credits · variant 2nullopsional——
attempts[].settled_creditsanyOf<string | null>opsional——
attempts[].settled_credits · variant 1stringopsional——
attempts[].settled_credits · variant 2nullopsional——
attempts[].external_side_effect_started_atanyOf<string | null>opsional——
attempts[].external_side_effect_started_at · variant 1stringopsional—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullopsional——
attempts[].external_side_effect_committed_atanyOf<string | null>opsional——
attempts[].external_side_effect_committed_at · variant 1stringopsional—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullopsional——
attempts[].started_atstringwajib—
format: date-time
attempts[].completed_atanyOf<string | null>opsional——
attempts[].completed_at · variant 1stringopsional—
format: date-time
attempts[].completed_at · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/usageList UsageUsage#

List Usage. Usage is project-scoped metering evidence. Treat settled usage as authoritative rather than deriving charges from HTTP retries or file size alone. Required scopes: converterhq.usage.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
limitqueryintegeropsional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opsional—
input_formatqueryanyOf<string | null>opsional—
output_formatqueryanyOf<string | null>opsional—
originqueryanyOf<string | null>opsional—
outcomequeryanyOf<string | null>opsional—
job_idqueryanyOf<string | null>opsional—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
dataobject[]wajib——
data[]objectopsional——
data[].idstringwajib——
data[].api_key_idanyOf<string | null>opsional——
data[].api_key_id · variant 1stringopsional——
data[].api_key_id · variant 2nullopsional——
data[].originstringwajib——
data[].outcomestringopsional—
default: "succeeded"
data[].job_idanyOf<string | null>opsional——
data[].job_id · variant 1stringopsional——
data[].job_id · variant 2nullopsional——
data[].task_idanyOf<string | null>opsional——
data[].task_id · variant 1stringopsional——
data[].task_id · variant 2nullopsional——
data[].input_formatanyOf<string | null>opsional——
data[].input_format · variant 1stringopsional——
data[].input_format · variant 2nullopsional——
data[].output_formatanyOf<string | null>opsional——
data[].output_format · variant 1stringopsional——
data[].output_format · variant 2nullopsional——
data[].engineanyOf<string | null>opsional——
data[].engine · variant 1stringopsional——
data[].engine · variant 2nullopsional——
data[].engine_versionanyOf<string | null>opsional——
data[].engine_version · variant 1stringopsional——
data[].engine_version · variant 2nullopsional——
data[].runtime_classanyOf<string | null>opsional——
data[].runtime_class · variant 1stringopsional——
data[].runtime_class · variant 2nullopsional——
data[].input_bytesanyOf<integer | null>opsional——
data[].input_bytes · variant 1integeropsional——
data[].input_bytes · variant 2nullopsional——
data[].output_bytesanyOf<integer | null>opsional——
data[].output_bytes · variant 1integeropsional——
data[].output_bytes · variant 2nullopsional——
data[].wall_msanyOf<integer | null>opsional——
data[].wall_ms · variant 1integeropsional——
data[].wall_ms · variant 2nullopsional——
data[].creditsanyOf<string | null>opsional——
data[].credits · variant 1stringopsional——
data[].credits · variant 2nullopsional——
data[].created_atstringwajib—
format: date-time
paginationobjectwajib——
pagination.nextanyOf<string | null>opsional——
pagination.next · variant 1stringopsional——
pagination.next · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/usage/summaryUsage SummaryUsage#

Usage Summary. Usage is project-scoped metering evidence. Treat settled usage as authoritative rather than deriving charges from HTTP retries or file size alone. Required scopes: converterhq.usage.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
startqueryanyOf<string | null>opsional—
endqueryanyOf<string | null>opsional—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
startstringwajib—
format: date-time
endstringwajib—
format: date-time
conversionsintegerwajib——
creditsstringwajib——
input_bytesintegerwajib——
output_bytesintegerwajib——
wall_msintegerwajib——
by_originobject[]opsional——
by_origin[]objectopsional——
by_origin[].keystringwajib——
by_origin[].conversionsintegerwajib——
by_origin[].creditsstringwajib——
top_pairsobject[]opsional——
top_pairs[]objectopsional——
top_pairs[].keystringwajib——
top_pairs[].conversionsintegerwajib——
top_pairs[].creditsstringwajib——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/webhook-deliveries/{delivery_id}Get DeliveryWebhooks#

Get Delivery. Webhooks deliver signed lifecycle events. Delivery records are durable, replay is explicit, and secret rotation changes the credential used for subsequent signatures. Required scopes: converterhq.webhooks.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
delivery_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
webhook_idstringwajib——
event_idstringwajib——
statusstringwajib——
attemptintegerwajib——
request_headersobjectwajib——
request_bodyobjectwajib——
response_statusanyOf<integer | null>opsional——
response_status · variant 1integeropsional——
response_status · variant 2nullopsional——
response_bodyanyOf<string | null>opsional——
response_body · variant 1stringopsional——
response_body · variant 2nullopsional——
latency_msanyOf<integer | null>opsional——
latency_ms · variant 1integeropsional——
latency_ms · variant 2nullopsional——
error_messageanyOf<string | null>opsional——
error_message · variant 1stringopsional——
error_message · variant 2nullopsional——
next_retry_atanyOf<string | null>opsional——
next_retry_at · variant 1stringopsional—
format: date-time
next_retry_at · variant 2nullopsional——
delivered_atanyOf<string | null>opsional——
delivered_at · variant 1stringopsional—
format: date-time
delivered_at · variant 2nullopsional——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/webhook-deliveries/{delivery_id}/replayReplay DeliveryWebhooks#

Replay Delivery. Webhooks deliver signed lifecycle events. Delivery records are durable, replay is explicit, and secret rotation changes the credential used for subsequent signatures. Required scopes: converterhq.webhooks.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
delivery_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
webhook_idstringwajib——
event_idstringwajib——
statusstringwajib——
attemptintegerwajib——
request_headersobjectwajib——
request_bodyobjectwajib——
response_statusanyOf<integer | null>opsional——
response_status · variant 1integeropsional——
response_status · variant 2nullopsional——
response_bodyanyOf<string | null>opsional——
response_body · variant 1stringopsional——
response_body · variant 2nullopsional——
latency_msanyOf<integer | null>opsional——
latency_ms · variant 1integeropsional——
latency_ms · variant 2nullopsional——
error_messageanyOf<string | null>opsional——
error_message · variant 1stringopsional——
error_message · variant 2nullopsional——
next_retry_atanyOf<string | null>opsional——
next_retry_at · variant 1stringopsional—
format: date-time
next_retry_at · variant 2nullopsional——
delivered_atanyOf<string | null>opsional——
delivered_at · variant 1stringopsional—
format: date-time
delivered_at · variant 2nullopsional——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/webhooksList WebhooksWebhooks#

List Webhooks. Webhooks deliver signed lifecycle events. Delivery records are durable, replay is explicit, and secret rotation changes the credential used for subsequent signatures. Required scopes: converterhq.webhooks.read.

Autentikasi
ConverterHQBearerhttp / bearer

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
bodyobject[]wajib——
items[]objectopsional——
items[].idstringwajib——
items[].urlstringwajib——
items[].descriptionanyOf<string | null>opsional——
items[].description · variant 1stringopsional——
items[].description · variant 2nullopsional——
items[].event_typesstring[]wajib——
items[].enabledbooleanwajib——
items[].failure_countintegerwajib——
items[].created_atstringwajib—
format: date-time
items[].updated_atstringwajib—
format: date-time
items[].signing_secretanyOf<string | null>opsional——
items[].signing_secret · variant 1stringopsional——
items[].signing_secret · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/webhooksCreate WebhookWebhooks#

Create Webhook. Webhooks deliver signed lifecycle events. Delivery records are durable, replay is explicit, and secret rotation changes the credential used for subsequent signatures. Required scopes: converterhq.webhooks.write.

Autentikasi
ConverterHQBearerhttp / bearer

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
urlstringwajib—
min length: 1max length: 2048
descriptionanyOf<string | null>opsional——
description · variant 1stringopsional—
max length: 512
description · variant 2nullopsional——
event_typesstring[]opsional——

Respons

201Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
urlstringwajib——
descriptionanyOf<string | null>opsional——
description · variant 1stringopsional——
description · variant 2nullopsional——
event_typesstring[]wajib——
enabledbooleanwajib——
failure_countintegerwajib——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
signing_secretanyOf<string | null>opsional——
signing_secret · variant 1stringopsional——
signing_secret · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
DELETE/v1/webhooks/{webhook_id}Delete WebhookWebhooks#

Delete Webhook. Webhooks deliver signed lifecycle events. Delivery records are durable, replay is explicit, and secret rotation changes the credential used for subsequent signatures. Required scopes: converterhq.webhooks.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
webhook_idpathstringwajib—

Respons

204Successful Response

Tidak ada isi respons.

400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/webhooks/{webhook_id}Get WebhookWebhooks#

Get Webhook. Webhooks deliver signed lifecycle events. Delivery records are durable, replay is explicit, and secret rotation changes the credential used for subsequent signatures. Required scopes: converterhq.webhooks.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
webhook_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
urlstringwajib——
descriptionanyOf<string | null>opsional——
description · variant 1stringopsional——
description · variant 2nullopsional——
event_typesstring[]wajib——
enabledbooleanwajib——
failure_countintegerwajib——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
signing_secretanyOf<string | null>opsional——
signing_secret · variant 1stringopsional——
signing_secret · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
PATCH/v1/webhooks/{webhook_id}Update WebhookWebhooks#

Update Webhook. Webhooks deliver signed lifecycle events. Delivery records are durable, replay is explicit, and secret rotation changes the credential used for subsequent signatures. Required scopes: converterhq.webhooks.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
webhook_idpathstringwajib—

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
urlanyOf<string | null>opsional——
url · variant 1stringopsional—
min length: 1max length: 2048
url · variant 2nullopsional——
descriptionanyOf<string | null>opsional——
description · variant 1stringopsional—
max length: 512
description · variant 2nullopsional——
event_typesanyOf<string[] | null>opsional——
event_types · variant 1string[]opsional——
event_types · variant 2nullopsional——
enabledanyOf<boolean | null>opsional——
enabled · variant 1booleanopsional——
enabled · variant 2nullopsional——

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
urlstringwajib——
descriptionanyOf<string | null>opsional——
description · variant 1stringopsional——
description · variant 2nullopsional——
event_typesstring[]wajib——
enabledbooleanwajib——
failure_countintegerwajib——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
signing_secretanyOf<string | null>opsional——
signing_secret · variant 1stringopsional——
signing_secret · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/webhooks/{webhook_id}/deliveriesList DeliveriesWebhooks#

List Deliveries. Webhooks deliver signed lifecycle events. Delivery records are durable, replay is explicit, and secret rotation changes the credential used for subsequent signatures. Required scopes: converterhq.webhooks.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
webhook_idpathstringwajib—
limitqueryintegeropsional
default: 50min: 1max: 100
afterqueryanyOf<string | null>opsional—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
dataobject[]wajib——
data[]objectopsional——
data[].idstringwajib——
data[].webhook_idstringwajib——
data[].event_idstringwajib——
data[].statusstringwajib——
data[].attemptintegerwajib——
data[].request_headersobjectwajib——
data[].request_bodyobjectwajib——
data[].response_statusanyOf<integer | null>opsional——
data[].response_status · variant 1integeropsional——
data[].response_status · variant 2nullopsional——
data[].response_bodyanyOf<string | null>opsional——
data[].response_body · variant 1stringopsional——
data[].response_body · variant 2nullopsional——
data[].latency_msanyOf<integer | null>opsional——
data[].latency_ms · variant 1integeropsional——
data[].latency_ms · variant 2nullopsional——
data[].error_messageanyOf<string | null>opsional——
data[].error_message · variant 1stringopsional——
data[].error_message · variant 2nullopsional——
data[].next_retry_atanyOf<string | null>opsional——
data[].next_retry_at · variant 1stringopsional—
format: date-time
data[].next_retry_at · variant 2nullopsional——
data[].delivered_atanyOf<string | null>opsional——
data[].delivered_at · variant 1stringopsional—
format: date-time
data[].delivered_at · variant 2nullopsional——
data[].created_atstringwajib—
format: date-time
data[].updated_atstringwajib—
format: date-time
paginationobjectwajib——
pagination.nextanyOf<string | null>opsional——
pagination.next · variant 1stringopsional——
pagination.next · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/webhooks/{webhook_id}/rotate-secretRotate Webhook SecretWebhooks#

Rotate Webhook Secret. Webhooks deliver signed lifecycle events. Delivery records are durable, replay is explicit, and secret rotation changes the credential used for subsequent signatures. Required scopes: converterhq.webhooks.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
webhook_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
signing_secretstringwajib——
previous_secret_valid_untilanyOf<string | null>opsional——
previous_secret_valid_until · variant 1stringopsional—
format: date-time
previous_secret_valid_until · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/workflowsList WorkflowsWorkflows#

List Workflows. Workflows are reusable project-owned job definitions. Running a workflow creates durable work and validates variables before execution. Required scopes: converterhq.workflows.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
limitqueryintegeropsional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opsional—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
dataobject[]wajib——
data[]objectopsional——
data[].idstringwajib——
data[].namestringwajib——
data[].descriptionanyOf<string | null>opsional——
data[].description · variant 1stringopsional——
data[].description · variant 2nullopsional——
data[].current_versionintegerwajib——
data[].definitionobjectwajib——
data[].variables_schemaobjectwajib——
data[].metadataobjectwajib——
data[].created_atstringwajib—
format: date-time
data[].updated_atstringwajib—
format: date-time
paginationobjectwajib——
pagination.nextanyOf<string | null>opsional——
pagination.next · variant 1stringopsional——
pagination.next · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/workflowsCreate Workflow RouteWorkflows#

Create Workflow Route. Workflows are reusable project-owned job definitions. Running a workflow creates durable work and validates variables before execution. Required scopes: converterhq.workflows.write.

Autentikasi
ConverterHQBearerhttp / bearer

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
namestringwajib—
min length: 1max length: 255
descriptionanyOf<string | null>opsional——
description · variant 1stringopsional—
max length: 2000
description · variant 2nullopsional——
definitionobjectwajib——
definition.tasksobjectwajib——
definition.taganyOf<string | null>opsional——
definition.tag · variant 1stringopsional—
max length: 255
definition.tag · variant 2nullopsional——
definition.client_reference_idanyOf<string | null>opsional——
definition.client_reference_id · variant 1stringopsional—
max length: 255
definition.client_reference_id · variant 2nullopsional——
definition.metadataobjectopsional——
definition.prioritystringopsional—
enum: "low", "normal", "high"default: "normal"
definition.retention_secondsanyOf<integer | null>opsional——
definition.retention_seconds · variant 1integeropsional—
min: 0max: 86400
definition.retention_seconds · variant 2nullopsional——
variables_schemaobjectopsional——
metadataobjectopsional——

Respons

201Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
namestringwajib——
descriptionanyOf<string | null>opsional——
description · variant 1stringopsional——
description · variant 2nullopsional——
current_versionintegerwajib——
definitionobjectwajib——
variables_schemaobjectwajib——
metadataobjectwajib——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
DELETE/v1/workflows/{workflow_id}Delete WorkflowWorkflows#

Delete Workflow. Workflows are reusable project-owned job definitions. Running a workflow creates durable work and validates variables before execution. Required scopes: converterhq.workflows.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
workflow_idpathstringwajib—

Respons

204Successful Response

Tidak ada isi respons.

400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
GET/v1/workflows/{workflow_id}Get WorkflowWorkflows#

Get Workflow. Workflows are reusable project-owned job definitions. Running a workflow creates durable work and validates variables before execution. Required scopes: converterhq.workflows.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
workflow_idpathstringwajib—

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
namestringwajib——
descriptionanyOf<string | null>opsional——
description · variant 1stringopsional——
description · variant 2nullopsional——
current_versionintegerwajib——
definitionobjectwajib——
variables_schemaobjectwajib——
metadataobjectwajib——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
PATCH/v1/workflows/{workflow_id}Update WorkflowWorkflows#

Update Workflow. Workflows are reusable project-owned job definitions. Running a workflow creates durable work and validates variables before execution. Required scopes: converterhq.workflows.write.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
workflow_idpathstringwajib—

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
nameanyOf<string | null>opsional——
name · variant 1stringopsional—
min length: 1max length: 255
name · variant 2nullopsional——
descriptionanyOf<string | null>opsional——
description · variant 1stringopsional—
max length: 2000
description · variant 2nullopsional——
definitionanyOf<object | null>opsional——
definition · variant 1objectopsional——
definition · variant 1.tasksobjectwajib——
definition · variant 1.taganyOf<string | null>opsional——
definition · variant 1.tag · variant 1stringopsional—
max length: 255
definition · variant 1.tag · variant 2nullopsional——
definition · variant 1.client_reference_idanyOf<string | null>opsional——
definition · variant 1.client_reference_id · variant 1stringopsional—
max length: 255
definition · variant 1.client_reference_id · variant 2nullopsional——
definition · variant 1.metadataobjectopsional——
definition · variant 1.prioritystringopsional—
enum: "low", "normal", "high"default: "normal"
definition · variant 1.retention_secondsanyOf<integer | null>opsional——
definition · variant 1.retention_seconds · variant 1integeropsional—
min: 0max: 86400
definition · variant 1.retention_seconds · variant 2nullopsional——
definition · variant 2nullopsional——
variables_schemaanyOf<object | null>opsional——
variables_schema · variant 1objectopsional——
variables_schema · variant 2nullopsional——
metadataanyOf<object | null>opsional——
metadata · variant 1objectopsional——
metadata · variant 2nullopsional——

Respons

200Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
namestringwajib——
descriptionanyOf<string | null>opsional——
description · variant 1stringopsional——
description · variant 2nullopsional——
current_versionintegerwajib——
definitionobjectwajib——
variables_schemaobjectwajib——
metadataobjectwajib——
created_atstringwajib—
format: date-time
updated_atstringwajib—
format: date-time
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
POST/v1/workflows/{workflow_id}/runRun WorkflowWorkflows#

Run Workflow. Workflows are reusable project-owned job definitions. Running a workflow creates durable work and validates variables before execution. Required scopes: converterhq.jobs.write, converterhq.workflows.read.

Autentikasi
ConverterHQBearerhttp / bearer

Parameter

NamaLokasiJenisWajibDeskripsi / batasan
workflow_idpathstringwajib—
Idempotency-KeyheaderanyOf<string | null>opsional—

Isi permintaan wajib

application/json
KolomJenisWajibDeskripsiBatasan
variablesobjectopsional——
client_reference_idanyOf<string | null>opsional——
client_reference_id · variant 1stringopsional—
max length: 255
client_reference_id · variant 2nullopsional——
metadataobjectopsional——

Respons

201Successful Response
application/json
KolomJenisWajibDeskripsiBatasan
idstringwajib——
kindstringwajib——
statusstringwajib——
progressintegerwajib——
taganyOf<string | null>opsional——
tag · variant 1stringopsional——
tag · variant 2nullopsional——
client_reference_idanyOf<string | null>opsional——
client_reference_id · variant 1stringopsional——
client_reference_id · variant 2nullopsional——
metadataobjectopsional——
prioritystringwajib——
concurrency_limitintegeropsional—
default: 1
originstringwajib——
created_atstringwajib—
format: date-time
started_atanyOf<string | null>opsional——
started_at · variant 1stringopsional—
format: date-time
started_at · variant 2nullopsional——
completed_atanyOf<string | null>opsional——
completed_at · variant 1stringopsional—
format: date-time
completed_at · variant 2nullopsional——
error_codeanyOf<string | null>opsional——
error_code · variant 1stringopsional——
error_code · variant 2nullopsional——
error_messageanyOf<string | null>opsional——
error_message · variant 1stringopsional——
error_message · variant 2nullopsional——
tasksobject[]opsional——
tasks[]objectopsional——
tasks[].idstringwajib——
tasks[].job_idstringwajib——
tasks[].namestringwajib——
tasks[].operationstringwajib——
tasks[].statusstringwajib——
tasks[].progressintegerwajib——
tasks[].inputobjectwajib——
tasks[].optionsobjectwajib——
tasks[].resultobjectwajib——
tasks[].requiredbooleanwajib——
tasks[].runtime_classstringwajib——
tasks[].prioritystringwajib——
tasks[].attempt_countintegerwajib——
tasks[].max_attemptsintegerwajib——
tasks[].error_codeanyOf<string | null>opsional——
tasks[].error_code · variant 1stringopsional——
tasks[].error_code · variant 2nullopsional——
tasks[].error_messageanyOf<string | null>opsional——
tasks[].error_message · variant 1stringopsional——
tasks[].error_message · variant 2nullopsional——
tasks[].created_atstringwajib—
format: date-time
tasks[].queued_atanyOf<string | null>opsional——
tasks[].queued_at · variant 1stringopsional—
format: date-time
tasks[].queued_at · variant 2nullopsional——
tasks[].started_atanyOf<string | null>opsional——
tasks[].started_at · variant 1stringopsional—
format: date-time
tasks[].started_at · variant 2nullopsional——
tasks[].completed_atanyOf<string | null>opsional——
tasks[].completed_at · variant 1stringopsional—
format: date-time
tasks[].completed_at · variant 2nullopsional——
tasks[].attemptsobject[]opsional——
tasks[].attempts[]objectopsional——
tasks[].attempts[].idstringwajib——
tasks[].attempts[].attempt_numberintegerwajib——
tasks[].attempts[].statusstringwajib——
tasks[].attempts[].worker_idanyOf<string | null>opsional——
tasks[].attempts[].worker_id · variant 1stringopsional——
tasks[].attempts[].worker_id · variant 2nullopsional——
tasks[].attempts[].runtime_classanyOf<string | null>opsional——
tasks[].attempts[].runtime_class · variant 1stringopsional——
tasks[].attempts[].runtime_class · variant 2nullopsional——
tasks[].attempts[].regionanyOf<string | null>opsional——
tasks[].attempts[].region · variant 1stringopsional——
tasks[].attempts[].region · variant 2nullopsional——
tasks[].attempts[].engineanyOf<string | null>opsional——
tasks[].attempts[].engine · variant 1stringopsional——
tasks[].attempts[].engine · variant 2nullopsional——
tasks[].attempts[].engine_versionanyOf<string | null>opsional——
tasks[].attempts[].engine_version · variant 1stringopsional——
tasks[].attempts[].engine_version · variant 2nullopsional——
tasks[].attempts[].input_bytesanyOf<integer | null>opsional——
tasks[].attempts[].input_bytes · variant 1integeropsional——
tasks[].attempts[].input_bytes · variant 2nullopsional——
tasks[].attempts[].output_bytesanyOf<integer | null>opsional——
tasks[].attempts[].output_bytes · variant 1integeropsional——
tasks[].attempts[].output_bytes · variant 2nullopsional——
tasks[].attempts[].wall_msanyOf<integer | null>opsional——
tasks[].attempts[].wall_ms · variant 1integeropsional——
tasks[].attempts[].wall_ms · variant 2nullopsional——
tasks[].attempts[].cpu_msanyOf<integer | null>opsional——
tasks[].attempts[].cpu_ms · variant 1integeropsional——
tasks[].attempts[].cpu_ms · variant 2nullopsional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opsional——
tasks[].attempts[].peak_memory_mb · variant 1integeropsional——
tasks[].attempts[].peak_memory_mb · variant 2nullopsional——
tasks[].attempts[].temp_bytesanyOf<integer | null>opsional——
tasks[].attempts[].temp_bytes · variant 1integeropsional——
tasks[].attempts[].temp_bytes · variant 2nullopsional——
tasks[].attempts[].error_codeanyOf<string | null>opsional——
tasks[].attempts[].error_code · variant 1stringopsional——
tasks[].attempts[].error_code · variant 2nullopsional——
tasks[].attempts[].error_messageanyOf<string | null>opsional——
tasks[].attempts[].error_message · variant 1stringopsional——
tasks[].attempts[].error_message · variant 2nullopsional——
tasks[].attempts[].estimated_creditsanyOf<string | null>opsional——
tasks[].attempts[].estimated_credits · variant 1stringopsional——
tasks[].attempts[].estimated_credits · variant 2nullopsional——
tasks[].attempts[].settled_creditsanyOf<string | null>opsional——
tasks[].attempts[].settled_credits · variant 1stringopsional——
tasks[].attempts[].settled_credits · variant 2nullopsional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opsional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopsional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opsional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopsional——
tasks[].attempts[].started_atstringwajib—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opsional——
tasks[].attempts[].completed_at · variant 1stringopsional—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopsional——
400The request could not be processed.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
401Authentication is missing or invalid.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
403The principal is not allowed to perform this operation.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
422Validation Error
application/json
KolomJenisWajibDeskripsiBatasan
detailobject[]opsional——
detail[]objectopsional——
detail[].locanyOf<string | integer>[]wajib——
detail[].loc[]anyOf<string | integer>opsional——
detail[].loc[] · variant 1stringopsional——
detail[].loc[] · variant 2integeropsional——
detail[].msgstringwajib——
detail[].typestringwajib——
429The caller has exceeded an admission-control limit.
Header responsRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
500An unexpected server error occurred.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——
503A required service is temporarily unavailable.
application/problem+json
KolomJenisWajibDeskripsiBatasan
typestringwajib—
default: "about:blank"
titlestringwajib——
statusintegerwajib—
min: 400max: 599
codestringwajib——
detailstringwajib——
retryablebooleanwajib——
parameteranyOf<string | null>opsional——
parameter · variant 1stringopsional——
parameter · variant 2nullopsional——
request_idanyOf<string | null>opsional——
request_id · variant 1stringopsional——
request_id · variant 2nullopsional——