ConverterHQDevelopers
Gerado a partir do contrato OpenAPI público selecionado

Referência da API REST

Inspecione parâmetros, autenticação, campos aninhados, esquemas de resposta, erros e exemplos executáveis. As rotas de utilizadores finais, SEO e administração estão excluídas.

74 endpoints apresentados74 operações no total17 etiquetas3.1.0 esquema
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.

AutenticaçãoPúblico / sem autenticação específica da operação

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
input_formatqueryanyOf<string | null>opcional—
output_formatqueryanyOf<string | null>opcional—
includequeryanyOf<string | null>opcional
Comma-separated expansions. Use `options` or `options.details` for pair-specific option metadata.
—
limitqueryintegeropcional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcional—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
dataobject[]obrigatório——
data[]objectopcional——
data[].supportedbooleanobrigatório——
data[].input_formatstringobrigatório——
data[].output_formatstringobrigatório——
data[].maturitystringopcional—
enum: "stable", "disabled"default: "stable"
data[].settings_scopestringopcionalSettings 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[].routeobjectopcional——
data[].route.multi_stepbooleanopcionalTrue 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[]opcionalSetting 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>opcionalStable 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 1stringopcional——
data[].options_version · variant 2nullopcional——
data[].optionsobject[]opcionalSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
data[].options[]objectopcional——
data[].options[].namestringobrigatório——
data[].options[].typestringobrigatório——
data[].options[].labelstringobrigatório——
data[].options[].descriptionanyOf<string | null>opcional——
data[].options[].description · variant 1stringopcional——
data[].options[].description · variant 2nullopcional——
data[].options[].requiredbooleanopcional—
default: false
data[].options[].advancedbooleanopcional—
default: false
data[].options[].groupanyOf<string | null>opcional——
data[].options[].group · variant 1stringopcional——
data[].options[].group · variant 2nullopcional——
data[].options[].defaultunknownopcional——
data[].options[].possible_valuesanyOf<unknown[] | null>opcional——
data[].options[].possible_values · variant 1unknown[]opcional——
data[].options[].possible_values · variant 2nullopcional——
data[].options[].minimumanyOf<integer | number | null>opcional——
data[].options[].minimum · variant 1integeropcional——
data[].options[].minimum · variant 2numberopcional——
data[].options[].minimum · variant 3nullopcional——
data[].options[].maximumanyOf<integer | number | null>opcional——
data[].options[].maximum · variant 1integeropcional——
data[].options[].maximum · variant 2numberopcional——
data[].options[].maximum · variant 3nullopcional——
data[].options[].depends_onobject[]opcional——
data[].options[].conflicts_withstring[]opcional——
data[].options[].schemaanyOf<object | null>opcional——
data[].options[].schema · variant 1objectopcional——
data[].options[].schema · variant 2nullopcional——
data[].options_schemaobjectopcionalStrict JSON Schema for the settings accepted by this pair-level conversion task.—
data[].limitsobjectopcional——
data[].billingobjectopcional——
paginationobjectobrigatório——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

AutenticaçãoPúblico / sem autenticação específica da operação

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
from_formatpathstringobrigatório—
to_formatpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
supportedbooleanobrigatório——
input_formatstringobrigatório——
output_formatstringobrigatório——
maturitystringopcional—
enum: "stable", "disabled"default: "stable"
settings_scopestringopcionalSettings 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"
routeobjectopcional——
route.multi_stepbooleanopcionalTrue 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[]opcionalSetting 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>opcionalStable 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 1stringopcional——
options_version · variant 2nullopcional——
optionsobject[]opcionalSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
options[]objectopcional——
options[].namestringobrigatório——
options[].typestringobrigatório——
options[].labelstringobrigatório——
options[].descriptionanyOf<string | null>opcional——
options[].description · variant 1stringopcional——
options[].description · variant 2nullopcional——
options[].requiredbooleanopcional—
default: false
options[].advancedbooleanopcional—
default: false
options[].groupanyOf<string | null>opcional——
options[].group · variant 1stringopcional——
options[].group · variant 2nullopcional——
options[].defaultunknownopcional——
options[].possible_valuesanyOf<unknown[] | null>opcional——
options[].possible_values · variant 1unknown[]opcional——
options[].possible_values · variant 2nullopcional——
options[].minimumanyOf<integer | number | null>opcional——
options[].minimum · variant 1integeropcional——
options[].minimum · variant 2numberopcional——
options[].minimum · variant 3nullopcional——
options[].maximumanyOf<integer | number | null>opcional——
options[].maximum · variant 1integeropcional——
options[].maximum · variant 2numberopcional——
options[].maximum · variant 3nullopcional——
options[].depends_onobject[]opcional——
options[].conflicts_withstring[]opcional——
options[].schemaanyOf<object | null>opcional——
options[].schema · variant 1objectopcional——
options[].schema · variant 2nullopcional——
options_schemaobjectopcionalStrict JSON Schema for the settings accepted by this pair-level conversion task.—
limitsobjectopcional——
billingobjectopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
account_idstringobrigatório——
productstringobrigatório——
api_enabledbooleanobrigatório——
plansstring[]obrigatório——
effective_planobjectobrigatório——
effective_plan.codestringobrigatório——
effective_plan.namestringobrigatório——
effective_plan.familyanyOf<string | null>opcional——
effective_plan.family · variant 1stringopcional——
effective_plan.family · variant 2nullopcional——
effective_plan.billing_intervalanyOf<string | null>opcional——
effective_plan.billing_interval · variant 1stringopcional——
effective_plan.billing_interval · variant 2nullopcional——
creditsobjectobrigatório——
credits.availablestringobrigatório——
credits.reservedstringobrigatório——
credits.debtstringobrigatório——
quotaanyOf<object | null>opcional——
quota · variant 1objectopcional——
quota · variant 1.keystringobrigatório——
quota · variant 1.periodstringobrigatório——
quota · variant 1.period_keystringobrigatório——
quota · variant 1.limitstringobrigatório——
quota · variant 1.usedstringobrigatório——
quota · variant 1.remainingstringobrigatório——
quota · variant 1.period_startstringobrigatório—
format: date-time
quota · variant 1.period_endstringobrigatório—
format: date-time
quota · variant 2nullopcional——
subscriptionsobject[]obrigatório——
subscriptions[]objectopcional——
subscriptions[].idstringobrigatório——
subscriptions[].planstringobrigatório——
subscriptions[].statusstringobrigatório——
subscriptions[].billing_intervalanyOf<string | null>opcional——
subscriptions[].billing_interval · variant 1stringopcional——
subscriptions[].billing_interval · variant 2nullopcional——
subscriptions[].current_period_startanyOf<string | null>opcional——
subscriptions[].current_period_start · variant 1stringopcional—
format: date-time
subscriptions[].current_period_start · variant 2nullopcional——
subscriptions[].current_period_endanyOf<string | null>opcional——
subscriptions[].current_period_end · variant 1stringopcional—
format: date-time
subscriptions[].current_period_end · variant 2nullopcional——
subscriptions[].next_billed_atanyOf<string | null>opcional——
subscriptions[].next_billed_at · variant 1stringopcional—
format: date-time
subscriptions[].next_billed_at · variant 2nullopcional——
passesobject[]obrigatório——
passes[]objectopcional——
passes[].idstringobrigatório——
passes[].offerstringobrigatório——
passes[].planstringobrigatório——
passes[].starts_atstringobrigatório—
format: date-time
passes[].expires_atstringobrigatório—
format: date-time
generated_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
limitqueryintegeropcional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcional—
providerqueryanyOf<string | null>opcional—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
dataobject[]obrigatório——
data[]objectopcional——
data[].idstringobrigatório——
data[].namestringobrigatório——
data[].providerstringobrigatório—
enum: "s3", "gcs", "azure", "sftp"
data[].config_summaryobjectobrigatório——
data[].enabledbooleanobrigatório——
data[].created_atstringobrigatório—
format: date-time
data[].updated_atstringobrigatório—
format: date-time
paginationobjectobrigatório——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
namestringobrigatório—
min length: 1max length: 255
providerstringobrigatório—
enum: "s3", "gcs", "azure", "sftp"
configobjectobrigatório——

Respostas

201Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
namestringobrigatório——
providerstringobrigatório—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectobrigatório——
enabledbooleanobrigatório——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
connection_idpathstringobrigatório—

Respostas

204Successful Response

Sem corpo de resposta.

400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
connection_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
namestringobrigatório——
providerstringobrigatório—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectobrigatório——
enabledbooleanobrigatório——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
connection_idpathstringobrigatório—

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
nameanyOf<string | null>opcional——
name · variant 1stringopcional—
min length: 1max length: 255
name · variant 2nullopcional——
configanyOf<object | null>opcional——
config · variant 1objectopcional——
config · variant 2nullopcional——
enabledanyOf<boolean | null>opcional——
enabled · variant 1booleanopcional——
enabled · variant 2nullopcional——

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
namestringobrigatório——
providerstringobrigatório—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectobrigatório——
enabledbooleanobrigatório——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
connection_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
okbooleanobrigatório——
providerstringobrigatório——
detailsobjectopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
PreferheaderanyOf<string | null>opcional—
Idempotency-KeyheaderanyOf<string | null>opcional—

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
inputobjectobrigatório——
input.file_idanyOf<string | null>opcional—
default: null
input.file_id · variant 1stringopcional——
input.file_id · variant 2nullopcional——
input.urlanyOf<string | null>opcional—
default: null
input.url · variant 1stringopcional——
input.url · variant 2nullopcional——
input_formatanyOf<string | null>opcional—
default: null
input_format · variant 1stringopcional——
input_format · variant 2nullopcional——
output_formatstringobrigatório—
min length: 1max length: 64
optionsobjectopcional——
filenameanyOf<string | null>opcional—
default: null
filename · variant 1stringopcional—
max length: 512
filename · variant 2nullopcional——
metadataobjectopcional——
client_reference_idanyOf<string | null>opcional—
default: null
client_reference_id · variant 1stringopcional—
max length: 255
client_reference_id · variant 2nullopcional——
retention_secondsanyOf<integer | null>opcional—
default: null
retention_seconds · variant 1integeropcional—
min: 0max: 86400
retention_seconds · variant 2nullopcional——
multipart/form-data
CampoTipoObrigatórioDescriçãoRestrições
filestringobrigatórioInput file, up to 4 MiB.
format: binary
input_formatstringopcionalOptional source format when it cannot be detected.—
output_formatstringobrigatórioRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringopcionalJSON object containing pair-specific conversion options.—
metadatastringopcionalJSON object copied to the created Job.—
filenamestringopcionalOptional output filename hint.—
client_reference_idstringopcionalOptional caller-defined reference.—
retention_secondsintegeropcional—
min: 0max: 86400

Respostas

200Conversion completed within the requested wait window.
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
job_idstringobrigatório——
statusstringobrigatório——
progressintegerobrigatório——
input_formatanyOf<string | null>opcional——
input_format · variant 1stringopcional——
input_format · variant 2nullopcional——
output_formatstringobrigatório——
output_fileanyOf<object | null>opcional——
output_file · variant 1objectopcional——
output_file · variant 1.idstringobrigatório——
output_file · variant 1.statusstringobrigatório——
output_file · variant 1.rolestringobrigatório——
output_file · variant 1.filenamestringobrigatório——
output_file · variant 1.content_typeanyOf<string | null>opcional——
output_file · variant 1.content_type · variant 1stringopcional——
output_file · variant 1.content_type · variant 2nullopcional——
output_file · variant 1.detected_content_typeanyOf<string | null>opcional——
output_file · variant 1.detected_content_type · variant 1stringopcional——
output_file · variant 1.detected_content_type · variant 2nullopcional——
output_file · variant 1.detected_formatanyOf<string | null>opcional——
output_file · variant 1.detected_format · variant 1stringopcional——
output_file · variant 1.detected_format · variant 2nullopcional——
output_file · variant 1.size_bytesanyOf<integer | null>opcional——
output_file · variant 1.size_bytes · variant 1integeropcional——
output_file · variant 1.size_bytes · variant 2nullopcional——
output_file · variant 1.checksum_sha256anyOf<string | null>opcional——
output_file · variant 1.checksum_sha256 · variant 1stringopcional——
output_file · variant 1.checksum_sha256 · variant 2nullopcional——
output_file · variant 1.source_typestringobrigatório——
output_file · variant 1.created_atstringobrigatório—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>opcional——
output_file · variant 1.ready_at · variant 1stringopcional—
format: date-time
output_file · variant 1.ready_at · variant 2nullopcional——
output_file · variant 1.expires_atanyOf<string | null>opcional——
output_file · variant 1.expires_at · variant 1stringopcional—
format: date-time
output_file · variant 1.expires_at · variant 2nullopcional——
output_file · variant 1.metadataobjectopcional——
output_file · variant 1.uploadanyOf<object | null>opcional——
output_file · variant 1.upload · variant 1objectopcional——
output_file · variant 1.upload · variant 1.methodstringopcional—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringobrigatório——
output_file · variant 1.upload · variant 1.expires_atstringobrigatório—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectopcional——
output_file · variant 1.upload · variant 2nullopcional——
output_file · variant 1.download_urlanyOf<string | null>opcional——
output_file · variant 1.download_url · variant 1stringopcional——
output_file · variant 1.download_url · variant 2nullopcional——
output_file · variant 1.download_expires_atanyOf<string | null>opcional——
output_file · variant 1.download_expires_at · variant 1stringopcional—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullopcional——
output_file · variant 2nullopcional——
created_atstringobrigatório—
format: date-time
202Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
job_idstringobrigatório——
statusstringobrigatório——
progressintegerobrigatório——
input_formatanyOf<string | null>opcional——
input_format · variant 1stringopcional——
input_format · variant 2nullopcional——
output_formatstringobrigatório——
output_fileanyOf<object | null>opcional——
output_file · variant 1objectopcional——
output_file · variant 1.idstringobrigatório——
output_file · variant 1.statusstringobrigatório——
output_file · variant 1.rolestringobrigatório——
output_file · variant 1.filenamestringobrigatório——
output_file · variant 1.content_typeanyOf<string | null>opcional——
output_file · variant 1.content_type · variant 1stringopcional——
output_file · variant 1.content_type · variant 2nullopcional——
output_file · variant 1.detected_content_typeanyOf<string | null>opcional——
output_file · variant 1.detected_content_type · variant 1stringopcional——
output_file · variant 1.detected_content_type · variant 2nullopcional——
output_file · variant 1.detected_formatanyOf<string | null>opcional——
output_file · variant 1.detected_format · variant 1stringopcional——
output_file · variant 1.detected_format · variant 2nullopcional——
output_file · variant 1.size_bytesanyOf<integer | null>opcional——
output_file · variant 1.size_bytes · variant 1integeropcional——
output_file · variant 1.size_bytes · variant 2nullopcional——
output_file · variant 1.checksum_sha256anyOf<string | null>opcional——
output_file · variant 1.checksum_sha256 · variant 1stringopcional——
output_file · variant 1.checksum_sha256 · variant 2nullopcional——
output_file · variant 1.source_typestringobrigatório——
output_file · variant 1.created_atstringobrigatório—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>opcional——
output_file · variant 1.ready_at · variant 1stringopcional—
format: date-time
output_file · variant 1.ready_at · variant 2nullopcional——
output_file · variant 1.expires_atanyOf<string | null>opcional——
output_file · variant 1.expires_at · variant 1stringopcional—
format: date-time
output_file · variant 1.expires_at · variant 2nullopcional——
output_file · variant 1.metadataobjectopcional——
output_file · variant 1.uploadanyOf<object | null>opcional——
output_file · variant 1.upload · variant 1objectopcional——
output_file · variant 1.upload · variant 1.methodstringopcional—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringobrigatório——
output_file · variant 1.upload · variant 1.expires_atstringobrigatório—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectopcional——
output_file · variant 1.upload · variant 2nullopcional——
output_file · variant 1.download_urlanyOf<string | null>opcional——
output_file · variant 1.download_url · variant 1stringopcional——
output_file · variant 1.download_url · variant 2nullopcional——
output_file · variant 1.download_expires_atanyOf<string | null>opcional——
output_file · variant 1.download_expires_at · variant 1stringopcional—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullopcional——
output_file · variant 2nullopcional——
created_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
from_formatpathstringobrigatório—
to_formatpathstringobrigatório—
PreferheaderanyOf<string | null>opcional—
Idempotency-KeyheaderanyOf<string | null>opcional—

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
inputobjectobrigatório——
input.file_idanyOf<string | null>opcional—
default: null
input.file_id · variant 1stringopcional——
input.file_id · variant 2nullopcional——
input.urlanyOf<string | null>opcional—
default: null
input.url · variant 1stringopcional——
input.url · variant 2nullopcional——
input_formatanyOf<string | null>opcional—
default: null
input_format · variant 1stringopcional——
input_format · variant 2nullopcional——
output_formatstringobrigatório—
min length: 1max length: 64
optionsobjectopcional——
filenameanyOf<string | null>opcional—
default: null
filename · variant 1stringopcional—
max length: 512
filename · variant 2nullopcional——
metadataobjectopcional——
client_reference_idanyOf<string | null>opcional—
default: null
client_reference_id · variant 1stringopcional—
max length: 255
client_reference_id · variant 2nullopcional——
retention_secondsanyOf<integer | null>opcional—
default: null
retention_seconds · variant 1integeropcional—
min: 0max: 86400
retention_seconds · variant 2nullopcional——
multipart/form-data
CampoTipoObrigatórioDescriçãoRestrições
filestringobrigatórioInput file, up to 4 MiB.
format: binary
input_formatstringopcionalOptional source format when it cannot be detected.—
output_formatstringopcionalRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringopcionalJSON object containing pair-specific conversion options.—
metadatastringopcionalJSON object copied to the created Job.—
filenamestringopcionalOptional output filename hint.—
client_reference_idstringopcionalOptional caller-defined reference.—
retention_secondsintegeropcional—
min: 0max: 86400

Respostas

200Conversion completed within the requested wait window.
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
job_idstringobrigatório——
statusstringobrigatório——
progressintegerobrigatório——
input_formatanyOf<string | null>opcional——
input_format · variant 1stringopcional——
input_format · variant 2nullopcional——
output_formatstringobrigatório——
output_fileanyOf<object | null>opcional——
output_file · variant 1objectopcional——
output_file · variant 1.idstringobrigatório——
output_file · variant 1.statusstringobrigatório——
output_file · variant 1.rolestringobrigatório——
output_file · variant 1.filenamestringobrigatório——
output_file · variant 1.content_typeanyOf<string | null>opcional——
output_file · variant 1.content_type · variant 1stringopcional——
output_file · variant 1.content_type · variant 2nullopcional——
output_file · variant 1.detected_content_typeanyOf<string | null>opcional——
output_file · variant 1.detected_content_type · variant 1stringopcional——
output_file · variant 1.detected_content_type · variant 2nullopcional——
output_file · variant 1.detected_formatanyOf<string | null>opcional——
output_file · variant 1.detected_format · variant 1stringopcional——
output_file · variant 1.detected_format · variant 2nullopcional——
output_file · variant 1.size_bytesanyOf<integer | null>opcional——
output_file · variant 1.size_bytes · variant 1integeropcional——
output_file · variant 1.size_bytes · variant 2nullopcional——
output_file · variant 1.checksum_sha256anyOf<string | null>opcional——
output_file · variant 1.checksum_sha256 · variant 1stringopcional——
output_file · variant 1.checksum_sha256 · variant 2nullopcional——
output_file · variant 1.source_typestringobrigatório——
output_file · variant 1.created_atstringobrigatório—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>opcional——
output_file · variant 1.ready_at · variant 1stringopcional—
format: date-time
output_file · variant 1.ready_at · variant 2nullopcional——
output_file · variant 1.expires_atanyOf<string | null>opcional——
output_file · variant 1.expires_at · variant 1stringopcional—
format: date-time
output_file · variant 1.expires_at · variant 2nullopcional——
output_file · variant 1.metadataobjectopcional——
output_file · variant 1.uploadanyOf<object | null>opcional——
output_file · variant 1.upload · variant 1objectopcional——
output_file · variant 1.upload · variant 1.methodstringopcional—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringobrigatório——
output_file · variant 1.upload · variant 1.expires_atstringobrigatório—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectopcional——
output_file · variant 1.upload · variant 2nullopcional——
output_file · variant 1.download_urlanyOf<string | null>opcional——
output_file · variant 1.download_url · variant 1stringopcional——
output_file · variant 1.download_url · variant 2nullopcional——
output_file · variant 1.download_expires_atanyOf<string | null>opcional——
output_file · variant 1.download_expires_at · variant 1stringopcional—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullopcional——
output_file · variant 2nullopcional——
created_atstringobrigatório—
format: date-time
202Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
job_idstringobrigatório——
statusstringobrigatório——
progressintegerobrigatório——
input_formatanyOf<string | null>opcional——
input_format · variant 1stringopcional——
input_format · variant 2nullopcional——
output_formatstringobrigatório——
output_fileanyOf<object | null>opcional——
output_file · variant 1objectopcional——
output_file · variant 1.idstringobrigatório——
output_file · variant 1.statusstringobrigatório——
output_file · variant 1.rolestringobrigatório——
output_file · variant 1.filenamestringobrigatório——
output_file · variant 1.content_typeanyOf<string | null>opcional——
output_file · variant 1.content_type · variant 1stringopcional——
output_file · variant 1.content_type · variant 2nullopcional——
output_file · variant 1.detected_content_typeanyOf<string | null>opcional——
output_file · variant 1.detected_content_type · variant 1stringopcional——
output_file · variant 1.detected_content_type · variant 2nullopcional——
output_file · variant 1.detected_formatanyOf<string | null>opcional——
output_file · variant 1.detected_format · variant 1stringopcional——
output_file · variant 1.detected_format · variant 2nullopcional——
output_file · variant 1.size_bytesanyOf<integer | null>opcional——
output_file · variant 1.size_bytes · variant 1integeropcional——
output_file · variant 1.size_bytes · variant 2nullopcional——
output_file · variant 1.checksum_sha256anyOf<string | null>opcional——
output_file · variant 1.checksum_sha256 · variant 1stringopcional——
output_file · variant 1.checksum_sha256 · variant 2nullopcional——
output_file · variant 1.source_typestringobrigatório——
output_file · variant 1.created_atstringobrigatório—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>opcional——
output_file · variant 1.ready_at · variant 1stringopcional—
format: date-time
output_file · variant 1.ready_at · variant 2nullopcional——
output_file · variant 1.expires_atanyOf<string | null>opcional——
output_file · variant 1.expires_at · variant 1stringopcional—
format: date-time
output_file · variant 1.expires_at · variant 2nullopcional——
output_file · variant 1.metadataobjectopcional——
output_file · variant 1.uploadanyOf<object | null>opcional——
output_file · variant 1.upload · variant 1objectopcional——
output_file · variant 1.upload · variant 1.methodstringopcional—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringobrigatório——
output_file · variant 1.upload · variant 1.expires_atstringobrigatório—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectopcional——
output_file · variant 1.upload · variant 2nullopcional——
output_file · variant 1.download_urlanyOf<string | null>opcional——
output_file · variant 1.download_url · variant 1stringopcional——
output_file · variant 1.download_url · variant 2nullopcional——
output_file · variant 1.download_expires_atanyOf<string | null>opcional——
output_file · variant 1.download_expires_at · variant 1stringopcional—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullopcional——
output_file · variant 2nullopcional——
created_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
input_formatstringobrigatório——
output_formatstringobrigatório——
size_bytesanyOf<integer | null>opcional——
size_bytes · variant 1integeropcional—
min: 0
size_bytes · variant 2nullopcional——
page_countanyOf<integer | null>opcional——
page_count · variant 1integeropcional—
min: 0
page_count · variant 2nullopcional——
duration_secondsanyOf<number | null>opcional——
duration_seconds · variant 1numberopcional—
min: 0
duration_seconds · variant 2nullopcional——
optionsobjectopcional——

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
supportedbooleanobrigatório——
recommended_modestringobrigatório—
enum: "sync", "async"
creditsobjectobrigatório——
warningsstring[]opcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
GET/v1/event-typesEvent TypesDiscovery#

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

AutenticaçãoPúblico / sem autenticação específica da operação

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
dataobject[]obrigatório——
data[]objectopcional——
data[].typestringobrigatório——
data[].descriptionstringobrigatório——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
limitqueryintegeropcional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcional—
statusqueryanyOf<string | null>opcional—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
dataobject[]obrigatório——
data[]objectopcional——
data[].idstringobrigatório——
data[].statusstringobrigatório——
data[].rolestringobrigatório——
data[].filenamestringobrigatório——
data[].content_typeanyOf<string | null>opcional——
data[].content_type · variant 1stringopcional——
data[].content_type · variant 2nullopcional——
data[].detected_content_typeanyOf<string | null>opcional——
data[].detected_content_type · variant 1stringopcional——
data[].detected_content_type · variant 2nullopcional——
data[].detected_formatanyOf<string | null>opcional——
data[].detected_format · variant 1stringopcional——
data[].detected_format · variant 2nullopcional——
data[].size_bytesanyOf<integer | null>opcional——
data[].size_bytes · variant 1integeropcional——
data[].size_bytes · variant 2nullopcional——
data[].checksum_sha256anyOf<string | null>opcional——
data[].checksum_sha256 · variant 1stringopcional——
data[].checksum_sha256 · variant 2nullopcional——
data[].source_typestringobrigatório——
data[].created_atstringobrigatório—
format: date-time
data[].ready_atanyOf<string | null>opcional——
data[].ready_at · variant 1stringopcional—
format: date-time
data[].ready_at · variant 2nullopcional——
data[].expires_atanyOf<string | null>opcional——
data[].expires_at · variant 1stringopcional—
format: date-time
data[].expires_at · variant 2nullopcional——
data[].metadataobjectopcional——
data[].uploadanyOf<object | null>opcional——
data[].upload · variant 1objectopcional——
data[].upload · variant 1.methodstringopcional—
default: "PUT"
data[].upload · variant 1.urlstringobrigatório——
data[].upload · variant 1.expires_atstringobrigatório—
format: date-time
data[].upload · variant 1.headersobjectopcional——
data[].upload · variant 2nullopcional——
data[].download_urlanyOf<string | null>opcional——
data[].download_url · variant 1stringopcional——
data[].download_url · variant 2nullopcional——
data[].download_expires_atanyOf<string | null>opcional——
data[].download_expires_at · variant 1stringopcional—
format: date-time
data[].download_expires_at · variant 2nullopcional——
paginationobjectobrigatório——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
filenamestringobrigatório—
min length: 1max length: 512
size_bytesanyOf<integer | null>opcional——
size_bytes · variant 1integeropcional—
min: 0
size_bytes · variant 2nullopcional——
content_typeanyOf<string | null>opcional——
content_type · variant 1stringopcional—
max length: 255
content_type · variant 2nullopcional——
checksum_sha256anyOf<string | null>opcional——
checksum_sha256 · variant 1stringopcional—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullopcional——
retention_secondsanyOf<integer | null>opcional——
retention_seconds · variant 1integeropcional—
min: 0max: 86400
retention_seconds · variant 2nullopcional——
metadataobjectopcional——

Respostas

201Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
statusstringobrigatório——
rolestringobrigatório——
filenamestringobrigatório——
content_typeanyOf<string | null>opcional——
content_type · variant 1stringopcional——
content_type · variant 2nullopcional——
detected_content_typeanyOf<string | null>opcional——
detected_content_type · variant 1stringopcional——
detected_content_type · variant 2nullopcional——
detected_formatanyOf<string | null>opcional——
detected_format · variant 1stringopcional——
detected_format · variant 2nullopcional——
size_bytesanyOf<integer | null>opcional——
size_bytes · variant 1integeropcional——
size_bytes · variant 2nullopcional——
checksum_sha256anyOf<string | null>opcional——
checksum_sha256 · variant 1stringopcional——
checksum_sha256 · variant 2nullopcional——
source_typestringobrigatório——
created_atstringobrigatório—
format: date-time
ready_atanyOf<string | null>opcional——
ready_at · variant 1stringopcional—
format: date-time
ready_at · variant 2nullopcional——
expires_atanyOf<string | null>opcional——
expires_at · variant 1stringopcional—
format: date-time
expires_at · variant 2nullopcional——
metadataobjectopcional——
uploadanyOf<object | null>opcional——
upload · variant 1objectopcional——
upload · variant 1.methodstringopcional—
default: "PUT"
upload · variant 1.urlstringobrigatório——
upload · variant 1.expires_atstringobrigatório—
format: date-time
upload · variant 1.headersobjectopcional——
upload · variant 2nullopcional——
download_urlanyOf<string | null>opcional——
download_url · variant 1stringopcional——
download_url · variant 2nullopcional——
download_expires_atanyOf<string | null>opcional——
download_expires_at · variant 1stringopcional—
format: date-time
download_expires_at · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
file_idpathstringobrigatório—

Respostas

204Successful Response

Sem corpo de resposta.

400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
file_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
statusstringobrigatório——
rolestringobrigatório——
filenamestringobrigatório——
content_typeanyOf<string | null>opcional——
content_type · variant 1stringopcional——
content_type · variant 2nullopcional——
detected_content_typeanyOf<string | null>opcional——
detected_content_type · variant 1stringopcional——
detected_content_type · variant 2nullopcional——
detected_formatanyOf<string | null>opcional——
detected_format · variant 1stringopcional——
detected_format · variant 2nullopcional——
size_bytesanyOf<integer | null>opcional——
size_bytes · variant 1integeropcional——
size_bytes · variant 2nullopcional——
checksum_sha256anyOf<string | null>opcional——
checksum_sha256 · variant 1stringopcional——
checksum_sha256 · variant 2nullopcional——
source_typestringobrigatório——
created_atstringobrigatório—
format: date-time
ready_atanyOf<string | null>opcional——
ready_at · variant 1stringopcional—
format: date-time
ready_at · variant 2nullopcional——
expires_atanyOf<string | null>opcional——
expires_at · variant 1stringopcional—
format: date-time
expires_at · variant 2nullopcional——
metadataobjectopcional——
uploadanyOf<object | null>opcional——
upload · variant 1objectopcional——
upload · variant 1.methodstringopcional—
default: "PUT"
upload · variant 1.urlstringobrigatório——
upload · variant 1.expires_atstringobrigatório—
format: date-time
upload · variant 1.headersobjectopcional——
upload · variant 2nullopcional——
download_urlanyOf<string | null>opcional——
download_url · variant 1stringopcional——
download_url · variant 2nullopcional——
download_expires_atanyOf<string | null>opcional——
download_expires_at · variant 1stringopcional—
format: date-time
download_expires_at · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
file_idpathstringobrigatório—

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
checksum_sha256anyOf<string | null>opcional——
checksum_sha256 · variant 1stringopcional—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullopcional——

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
statusstringobrigatório——
rolestringobrigatório——
filenamestringobrigatório——
content_typeanyOf<string | null>opcional——
content_type · variant 1stringopcional——
content_type · variant 2nullopcional——
detected_content_typeanyOf<string | null>opcional——
detected_content_type · variant 1stringopcional——
detected_content_type · variant 2nullopcional——
detected_formatanyOf<string | null>opcional——
detected_format · variant 1stringopcional——
detected_format · variant 2nullopcional——
size_bytesanyOf<integer | null>opcional——
size_bytes · variant 1integeropcional——
size_bytes · variant 2nullopcional——
checksum_sha256anyOf<string | null>opcional——
checksum_sha256 · variant 1stringopcional——
checksum_sha256 · variant 2nullopcional——
source_typestringobrigatório——
created_atstringobrigatório—
format: date-time
ready_atanyOf<string | null>opcional——
ready_at · variant 1stringopcional—
format: date-time
ready_at · variant 2nullopcional——
expires_atanyOf<string | null>opcional——
expires_at · variant 1stringopcional—
format: date-time
expires_at · variant 2nullopcional——
metadataobjectopcional——
uploadanyOf<object | null>opcional——
upload · variant 1objectopcional——
upload · variant 1.methodstringopcional—
default: "PUT"
upload · variant 1.urlstringobrigatório——
upload · variant 1.expires_atstringobrigatório—
format: date-time
upload · variant 1.headersobjectopcional——
upload · variant 2nullopcional——
download_urlanyOf<string | null>opcional——
download_url · variant 1stringopcional——
download_url · variant 2nullopcional——
download_expires_atanyOf<string | null>opcional——
download_expires_at · variant 1stringopcional—
format: date-time
download_expires_at · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
file_idpathstringobrigatório—

Respostas

204Successful Response

Sem corpo de resposta.

400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
file_idpathstringobrigatório—

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
part_sizeanyOf<integer | null>opcional——
part_size · variant 1integeropcional—
min: 5242880max: 5368709120
part_size · variant 2nullopcional——

Respostas

201Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
file_idstringobrigatório——
upload_idstringobrigatório——
part_sizeintegerobrigatório——
max_partsintegeropcional—
default: 10000
expires_atstringobrigatório—
format: date-time
partsobject[]opcional——
parts[]objectopcional——
parts[].part_numberintegerobrigatório——
parts[].urlstringobrigatório——
parts[].expires_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
file_idpathstringobrigatório—

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
partsobject[]obrigatório—
min items: 1max items: 10000
parts[]objectopcional——
parts[].part_numberintegerobrigatório—
min: 1max: 10000
parts[].etagstringobrigatório—
min length: 1max length: 512
checksum_sha256anyOf<string | null>opcional——
checksum_sha256 · variant 1stringopcional—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullopcional——

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
statusstringobrigatório——
rolestringobrigatório——
filenamestringobrigatório——
content_typeanyOf<string | null>opcional——
content_type · variant 1stringopcional——
content_type · variant 2nullopcional——
detected_content_typeanyOf<string | null>opcional——
detected_content_type · variant 1stringopcional——
detected_content_type · variant 2nullopcional——
detected_formatanyOf<string | null>opcional——
detected_format · variant 1stringopcional——
detected_format · variant 2nullopcional——
size_bytesanyOf<integer | null>opcional——
size_bytes · variant 1integeropcional——
size_bytes · variant 2nullopcional——
checksum_sha256anyOf<string | null>opcional——
checksum_sha256 · variant 1stringopcional——
checksum_sha256 · variant 2nullopcional——
source_typestringobrigatório——
created_atstringobrigatório—
format: date-time
ready_atanyOf<string | null>opcional——
ready_at · variant 1stringopcional—
format: date-time
ready_at · variant 2nullopcional——
expires_atanyOf<string | null>opcional——
expires_at · variant 1stringopcional—
format: date-time
expires_at · variant 2nullopcional——
metadataobjectopcional——
uploadanyOf<object | null>opcional——
upload · variant 1objectopcional——
upload · variant 1.methodstringopcional—
default: "PUT"
upload · variant 1.urlstringobrigatório——
upload · variant 1.expires_atstringobrigatório—
format: date-time
upload · variant 1.headersobjectopcional——
upload · variant 2nullopcional——
download_urlanyOf<string | null>opcional——
download_url · variant 1stringopcional——
download_url · variant 2nullopcional——
download_expires_atanyOf<string | null>opcional——
download_expires_at · variant 1stringopcional—
format: date-time
download_expires_at · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
file_idpathstringobrigatório—

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
part_numbersinteger[]obrigatório—
min items: 1max items: 1000

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
file_idstringobrigatório——
upload_idstringobrigatório——
part_sizeintegerobrigatório——
max_partsintegeropcional—
default: 10000
expires_atstringobrigatório—
format: date-time
partsobject[]opcional——
parts[]objectopcional——
parts[].part_numberintegerobrigatório——
parts[].urlstringobrigatório——
parts[].expires_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

AutenticaçãoPúblico / sem autenticação específica da operação

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
limitqueryintegeropcional
default: 500min: 1max: 500

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
dataobject[]obrigatório——
data[]objectopcional——
data[].slugstringobrigatório——
data[].labelstringobrigatório——
data[].categorystringobrigatório——
data[].mime_typesstring[]obrigatório——
data[].extensionsstring[]obrigatório——
paginationobjectobrigatório——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

AutenticaçãoPúblico / sem autenticação específica da operação

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
slugpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
slugstringobrigatório——
labelstringobrigatório——
categorystringobrigatório——
mime_typesstring[]obrigatório——
extensionsstring[]obrigatório——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

AutenticaçãoPúblico / sem autenticação específica da operação

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
slugpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
dataobject[]obrigatório——
data[]objectopcional——
data[].slugstringobrigatório——
data[].labelstringobrigatório——
data[].categorystringobrigatório——
data[].mime_typesstring[]obrigatório——
data[].extensionsstring[]obrigatório——
paginationobjectobrigatório——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

AutenticaçãoPúblico / sem autenticação específica da operação

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
slugpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
dataobject[]obrigatório——
data[]objectopcional——
data[].slugstringobrigatório——
data[].labelstringobrigatório——
data[].categorystringobrigatório——
data[].mime_typesstring[]obrigatório——
data[].extensionsstring[]obrigatório——
paginationobjectobrigatório——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
limitqueryintegeropcional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcional—
statusqueryanyOf<string | null>opcional—
tagqueryanyOf<string | null>opcional—
originqueryanyOf<string | null>opcional—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
dataobject[]obrigatório——
data[]objectopcional——
data[].idstringobrigatório——
data[].kindstringobrigatório——
data[].statusstringobrigatório——
data[].progressintegerobrigatório——
data[].taganyOf<string | null>opcional——
data[].tag · variant 1stringopcional——
data[].tag · variant 2nullopcional——
data[].client_reference_idanyOf<string | null>opcional——
data[].client_reference_id · variant 1stringopcional——
data[].client_reference_id · variant 2nullopcional——
data[].metadataobjectopcional——
data[].prioritystringobrigatório——
data[].concurrency_limitintegeropcional—
default: 1
data[].originstringobrigatório——
data[].created_atstringobrigatório—
format: date-time
data[].started_atanyOf<string | null>opcional——
data[].started_at · variant 1stringopcional—
format: date-time
data[].started_at · variant 2nullopcional——
data[].completed_atanyOf<string | null>opcional——
data[].completed_at · variant 1stringopcional—
format: date-time
data[].completed_at · variant 2nullopcional——
data[].error_codeanyOf<string | null>opcional——
data[].error_code · variant 1stringopcional——
data[].error_code · variant 2nullopcional——
data[].error_messageanyOf<string | null>opcional——
data[].error_message · variant 1stringopcional——
data[].error_message · variant 2nullopcional——
data[].tasksobject[]opcional——
data[].tasks[]objectopcional——
data[].tasks[].idstringobrigatório——
data[].tasks[].job_idstringobrigatório——
data[].tasks[].namestringobrigatório——
data[].tasks[].operationstringobrigatório——
data[].tasks[].statusstringobrigatório——
data[].tasks[].progressintegerobrigatório——
data[].tasks[].inputobjectobrigatório——
data[].tasks[].optionsobjectobrigatório——
data[].tasks[].resultobjectobrigatório——
data[].tasks[].requiredbooleanobrigatório——
data[].tasks[].runtime_classstringobrigatório——
data[].tasks[].prioritystringobrigatório——
data[].tasks[].attempt_countintegerobrigatório——
data[].tasks[].max_attemptsintegerobrigatório——
data[].tasks[].error_codeanyOf<string | null>opcional——
data[].tasks[].error_code · variant 1stringopcional——
data[].tasks[].error_code · variant 2nullopcional——
data[].tasks[].error_messageanyOf<string | null>opcional——
data[].tasks[].error_message · variant 1stringopcional——
data[].tasks[].error_message · variant 2nullopcional——
data[].tasks[].created_atstringobrigatório—
format: date-time
data[].tasks[].queued_atanyOf<string | null>opcional——
data[].tasks[].queued_at · variant 1stringopcional—
format: date-time
data[].tasks[].queued_at · variant 2nullopcional——
data[].tasks[].started_atanyOf<string | null>opcional——
data[].tasks[].started_at · variant 1stringopcional—
format: date-time
data[].tasks[].started_at · variant 2nullopcional——
data[].tasks[].completed_atanyOf<string | null>opcional——
data[].tasks[].completed_at · variant 1stringopcional—
format: date-time
data[].tasks[].completed_at · variant 2nullopcional——
data[].tasks[].attemptsobject[]opcional——
data[].tasks[].attempts[]objectopcional——
data[].tasks[].attempts[].idstringobrigatório——
data[].tasks[].attempts[].attempt_numberintegerobrigatório——
data[].tasks[].attempts[].statusstringobrigatório——
data[].tasks[].attempts[].worker_idanyOf<string | null>opcional——
data[].tasks[].attempts[].worker_id · variant 1stringopcional——
data[].tasks[].attempts[].worker_id · variant 2nullopcional——
data[].tasks[].attempts[].runtime_classanyOf<string | null>opcional——
data[].tasks[].attempts[].runtime_class · variant 1stringopcional——
data[].tasks[].attempts[].runtime_class · variant 2nullopcional——
data[].tasks[].attempts[].regionanyOf<string | null>opcional——
data[].tasks[].attempts[].region · variant 1stringopcional——
data[].tasks[].attempts[].region · variant 2nullopcional——
data[].tasks[].attempts[].engineanyOf<string | null>opcional——
data[].tasks[].attempts[].engine · variant 1stringopcional——
data[].tasks[].attempts[].engine · variant 2nullopcional——
data[].tasks[].attempts[].engine_versionanyOf<string | null>opcional——
data[].tasks[].attempts[].engine_version · variant 1stringopcional——
data[].tasks[].attempts[].engine_version · variant 2nullopcional——
data[].tasks[].attempts[].input_bytesanyOf<integer | null>opcional——
data[].tasks[].attempts[].input_bytes · variant 1integeropcional——
data[].tasks[].attempts[].input_bytes · variant 2nullopcional——
data[].tasks[].attempts[].output_bytesanyOf<integer | null>opcional——
data[].tasks[].attempts[].output_bytes · variant 1integeropcional——
data[].tasks[].attempts[].output_bytes · variant 2nullopcional——
data[].tasks[].attempts[].wall_msanyOf<integer | null>opcional——
data[].tasks[].attempts[].wall_ms · variant 1integeropcional——
data[].tasks[].attempts[].wall_ms · variant 2nullopcional——
data[].tasks[].attempts[].cpu_msanyOf<integer | null>opcional——
data[].tasks[].attempts[].cpu_ms · variant 1integeropcional——
data[].tasks[].attempts[].cpu_ms · variant 2nullopcional——
data[].tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcional——
data[].tasks[].attempts[].peak_memory_mb · variant 1integeropcional——
data[].tasks[].attempts[].peak_memory_mb · variant 2nullopcional——
data[].tasks[].attempts[].temp_bytesanyOf<integer | null>opcional——
data[].tasks[].attempts[].temp_bytes · variant 1integeropcional——
data[].tasks[].attempts[].temp_bytes · variant 2nullopcional——
data[].tasks[].attempts[].error_codeanyOf<string | null>opcional——
data[].tasks[].attempts[].error_code · variant 1stringopcional——
data[].tasks[].attempts[].error_code · variant 2nullopcional——
data[].tasks[].attempts[].error_messageanyOf<string | null>opcional——
data[].tasks[].attempts[].error_message · variant 1stringopcional——
data[].tasks[].attempts[].error_message · variant 2nullopcional——
data[].tasks[].attempts[].estimated_creditsanyOf<string | null>opcional——
data[].tasks[].attempts[].estimated_credits · variant 1stringopcional——
data[].tasks[].attempts[].estimated_credits · variant 2nullopcional——
data[].tasks[].attempts[].settled_creditsanyOf<string | null>opcional——
data[].tasks[].attempts[].settled_credits · variant 1stringopcional——
data[].tasks[].attempts[].settled_credits · variant 2nullopcional——
data[].tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcional——
data[].tasks[].attempts[].external_side_effect_started_at · variant 1stringopcional—
format: date-time
data[].tasks[].attempts[].external_side_effect_started_at · variant 2nullopcional——
data[].tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcional——
data[].tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcional—
format: date-time
data[].tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcional——
data[].tasks[].attempts[].started_atstringobrigatório—
format: date-time
data[].tasks[].attempts[].completed_atanyOf<string | null>opcional——
data[].tasks[].attempts[].completed_at · variant 1stringopcional—
format: date-time
data[].tasks[].attempts[].completed_at · variant 2nullopcional——
paginationobjectobrigatório——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
Idempotency-KeyheaderanyOf<string | null>opcional—

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
tasksobjectobrigatório——
taganyOf<string | null>opcional——
tag · variant 1stringopcional—
max length: 255
tag · variant 2nullopcional——
client_reference_idanyOf<string | null>opcional——
client_reference_id · variant 1stringopcional—
max length: 255
client_reference_id · variant 2nullopcional——
metadataobjectopcional——
prioritystringopcional—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>opcional——
retention_seconds · variant 1integeropcional—
min: 0max: 86400
retention_seconds · variant 2nullopcional——

Respostas

201Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
kindstringobrigatório——
statusstringobrigatório——
progressintegerobrigatório——
taganyOf<string | null>opcional——
tag · variant 1stringopcional——
tag · variant 2nullopcional——
client_reference_idanyOf<string | null>opcional——
client_reference_id · variant 1stringopcional——
client_reference_id · variant 2nullopcional——
metadataobjectopcional——
prioritystringobrigatório——
concurrency_limitintegeropcional—
default: 1
originstringobrigatório——
created_atstringobrigatório—
format: date-time
started_atanyOf<string | null>opcional——
started_at · variant 1stringopcional—
format: date-time
started_at · variant 2nullopcional——
completed_atanyOf<string | null>opcional——
completed_at · variant 1stringopcional—
format: date-time
completed_at · variant 2nullopcional——
error_codeanyOf<string | null>opcional——
error_code · variant 1stringopcional——
error_code · variant 2nullopcional——
error_messageanyOf<string | null>opcional——
error_message · variant 1stringopcional——
error_message · variant 2nullopcional——
tasksobject[]opcional——
tasks[]objectopcional——
tasks[].idstringobrigatório——
tasks[].job_idstringobrigatório——
tasks[].namestringobrigatório——
tasks[].operationstringobrigatório——
tasks[].statusstringobrigatório——
tasks[].progressintegerobrigatório——
tasks[].inputobjectobrigatório——
tasks[].optionsobjectobrigatório——
tasks[].resultobjectobrigatório——
tasks[].requiredbooleanobrigatório——
tasks[].runtime_classstringobrigatório——
tasks[].prioritystringobrigatório——
tasks[].attempt_countintegerobrigatório——
tasks[].max_attemptsintegerobrigatório——
tasks[].error_codeanyOf<string | null>opcional——
tasks[].error_code · variant 1stringopcional——
tasks[].error_code · variant 2nullopcional——
tasks[].error_messageanyOf<string | null>opcional——
tasks[].error_message · variant 1stringopcional——
tasks[].error_message · variant 2nullopcional——
tasks[].created_atstringobrigatório—
format: date-time
tasks[].queued_atanyOf<string | null>opcional——
tasks[].queued_at · variant 1stringopcional—
format: date-time
tasks[].queued_at · variant 2nullopcional——
tasks[].started_atanyOf<string | null>opcional——
tasks[].started_at · variant 1stringopcional—
format: date-time
tasks[].started_at · variant 2nullopcional——
tasks[].completed_atanyOf<string | null>opcional——
tasks[].completed_at · variant 1stringopcional—
format: date-time
tasks[].completed_at · variant 2nullopcional——
tasks[].attemptsobject[]opcional——
tasks[].attempts[]objectopcional——
tasks[].attempts[].idstringobrigatório——
tasks[].attempts[].attempt_numberintegerobrigatório——
tasks[].attempts[].statusstringobrigatório——
tasks[].attempts[].worker_idanyOf<string | null>opcional——
tasks[].attempts[].worker_id · variant 1stringopcional——
tasks[].attempts[].worker_id · variant 2nullopcional——
tasks[].attempts[].runtime_classanyOf<string | null>opcional——
tasks[].attempts[].runtime_class · variant 1stringopcional——
tasks[].attempts[].runtime_class · variant 2nullopcional——
tasks[].attempts[].regionanyOf<string | null>opcional——
tasks[].attempts[].region · variant 1stringopcional——
tasks[].attempts[].region · variant 2nullopcional——
tasks[].attempts[].engineanyOf<string | null>opcional——
tasks[].attempts[].engine · variant 1stringopcional——
tasks[].attempts[].engine · variant 2nullopcional——
tasks[].attempts[].engine_versionanyOf<string | null>opcional——
tasks[].attempts[].engine_version · variant 1stringopcional——
tasks[].attempts[].engine_version · variant 2nullopcional——
tasks[].attempts[].input_bytesanyOf<integer | null>opcional——
tasks[].attempts[].input_bytes · variant 1integeropcional——
tasks[].attempts[].input_bytes · variant 2nullopcional——
tasks[].attempts[].output_bytesanyOf<integer | null>opcional——
tasks[].attempts[].output_bytes · variant 1integeropcional——
tasks[].attempts[].output_bytes · variant 2nullopcional——
tasks[].attempts[].wall_msanyOf<integer | null>opcional——
tasks[].attempts[].wall_ms · variant 1integeropcional——
tasks[].attempts[].wall_ms · variant 2nullopcional——
tasks[].attempts[].cpu_msanyOf<integer | null>opcional——
tasks[].attempts[].cpu_ms · variant 1integeropcional——
tasks[].attempts[].cpu_ms · variant 2nullopcional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcional——
tasks[].attempts[].peak_memory_mb · variant 1integeropcional——
tasks[].attempts[].peak_memory_mb · variant 2nullopcional——
tasks[].attempts[].temp_bytesanyOf<integer | null>opcional——
tasks[].attempts[].temp_bytes · variant 1integeropcional——
tasks[].attempts[].temp_bytes · variant 2nullopcional——
tasks[].attempts[].error_codeanyOf<string | null>opcional——
tasks[].attempts[].error_code · variant 1stringopcional——
tasks[].attempts[].error_code · variant 2nullopcional——
tasks[].attempts[].error_messageanyOf<string | null>opcional——
tasks[].attempts[].error_message · variant 1stringopcional——
tasks[].attempts[].error_message · variant 2nullopcional——
tasks[].attempts[].estimated_creditsanyOf<string | null>opcional——
tasks[].attempts[].estimated_credits · variant 1stringopcional——
tasks[].attempts[].estimated_credits · variant 2nullopcional——
tasks[].attempts[].settled_creditsanyOf<string | null>opcional——
tasks[].attempts[].settled_credits · variant 1stringopcional——
tasks[].attempts[].settled_credits · variant 2nullopcional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopcional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcional——
tasks[].attempts[].started_atstringobrigatório—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opcional——
tasks[].attempts[].completed_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
job_idpathstringobrigatório—
include_attemptsquerybooleanopcional
default: false

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
kindstringobrigatório——
statusstringobrigatório——
progressintegerobrigatório——
taganyOf<string | null>opcional——
tag · variant 1stringopcional——
tag · variant 2nullopcional——
client_reference_idanyOf<string | null>opcional——
client_reference_id · variant 1stringopcional——
client_reference_id · variant 2nullopcional——
metadataobjectopcional——
prioritystringobrigatório——
concurrency_limitintegeropcional—
default: 1
originstringobrigatório——
created_atstringobrigatório—
format: date-time
started_atanyOf<string | null>opcional——
started_at · variant 1stringopcional—
format: date-time
started_at · variant 2nullopcional——
completed_atanyOf<string | null>opcional——
completed_at · variant 1stringopcional—
format: date-time
completed_at · variant 2nullopcional——
error_codeanyOf<string | null>opcional——
error_code · variant 1stringopcional——
error_code · variant 2nullopcional——
error_messageanyOf<string | null>opcional——
error_message · variant 1stringopcional——
error_message · variant 2nullopcional——
tasksobject[]opcional——
tasks[]objectopcional——
tasks[].idstringobrigatório——
tasks[].job_idstringobrigatório——
tasks[].namestringobrigatório——
tasks[].operationstringobrigatório——
tasks[].statusstringobrigatório——
tasks[].progressintegerobrigatório——
tasks[].inputobjectobrigatório——
tasks[].optionsobjectobrigatório——
tasks[].resultobjectobrigatório——
tasks[].requiredbooleanobrigatório——
tasks[].runtime_classstringobrigatório——
tasks[].prioritystringobrigatório——
tasks[].attempt_countintegerobrigatório——
tasks[].max_attemptsintegerobrigatório——
tasks[].error_codeanyOf<string | null>opcional——
tasks[].error_code · variant 1stringopcional——
tasks[].error_code · variant 2nullopcional——
tasks[].error_messageanyOf<string | null>opcional——
tasks[].error_message · variant 1stringopcional——
tasks[].error_message · variant 2nullopcional——
tasks[].created_atstringobrigatório—
format: date-time
tasks[].queued_atanyOf<string | null>opcional——
tasks[].queued_at · variant 1stringopcional—
format: date-time
tasks[].queued_at · variant 2nullopcional——
tasks[].started_atanyOf<string | null>opcional——
tasks[].started_at · variant 1stringopcional—
format: date-time
tasks[].started_at · variant 2nullopcional——
tasks[].completed_atanyOf<string | null>opcional——
tasks[].completed_at · variant 1stringopcional—
format: date-time
tasks[].completed_at · variant 2nullopcional——
tasks[].attemptsobject[]opcional——
tasks[].attempts[]objectopcional——
tasks[].attempts[].idstringobrigatório——
tasks[].attempts[].attempt_numberintegerobrigatório——
tasks[].attempts[].statusstringobrigatório——
tasks[].attempts[].worker_idanyOf<string | null>opcional——
tasks[].attempts[].worker_id · variant 1stringopcional——
tasks[].attempts[].worker_id · variant 2nullopcional——
tasks[].attempts[].runtime_classanyOf<string | null>opcional——
tasks[].attempts[].runtime_class · variant 1stringopcional——
tasks[].attempts[].runtime_class · variant 2nullopcional——
tasks[].attempts[].regionanyOf<string | null>opcional——
tasks[].attempts[].region · variant 1stringopcional——
tasks[].attempts[].region · variant 2nullopcional——
tasks[].attempts[].engineanyOf<string | null>opcional——
tasks[].attempts[].engine · variant 1stringopcional——
tasks[].attempts[].engine · variant 2nullopcional——
tasks[].attempts[].engine_versionanyOf<string | null>opcional——
tasks[].attempts[].engine_version · variant 1stringopcional——
tasks[].attempts[].engine_version · variant 2nullopcional——
tasks[].attempts[].input_bytesanyOf<integer | null>opcional——
tasks[].attempts[].input_bytes · variant 1integeropcional——
tasks[].attempts[].input_bytes · variant 2nullopcional——
tasks[].attempts[].output_bytesanyOf<integer | null>opcional——
tasks[].attempts[].output_bytes · variant 1integeropcional——
tasks[].attempts[].output_bytes · variant 2nullopcional——
tasks[].attempts[].wall_msanyOf<integer | null>opcional——
tasks[].attempts[].wall_ms · variant 1integeropcional——
tasks[].attempts[].wall_ms · variant 2nullopcional——
tasks[].attempts[].cpu_msanyOf<integer | null>opcional——
tasks[].attempts[].cpu_ms · variant 1integeropcional——
tasks[].attempts[].cpu_ms · variant 2nullopcional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcional——
tasks[].attempts[].peak_memory_mb · variant 1integeropcional——
tasks[].attempts[].peak_memory_mb · variant 2nullopcional——
tasks[].attempts[].temp_bytesanyOf<integer | null>opcional——
tasks[].attempts[].temp_bytes · variant 1integeropcional——
tasks[].attempts[].temp_bytes · variant 2nullopcional——
tasks[].attempts[].error_codeanyOf<string | null>opcional——
tasks[].attempts[].error_code · variant 1stringopcional——
tasks[].attempts[].error_code · variant 2nullopcional——
tasks[].attempts[].error_messageanyOf<string | null>opcional——
tasks[].attempts[].error_message · variant 1stringopcional——
tasks[].attempts[].error_message · variant 2nullopcional——
tasks[].attempts[].estimated_creditsanyOf<string | null>opcional——
tasks[].attempts[].estimated_credits · variant 1stringopcional——
tasks[].attempts[].estimated_credits · variant 2nullopcional——
tasks[].attempts[].settled_creditsanyOf<string | null>opcional——
tasks[].attempts[].settled_credits · variant 1stringopcional——
tasks[].attempts[].settled_credits · variant 2nullopcional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopcional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcional——
tasks[].attempts[].started_atstringobrigatório—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opcional——
tasks[].attempts[].completed_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
job_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
kindstringobrigatório——
statusstringobrigatório——
progressintegerobrigatório——
taganyOf<string | null>opcional——
tag · variant 1stringopcional——
tag · variant 2nullopcional——
client_reference_idanyOf<string | null>opcional——
client_reference_id · variant 1stringopcional——
client_reference_id · variant 2nullopcional——
metadataobjectopcional——
prioritystringobrigatório——
concurrency_limitintegeropcional—
default: 1
originstringobrigatório——
created_atstringobrigatório—
format: date-time
started_atanyOf<string | null>opcional——
started_at · variant 1stringopcional—
format: date-time
started_at · variant 2nullopcional——
completed_atanyOf<string | null>opcional——
completed_at · variant 1stringopcional—
format: date-time
completed_at · variant 2nullopcional——
error_codeanyOf<string | null>opcional——
error_code · variant 1stringopcional——
error_code · variant 2nullopcional——
error_messageanyOf<string | null>opcional——
error_message · variant 1stringopcional——
error_message · variant 2nullopcional——
tasksobject[]opcional——
tasks[]objectopcional——
tasks[].idstringobrigatório——
tasks[].job_idstringobrigatório——
tasks[].namestringobrigatório——
tasks[].operationstringobrigatório——
tasks[].statusstringobrigatório——
tasks[].progressintegerobrigatório——
tasks[].inputobjectobrigatório——
tasks[].optionsobjectobrigatório——
tasks[].resultobjectobrigatório——
tasks[].requiredbooleanobrigatório——
tasks[].runtime_classstringobrigatório——
tasks[].prioritystringobrigatório——
tasks[].attempt_countintegerobrigatório——
tasks[].max_attemptsintegerobrigatório——
tasks[].error_codeanyOf<string | null>opcional——
tasks[].error_code · variant 1stringopcional——
tasks[].error_code · variant 2nullopcional——
tasks[].error_messageanyOf<string | null>opcional——
tasks[].error_message · variant 1stringopcional——
tasks[].error_message · variant 2nullopcional——
tasks[].created_atstringobrigatório—
format: date-time
tasks[].queued_atanyOf<string | null>opcional——
tasks[].queued_at · variant 1stringopcional—
format: date-time
tasks[].queued_at · variant 2nullopcional——
tasks[].started_atanyOf<string | null>opcional——
tasks[].started_at · variant 1stringopcional—
format: date-time
tasks[].started_at · variant 2nullopcional——
tasks[].completed_atanyOf<string | null>opcional——
tasks[].completed_at · variant 1stringopcional—
format: date-time
tasks[].completed_at · variant 2nullopcional——
tasks[].attemptsobject[]opcional——
tasks[].attempts[]objectopcional——
tasks[].attempts[].idstringobrigatório——
tasks[].attempts[].attempt_numberintegerobrigatório——
tasks[].attempts[].statusstringobrigatório——
tasks[].attempts[].worker_idanyOf<string | null>opcional——
tasks[].attempts[].worker_id · variant 1stringopcional——
tasks[].attempts[].worker_id · variant 2nullopcional——
tasks[].attempts[].runtime_classanyOf<string | null>opcional——
tasks[].attempts[].runtime_class · variant 1stringopcional——
tasks[].attempts[].runtime_class · variant 2nullopcional——
tasks[].attempts[].regionanyOf<string | null>opcional——
tasks[].attempts[].region · variant 1stringopcional——
tasks[].attempts[].region · variant 2nullopcional——
tasks[].attempts[].engineanyOf<string | null>opcional——
tasks[].attempts[].engine · variant 1stringopcional——
tasks[].attempts[].engine · variant 2nullopcional——
tasks[].attempts[].engine_versionanyOf<string | null>opcional——
tasks[].attempts[].engine_version · variant 1stringopcional——
tasks[].attempts[].engine_version · variant 2nullopcional——
tasks[].attempts[].input_bytesanyOf<integer | null>opcional——
tasks[].attempts[].input_bytes · variant 1integeropcional——
tasks[].attempts[].input_bytes · variant 2nullopcional——
tasks[].attempts[].output_bytesanyOf<integer | null>opcional——
tasks[].attempts[].output_bytes · variant 1integeropcional——
tasks[].attempts[].output_bytes · variant 2nullopcional——
tasks[].attempts[].wall_msanyOf<integer | null>opcional——
tasks[].attempts[].wall_ms · variant 1integeropcional——
tasks[].attempts[].wall_ms · variant 2nullopcional——
tasks[].attempts[].cpu_msanyOf<integer | null>opcional——
tasks[].attempts[].cpu_ms · variant 1integeropcional——
tasks[].attempts[].cpu_ms · variant 2nullopcional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcional——
tasks[].attempts[].peak_memory_mb · variant 1integeropcional——
tasks[].attempts[].peak_memory_mb · variant 2nullopcional——
tasks[].attempts[].temp_bytesanyOf<integer | null>opcional——
tasks[].attempts[].temp_bytes · variant 1integeropcional——
tasks[].attempts[].temp_bytes · variant 2nullopcional——
tasks[].attempts[].error_codeanyOf<string | null>opcional——
tasks[].attempts[].error_code · variant 1stringopcional——
tasks[].attempts[].error_code · variant 2nullopcional——
tasks[].attempts[].error_messageanyOf<string | null>opcional——
tasks[].attempts[].error_message · variant 1stringopcional——
tasks[].attempts[].error_message · variant 2nullopcional——
tasks[].attempts[].estimated_creditsanyOf<string | null>opcional——
tasks[].attempts[].estimated_credits · variant 1stringopcional——
tasks[].attempts[].estimated_credits · variant 2nullopcional——
tasks[].attempts[].settled_creditsanyOf<string | null>opcional——
tasks[].attempts[].settled_credits · variant 1stringopcional——
tasks[].attempts[].settled_credits · variant 2nullopcional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopcional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcional——
tasks[].attempts[].started_atstringobrigatório—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opcional——
tasks[].attempts[].completed_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
job_idpathstringobrigatório—
timeoutqueryintegeropcional
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>opcional—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
bodyunknownobrigatório——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
job_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
kindstringobrigatório——
statusstringobrigatório——
progressintegerobrigatório——
taganyOf<string | null>opcional——
tag · variant 1stringopcional——
tag · variant 2nullopcional——
client_reference_idanyOf<string | null>opcional——
client_reference_id · variant 1stringopcional——
client_reference_id · variant 2nullopcional——
metadataobjectopcional——
prioritystringobrigatório——
concurrency_limitintegeropcional—
default: 1
originstringobrigatório——
created_atstringobrigatório—
format: date-time
started_atanyOf<string | null>opcional——
started_at · variant 1stringopcional—
format: date-time
started_at · variant 2nullopcional——
completed_atanyOf<string | null>opcional——
completed_at · variant 1stringopcional—
format: date-time
completed_at · variant 2nullopcional——
error_codeanyOf<string | null>opcional——
error_code · variant 1stringopcional——
error_code · variant 2nullopcional——
error_messageanyOf<string | null>opcional——
error_message · variant 1stringopcional——
error_message · variant 2nullopcional——
tasksobject[]opcional——
tasks[]objectopcional——
tasks[].idstringobrigatório——
tasks[].job_idstringobrigatório——
tasks[].namestringobrigatório——
tasks[].operationstringobrigatório——
tasks[].statusstringobrigatório——
tasks[].progressintegerobrigatório——
tasks[].inputobjectobrigatório——
tasks[].optionsobjectobrigatório——
tasks[].resultobjectobrigatório——
tasks[].requiredbooleanobrigatório——
tasks[].runtime_classstringobrigatório——
tasks[].prioritystringobrigatório——
tasks[].attempt_countintegerobrigatório——
tasks[].max_attemptsintegerobrigatório——
tasks[].error_codeanyOf<string | null>opcional——
tasks[].error_code · variant 1stringopcional——
tasks[].error_code · variant 2nullopcional——
tasks[].error_messageanyOf<string | null>opcional——
tasks[].error_message · variant 1stringopcional——
tasks[].error_message · variant 2nullopcional——
tasks[].created_atstringobrigatório—
format: date-time
tasks[].queued_atanyOf<string | null>opcional——
tasks[].queued_at · variant 1stringopcional—
format: date-time
tasks[].queued_at · variant 2nullopcional——
tasks[].started_atanyOf<string | null>opcional——
tasks[].started_at · variant 1stringopcional—
format: date-time
tasks[].started_at · variant 2nullopcional——
tasks[].completed_atanyOf<string | null>opcional——
tasks[].completed_at · variant 1stringopcional—
format: date-time
tasks[].completed_at · variant 2nullopcional——
tasks[].attemptsobject[]opcional——
tasks[].attempts[]objectopcional——
tasks[].attempts[].idstringobrigatório——
tasks[].attempts[].attempt_numberintegerobrigatório——
tasks[].attempts[].statusstringobrigatório——
tasks[].attempts[].worker_idanyOf<string | null>opcional——
tasks[].attempts[].worker_id · variant 1stringopcional——
tasks[].attempts[].worker_id · variant 2nullopcional——
tasks[].attempts[].runtime_classanyOf<string | null>opcional——
tasks[].attempts[].runtime_class · variant 1stringopcional——
tasks[].attempts[].runtime_class · variant 2nullopcional——
tasks[].attempts[].regionanyOf<string | null>opcional——
tasks[].attempts[].region · variant 1stringopcional——
tasks[].attempts[].region · variant 2nullopcional——
tasks[].attempts[].engineanyOf<string | null>opcional——
tasks[].attempts[].engine · variant 1stringopcional——
tasks[].attempts[].engine · variant 2nullopcional——
tasks[].attempts[].engine_versionanyOf<string | null>opcional——
tasks[].attempts[].engine_version · variant 1stringopcional——
tasks[].attempts[].engine_version · variant 2nullopcional——
tasks[].attempts[].input_bytesanyOf<integer | null>opcional——
tasks[].attempts[].input_bytes · variant 1integeropcional——
tasks[].attempts[].input_bytes · variant 2nullopcional——
tasks[].attempts[].output_bytesanyOf<integer | null>opcional——
tasks[].attempts[].output_bytes · variant 1integeropcional——
tasks[].attempts[].output_bytes · variant 2nullopcional——
tasks[].attempts[].wall_msanyOf<integer | null>opcional——
tasks[].attempts[].wall_ms · variant 1integeropcional——
tasks[].attempts[].wall_ms · variant 2nullopcional——
tasks[].attempts[].cpu_msanyOf<integer | null>opcional——
tasks[].attempts[].cpu_ms · variant 1integeropcional——
tasks[].attempts[].cpu_ms · variant 2nullopcional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcional——
tasks[].attempts[].peak_memory_mb · variant 1integeropcional——
tasks[].attempts[].peak_memory_mb · variant 2nullopcional——
tasks[].attempts[].temp_bytesanyOf<integer | null>opcional——
tasks[].attempts[].temp_bytes · variant 1integeropcional——
tasks[].attempts[].temp_bytes · variant 2nullopcional——
tasks[].attempts[].error_codeanyOf<string | null>opcional——
tasks[].attempts[].error_code · variant 1stringopcional——
tasks[].attempts[].error_code · variant 2nullopcional——
tasks[].attempts[].error_messageanyOf<string | null>opcional——
tasks[].attempts[].error_message · variant 1stringopcional——
tasks[].attempts[].error_message · variant 2nullopcional——
tasks[].attempts[].estimated_creditsanyOf<string | null>opcional——
tasks[].attempts[].estimated_credits · variant 1stringopcional——
tasks[].attempts[].estimated_credits · variant 2nullopcional——
tasks[].attempts[].settled_creditsanyOf<string | null>opcional——
tasks[].attempts[].settled_credits · variant 1stringopcional——
tasks[].attempts[].settled_credits · variant 2nullopcional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopcional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcional——
tasks[].attempts[].started_atstringobrigatório—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opcional——
tasks[].attempts[].completed_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
job_idpathstringobrigatório—
timeoutqueryintegeropcional
default: 20min: 0max: 30

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
kindstringobrigatório——
statusstringobrigatório——
progressintegerobrigatório——
taganyOf<string | null>opcional——
tag · variant 1stringopcional——
tag · variant 2nullopcional——
client_reference_idanyOf<string | null>opcional——
client_reference_id · variant 1stringopcional——
client_reference_id · variant 2nullopcional——
metadataobjectopcional——
prioritystringobrigatório——
concurrency_limitintegeropcional—
default: 1
originstringobrigatório——
created_atstringobrigatório—
format: date-time
started_atanyOf<string | null>opcional——
started_at · variant 1stringopcional—
format: date-time
started_at · variant 2nullopcional——
completed_atanyOf<string | null>opcional——
completed_at · variant 1stringopcional—
format: date-time
completed_at · variant 2nullopcional——
error_codeanyOf<string | null>opcional——
error_code · variant 1stringopcional——
error_code · variant 2nullopcional——
error_messageanyOf<string | null>opcional——
error_message · variant 1stringopcional——
error_message · variant 2nullopcional——
tasksobject[]opcional——
tasks[]objectopcional——
tasks[].idstringobrigatório——
tasks[].job_idstringobrigatório——
tasks[].namestringobrigatório——
tasks[].operationstringobrigatório——
tasks[].statusstringobrigatório——
tasks[].progressintegerobrigatório——
tasks[].inputobjectobrigatório——
tasks[].optionsobjectobrigatório——
tasks[].resultobjectobrigatório——
tasks[].requiredbooleanobrigatório——
tasks[].runtime_classstringobrigatório——
tasks[].prioritystringobrigatório——
tasks[].attempt_countintegerobrigatório——
tasks[].max_attemptsintegerobrigatório——
tasks[].error_codeanyOf<string | null>opcional——
tasks[].error_code · variant 1stringopcional——
tasks[].error_code · variant 2nullopcional——
tasks[].error_messageanyOf<string | null>opcional——
tasks[].error_message · variant 1stringopcional——
tasks[].error_message · variant 2nullopcional——
tasks[].created_atstringobrigatório—
format: date-time
tasks[].queued_atanyOf<string | null>opcional——
tasks[].queued_at · variant 1stringopcional—
format: date-time
tasks[].queued_at · variant 2nullopcional——
tasks[].started_atanyOf<string | null>opcional——
tasks[].started_at · variant 1stringopcional—
format: date-time
tasks[].started_at · variant 2nullopcional——
tasks[].completed_atanyOf<string | null>opcional——
tasks[].completed_at · variant 1stringopcional—
format: date-time
tasks[].completed_at · variant 2nullopcional——
tasks[].attemptsobject[]opcional——
tasks[].attempts[]objectopcional——
tasks[].attempts[].idstringobrigatório——
tasks[].attempts[].attempt_numberintegerobrigatório——
tasks[].attempts[].statusstringobrigatório——
tasks[].attempts[].worker_idanyOf<string | null>opcional——
tasks[].attempts[].worker_id · variant 1stringopcional——
tasks[].attempts[].worker_id · variant 2nullopcional——
tasks[].attempts[].runtime_classanyOf<string | null>opcional——
tasks[].attempts[].runtime_class · variant 1stringopcional——
tasks[].attempts[].runtime_class · variant 2nullopcional——
tasks[].attempts[].regionanyOf<string | null>opcional——
tasks[].attempts[].region · variant 1stringopcional——
tasks[].attempts[].region · variant 2nullopcional——
tasks[].attempts[].engineanyOf<string | null>opcional——
tasks[].attempts[].engine · variant 1stringopcional——
tasks[].attempts[].engine · variant 2nullopcional——
tasks[].attempts[].engine_versionanyOf<string | null>opcional——
tasks[].attempts[].engine_version · variant 1stringopcional——
tasks[].attempts[].engine_version · variant 2nullopcional——
tasks[].attempts[].input_bytesanyOf<integer | null>opcional——
tasks[].attempts[].input_bytes · variant 1integeropcional——
tasks[].attempts[].input_bytes · variant 2nullopcional——
tasks[].attempts[].output_bytesanyOf<integer | null>opcional——
tasks[].attempts[].output_bytes · variant 1integeropcional——
tasks[].attempts[].output_bytes · variant 2nullopcional——
tasks[].attempts[].wall_msanyOf<integer | null>opcional——
tasks[].attempts[].wall_ms · variant 1integeropcional——
tasks[].attempts[].wall_ms · variant 2nullopcional——
tasks[].attempts[].cpu_msanyOf<integer | null>opcional——
tasks[].attempts[].cpu_ms · variant 1integeropcional——
tasks[].attempts[].cpu_ms · variant 2nullopcional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcional——
tasks[].attempts[].peak_memory_mb · variant 1integeropcional——
tasks[].attempts[].peak_memory_mb · variant 2nullopcional——
tasks[].attempts[].temp_bytesanyOf<integer | null>opcional——
tasks[].attempts[].temp_bytes · variant 1integeropcional——
tasks[].attempts[].temp_bytes · variant 2nullopcional——
tasks[].attempts[].error_codeanyOf<string | null>opcional——
tasks[].attempts[].error_code · variant 1stringopcional——
tasks[].attempts[].error_code · variant 2nullopcional——
tasks[].attempts[].error_messageanyOf<string | null>opcional——
tasks[].attempts[].error_message · variant 1stringopcional——
tasks[].attempts[].error_message · variant 2nullopcional——
tasks[].attempts[].estimated_creditsanyOf<string | null>opcional——
tasks[].attempts[].estimated_credits · variant 1stringopcional——
tasks[].attempts[].estimated_credits · variant 2nullopcional——
tasks[].attempts[].settled_creditsanyOf<string | null>opcional——
tasks[].attempts[].settled_credits · variant 1stringopcional——
tasks[].attempts[].settled_credits · variant 2nullopcional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopcional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcional——
tasks[].attempts[].started_atstringobrigatório—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opcional——
tasks[].attempts[].completed_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
tasksobjectobrigatório——
taganyOf<string | null>opcional——
tag · variant 1stringopcional—
max length: 255
tag · variant 2nullopcional——
client_reference_idanyOf<string | null>opcional——
client_reference_id · variant 1stringopcional—
max length: 255
client_reference_id · variant 2nullopcional——
metadataobjectopcional——
prioritystringopcional—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>opcional——
retention_seconds · variant 1integeropcional—
min: 0max: 86400
retention_seconds · variant 2nullopcional——

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
validbooleanobrigatório——
task_countintegerobrigatório——
execution_orderstring[]obrigatório——
root_tasksstring[]obrigatório——
warningsstring[]opcional——
estimated_creditsanyOf<object | null>opcional——
estimated_credits · variant 1objectopcional——
estimated_credits · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
limitqueryintegeropcional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcional—
status_codequeryanyOf<integer | null>opcional—
path_prefixqueryanyOf<string | null>opcional—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
dataobject[]obrigatório——
data[]objectopcional——
data[].request_idstringobrigatório——
data[].methodstringobrigatório——
data[].pathstringobrigatório——
data[].status_codeintegerobrigatório——
data[].latency_msintegerobrigatório——
data[].api_key_idanyOf<string | null>opcional——
data[].api_key_id · variant 1stringopcional——
data[].api_key_id · variant 2nullopcional——
data[].auth_typestringobrigatório——
data[].user_agentanyOf<string | null>opcional——
data[].user_agent · variant 1stringopcional——
data[].user_agent · variant 2nullopcional——
data[].created_atstringobrigatório——
paginationobjectobrigatório——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
request_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
request_idstringobrigatório——
methodstringobrigatório——
pathstringobrigatório——
status_codeintegerobrigatório——
latency_msintegerobrigatório——
api_key_idanyOf<string | null>opcional——
api_key_id · variant 1stringopcional——
api_key_id · variant 2nullopcional——
auth_typestringobrigatório——
user_agentanyOf<string | null>opcional——
user_agent · variant 1stringopcional——
user_agent · variant 2nullopcional——
created_atstringobrigatório——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
account_idstringobrigatório——
actor_idstringobrigatório——
auth_typestringobrigatório——
environmentstringobrigatório——
access_tierstringopcional—
enum: "sandbox", "paid"default: "paid"
scopesstring[]obrigatório——
roleanyOf<string | null>opcional——
role · variant 1stringopcional——
role · variant 2nullopcional——
authorized_partyanyOf<string | null>opcional——
authorized_party · variant 1stringopcional——
authorized_party · variant 2nullopcional——
limitsanyOf<object | null>opcional——
limits · variant 1objectopcional——
limits · variant 1.monthly_callsanyOf<integer | null>opcional——
limits · variant 1.monthly_calls · variant 1integeropcional——
limits · variant 1.monthly_calls · variant 2nullopcional——
limits · variant 1.rate_limit_per_minuteanyOf<integer | null>opcional——
limits · variant 1.rate_limit_per_minute · variant 1integeropcional——
limits · variant 1.rate_limit_per_minute · variant 2nullopcional——
limits · variant 1.daily_requestsanyOf<integer | null>opcional——
limits · variant 1.daily_requests · variant 1integeropcional——
limits · variant 1.daily_requests · variant 2nullopcional——
limits · variant 1.concurrencyanyOf<integer | null>opcional——
limits · variant 1.concurrency · variant 1integeropcional——
limits · variant 1.concurrency · variant 2nullopcional——
limits · variant 1.max_file_mbanyOf<integer | null>opcional——
limits · variant 1.max_file_mb · variant 1integeropcional——
limits · variant 1.max_file_mb · variant 2nullopcional——
limits · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
GET/v1/operationsOperationsDiscovery#

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

AutenticaçãoPúblico / sem autenticação específica da operação

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
dataobject[]obrigatório——
data[]objectopcional——
data[].operationstringobrigatório——
data[].categorystringobrigatório—
enum: "import", "processing", "export"
data[].descriptionstringobrigatório——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
account_idstringobrigatório——
environmentstringobrigatório——
scopedbooleanobrigatório——
project_idanyOf<string | null>opcional——
project_id · variant 1stringopcional——
project_id · variant 2nullopcional——
project_nameanyOf<string | null>opcional——
project_name · variant 1stringopcional——
project_name · variant 2nullopcional——
project_sluganyOf<string | null>opcional——
project_slug · variant 1stringopcional——
project_slug · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
GET/v1/project/legacy-migrationPreview Legacy MigrationAuthentication · Projects#

Preview account/environment resources still in the legacy namespace.

Autenticação
ConverterHQBearerhttp / bearer

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
bodyobjectobrigatório——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
POST/v1/project/legacy-migrationMigrate Legacy Project ResourcesAuthentication · Projects#

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

Autenticação
ConverterHQBearerhttp / bearer

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
confirm_project_idstringobrigatório—
min length: 1max length: 64

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
bodyobjectobrigatório——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
tokenstringobrigatório——
expires_atstringobrigatório—
format: date-time
websocket_urlstringobrigatório——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
bodyobjectobrigatório——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
fixture_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
bodyobjectobrigatório——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
bodyobject[]obrigatório——
items[]objectopcional——
items[].idstringobrigatório——
items[].namestringobrigatório——
items[].workflow_idanyOf<string | null>opcional——
items[].workflow_id · variant 1stringopcional——
items[].workflow_id · variant 2nullopcional——
items[].workflow_versionanyOf<integer | null>opcional——
items[].workflow_version · variant 1integeropcional——
items[].workflow_version · variant 2nullopcional——
items[].inline_definitionanyOf<object | null>opcional——
items[].inline_definition · variant 1objectopcional——
items[].inline_definition · variant 2nullopcional——
items[].variables_schemaobjectobrigatório——
items[].allowed_source_hostsstring[]obrigatório——
items[].max_file_size_bytesanyOf<integer | null>opcional——
items[].max_file_size_bytes · variant 1integeropcional——
items[].max_file_size_bytes · variant 2nullopcional——
items[].max_credits_per_requestanyOf<string | null>opcional——
items[].max_credits_per_request · variant 1stringopcional——
items[].max_credits_per_request · variant 2nullopcional——
items[].max_usesanyOf<integer | null>opcional——
items[].max_uses · variant 1integeropcional——
items[].max_uses · variant 2nullopcional——
items[].use_countintegerobrigatório——
items[].cache_ttl_secondsintegerobrigatório——
items[].enabledbooleanobrigatório——
items[].created_atstringobrigatório—
format: date-time
items[].updated_atstringobrigatório—
format: date-time
items[].signing_secretanyOf<string | null>opcional——
items[].signing_secret · variant 1stringopcional——
items[].signing_secret · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
namestringobrigatório—
min length: 1max length: 255
workflow_idanyOf<string | null>opcional——
workflow_id · variant 1stringopcional——
workflow_id · variant 2nullopcional——
inline_definitionanyOf<object | null>opcional——
inline_definition · variant 1objectopcional——
inline_definition · variant 1.tasksobjectobrigatório——
inline_definition · variant 1.taganyOf<string | null>opcional——
inline_definition · variant 1.tag · variant 1stringopcional—
max length: 255
inline_definition · variant 1.tag · variant 2nullopcional——
inline_definition · variant 1.client_reference_idanyOf<string | null>opcional——
inline_definition · variant 1.client_reference_id · variant 1stringopcional—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nullopcional——
inline_definition · variant 1.metadataobjectopcional——
inline_definition · variant 1.prioritystringopcional—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>opcional——
inline_definition · variant 1.retention_seconds · variant 1integeropcional—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nullopcional——
inline_definition · variant 2nullopcional——
variables_schemaobjectopcional——
allowed_source_hostsstring[]opcional——
max_file_size_bytesanyOf<integer | null>opcional——
max_file_size_bytes · variant 1integeropcional——
max_file_size_bytes · variant 2nullopcional——
max_credits_per_requestanyOf<string | null>opcional——
max_credits_per_request · variant 1stringopcional—
max length: 64
max_credits_per_request · variant 2nullopcional——
max_usesanyOf<integer | null>opcional——
max_uses · variant 1integeropcional——
max_uses · variant 2nullopcional——
cache_ttl_secondsintegeropcional—
default: 0min: 0max: 86400

Respostas

201Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
namestringobrigatório——
workflow_idanyOf<string | null>opcional——
workflow_id · variant 1stringopcional——
workflow_id · variant 2nullopcional——
workflow_versionanyOf<integer | null>opcional——
workflow_version · variant 1integeropcional——
workflow_version · variant 2nullopcional——
inline_definitionanyOf<object | null>opcional——
inline_definition · variant 1objectopcional——
inline_definition · variant 2nullopcional——
variables_schemaobjectobrigatório——
allowed_source_hostsstring[]obrigatório——
max_file_size_bytesanyOf<integer | null>opcional——
max_file_size_bytes · variant 1integeropcional——
max_file_size_bytes · variant 2nullopcional——
max_credits_per_requestanyOf<string | null>opcional——
max_credits_per_request · variant 1stringopcional——
max_credits_per_request · variant 2nullopcional——
max_usesanyOf<integer | null>opcional——
max_uses · variant 1integeropcional——
max_uses · variant 2nullopcional——
use_countintegerobrigatório——
cache_ttl_secondsintegerobrigatório——
enabledbooleanobrigatório——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
signing_secretanyOf<string | null>opcional——
signing_secret · variant 1stringopcional——
signing_secret · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
base_idpathstringobrigatório—

Respostas

204Successful Response

Sem corpo de resposta.

400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
base_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
namestringobrigatório——
workflow_idanyOf<string | null>opcional——
workflow_id · variant 1stringopcional——
workflow_id · variant 2nullopcional——
workflow_versionanyOf<integer | null>opcional——
workflow_version · variant 1integeropcional——
workflow_version · variant 2nullopcional——
inline_definitionanyOf<object | null>opcional——
inline_definition · variant 1objectopcional——
inline_definition · variant 2nullopcional——
variables_schemaobjectobrigatório——
allowed_source_hostsstring[]obrigatório——
max_file_size_bytesanyOf<integer | null>opcional——
max_file_size_bytes · variant 1integeropcional——
max_file_size_bytes · variant 2nullopcional——
max_credits_per_requestanyOf<string | null>opcional——
max_credits_per_request · variant 1stringopcional——
max_credits_per_request · variant 2nullopcional——
max_usesanyOf<integer | null>opcional——
max_uses · variant 1integeropcional——
max_uses · variant 2nullopcional——
use_countintegerobrigatório——
cache_ttl_secondsintegerobrigatório——
enabledbooleanobrigatório——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
signing_secretanyOf<string | null>opcional——
signing_secret · variant 1stringopcional——
signing_secret · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
base_idpathstringobrigatório—

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
nameanyOf<string | null>opcional——
name · variant 1stringopcional—
min length: 1max length: 255
name · variant 2nullopcional——
workflow_idanyOf<string | null>opcional——
workflow_id · variant 1stringopcional——
workflow_id · variant 2nullopcional——
inline_definitionanyOf<object | null>opcional——
inline_definition · variant 1objectopcional——
inline_definition · variant 1.tasksobjectobrigatório——
inline_definition · variant 1.taganyOf<string | null>opcional——
inline_definition · variant 1.tag · variant 1stringopcional—
max length: 255
inline_definition · variant 1.tag · variant 2nullopcional——
inline_definition · variant 1.client_reference_idanyOf<string | null>opcional——
inline_definition · variant 1.client_reference_id · variant 1stringopcional—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nullopcional——
inline_definition · variant 1.metadataobjectopcional——
inline_definition · variant 1.prioritystringopcional—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>opcional——
inline_definition · variant 1.retention_seconds · variant 1integeropcional—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nullopcional——
inline_definition · variant 2nullopcional——
variables_schemaanyOf<object | null>opcional——
variables_schema · variant 1objectopcional——
variables_schema · variant 2nullopcional——
allowed_source_hostsanyOf<string[] | null>opcional——
allowed_source_hosts · variant 1string[]opcional——
allowed_source_hosts · variant 2nullopcional——
max_file_size_bytesanyOf<integer | null>opcional——
max_file_size_bytes · variant 1integeropcional——
max_file_size_bytes · variant 2nullopcional——
max_credits_per_requestanyOf<string | null>opcional——
max_credits_per_request · variant 1stringopcional—
max length: 64
max_credits_per_request · variant 2nullopcional——
max_usesanyOf<integer | null>opcional——
max_uses · variant 1integeropcional——
max_uses · variant 2nullopcional——
cache_ttl_secondsanyOf<integer | null>opcional——
cache_ttl_seconds · variant 1integeropcional—
min: 0max: 86400
cache_ttl_seconds · variant 2nullopcional——
enabledanyOf<boolean | null>opcional——
enabled · variant 1booleanopcional——
enabled · variant 2nullopcional——

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
namestringobrigatório——
workflow_idanyOf<string | null>opcional——
workflow_id · variant 1stringopcional——
workflow_id · variant 2nullopcional——
workflow_versionanyOf<integer | null>opcional——
workflow_version · variant 1integeropcional——
workflow_version · variant 2nullopcional——
inline_definitionanyOf<object | null>opcional——
inline_definition · variant 1objectopcional——
inline_definition · variant 2nullopcional——
variables_schemaobjectobrigatório——
allowed_source_hostsstring[]obrigatório——
max_file_size_bytesanyOf<integer | null>opcional——
max_file_size_bytes · variant 1integeropcional——
max_file_size_bytes · variant 2nullopcional——
max_credits_per_requestanyOf<string | null>opcional——
max_credits_per_request · variant 1stringopcional——
max_credits_per_request · variant 2nullopcional——
max_usesanyOf<integer | null>opcional——
max_uses · variant 1integeropcional——
max_uses · variant 2nullopcional——
use_countintegerobrigatório——
cache_ttl_secondsintegerobrigatório——
enabledbooleanobrigatório——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
signing_secretanyOf<string | null>opcional——
signing_secret · variant 1stringopcional——
signing_secret · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
base_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
namestringobrigatório——
workflow_idanyOf<string | null>opcional——
workflow_id · variant 1stringopcional——
workflow_id · variant 2nullopcional——
workflow_versionanyOf<integer | null>opcional——
workflow_version · variant 1integeropcional——
workflow_version · variant 2nullopcional——
inline_definitionanyOf<object | null>opcional——
inline_definition · variant 1objectopcional——
inline_definition · variant 2nullopcional——
variables_schemaobjectobrigatório——
allowed_source_hostsstring[]obrigatório——
max_file_size_bytesanyOf<integer | null>opcional——
max_file_size_bytes · variant 1integeropcional——
max_file_size_bytes · variant 2nullopcional——
max_credits_per_requestanyOf<string | null>opcional——
max_credits_per_request · variant 1stringopcional——
max_credits_per_request · variant 2nullopcional——
max_usesanyOf<integer | null>opcional——
max_uses · variant 1integeropcional——
max_uses · variant 2nullopcional——
use_countintegerobrigatório——
cache_ttl_secondsintegerobrigatório——
enabledbooleanobrigatório——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
signing_secretanyOf<string | null>opcional——
signing_secret · variant 1stringopcional——
signing_secret · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
base_idpathstringobrigatório—

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
variablesobjectopcional——
expires_inintegeropcional—
default: 3600min: 60max: 86400
cache_keyanyOf<string | null>opcional——
cache_key · variant 1stringopcional—
max length: 255
cache_key · variant 2nullopcional——

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
urlstringobrigatório——
expires_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

AutenticaçãoPúblico / sem autenticação específica da operação

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
statusstringobrigatório—
enum: "ok", "degraded"
servicestringopcional—
default: "converterhq-api"
api_versionstringopcional—
default: "v1"
timestampstringobrigatório—
format: date-time
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

AutenticaçãoPúblico / sem autenticação específica da operação

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
successful_conversionsintegerobrigatório——
input_bytes_processedintegerobrigatório——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
task_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
job_idstringobrigatório——
namestringobrigatório——
operationstringobrigatório——
statusstringobrigatório——
progressintegerobrigatório——
inputobjectobrigatório——
optionsobjectobrigatório——
resultobjectobrigatório——
requiredbooleanobrigatório——
runtime_classstringobrigatório——
prioritystringobrigatório——
attempt_countintegerobrigatório——
max_attemptsintegerobrigatório——
error_codeanyOf<string | null>opcional——
error_code · variant 1stringopcional——
error_code · variant 2nullopcional——
error_messageanyOf<string | null>opcional——
error_message · variant 1stringopcional——
error_message · variant 2nullopcional——
created_atstringobrigatório—
format: date-time
queued_atanyOf<string | null>opcional——
queued_at · variant 1stringopcional—
format: date-time
queued_at · variant 2nullopcional——
started_atanyOf<string | null>opcional——
started_at · variant 1stringopcional—
format: date-time
started_at · variant 2nullopcional——
completed_atanyOf<string | null>opcional——
completed_at · variant 1stringopcional—
format: date-time
completed_at · variant 2nullopcional——
attemptsobject[]opcional——
attempts[]objectopcional——
attempts[].idstringobrigatório——
attempts[].attempt_numberintegerobrigatório——
attempts[].statusstringobrigatório——
attempts[].worker_idanyOf<string | null>opcional——
attempts[].worker_id · variant 1stringopcional——
attempts[].worker_id · variant 2nullopcional——
attempts[].runtime_classanyOf<string | null>opcional——
attempts[].runtime_class · variant 1stringopcional——
attempts[].runtime_class · variant 2nullopcional——
attempts[].regionanyOf<string | null>opcional——
attempts[].region · variant 1stringopcional——
attempts[].region · variant 2nullopcional——
attempts[].engineanyOf<string | null>opcional——
attempts[].engine · variant 1stringopcional——
attempts[].engine · variant 2nullopcional——
attempts[].engine_versionanyOf<string | null>opcional——
attempts[].engine_version · variant 1stringopcional——
attempts[].engine_version · variant 2nullopcional——
attempts[].input_bytesanyOf<integer | null>opcional——
attempts[].input_bytes · variant 1integeropcional——
attempts[].input_bytes · variant 2nullopcional——
attempts[].output_bytesanyOf<integer | null>opcional——
attempts[].output_bytes · variant 1integeropcional——
attempts[].output_bytes · variant 2nullopcional——
attempts[].wall_msanyOf<integer | null>opcional——
attempts[].wall_ms · variant 1integeropcional——
attempts[].wall_ms · variant 2nullopcional——
attempts[].cpu_msanyOf<integer | null>opcional——
attempts[].cpu_ms · variant 1integeropcional——
attempts[].cpu_ms · variant 2nullopcional——
attempts[].peak_memory_mbanyOf<integer | null>opcional——
attempts[].peak_memory_mb · variant 1integeropcional——
attempts[].peak_memory_mb · variant 2nullopcional——
attempts[].temp_bytesanyOf<integer | null>opcional——
attempts[].temp_bytes · variant 1integeropcional——
attempts[].temp_bytes · variant 2nullopcional——
attempts[].error_codeanyOf<string | null>opcional——
attempts[].error_code · variant 1stringopcional——
attempts[].error_code · variant 2nullopcional——
attempts[].error_messageanyOf<string | null>opcional——
attempts[].error_message · variant 1stringopcional——
attempts[].error_message · variant 2nullopcional——
attempts[].estimated_creditsanyOf<string | null>opcional——
attempts[].estimated_credits · variant 1stringopcional——
attempts[].estimated_credits · variant 2nullopcional——
attempts[].settled_creditsanyOf<string | null>opcional——
attempts[].settled_credits · variant 1stringopcional——
attempts[].settled_credits · variant 2nullopcional——
attempts[].external_side_effect_started_atanyOf<string | null>opcional——
attempts[].external_side_effect_started_at · variant 1stringopcional—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullopcional——
attempts[].external_side_effect_committed_atanyOf<string | null>opcional——
attempts[].external_side_effect_committed_at · variant 1stringopcional—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullopcional——
attempts[].started_atstringobrigatório—
format: date-time
attempts[].completed_atanyOf<string | null>opcional——
attempts[].completed_at · variant 1stringopcional—
format: date-time
attempts[].completed_at · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
task_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
job_idstringobrigatório——
namestringobrigatório——
operationstringobrigatório——
statusstringobrigatório——
progressintegerobrigatório——
inputobjectobrigatório——
optionsobjectobrigatório——
resultobjectobrigatório——
requiredbooleanobrigatório——
runtime_classstringobrigatório——
prioritystringobrigatório——
attempt_countintegerobrigatório——
max_attemptsintegerobrigatório——
error_codeanyOf<string | null>opcional——
error_code · variant 1stringopcional——
error_code · variant 2nullopcional——
error_messageanyOf<string | null>opcional——
error_message · variant 1stringopcional——
error_message · variant 2nullopcional——
created_atstringobrigatório—
format: date-time
queued_atanyOf<string | null>opcional——
queued_at · variant 1stringopcional—
format: date-time
queued_at · variant 2nullopcional——
started_atanyOf<string | null>opcional——
started_at · variant 1stringopcional—
format: date-time
started_at · variant 2nullopcional——
completed_atanyOf<string | null>opcional——
completed_at · variant 1stringopcional—
format: date-time
completed_at · variant 2nullopcional——
attemptsobject[]opcional——
attempts[]objectopcional——
attempts[].idstringobrigatório——
attempts[].attempt_numberintegerobrigatório——
attempts[].statusstringobrigatório——
attempts[].worker_idanyOf<string | null>opcional——
attempts[].worker_id · variant 1stringopcional——
attempts[].worker_id · variant 2nullopcional——
attempts[].runtime_classanyOf<string | null>opcional——
attempts[].runtime_class · variant 1stringopcional——
attempts[].runtime_class · variant 2nullopcional——
attempts[].regionanyOf<string | null>opcional——
attempts[].region · variant 1stringopcional——
attempts[].region · variant 2nullopcional——
attempts[].engineanyOf<string | null>opcional——
attempts[].engine · variant 1stringopcional——
attempts[].engine · variant 2nullopcional——
attempts[].engine_versionanyOf<string | null>opcional——
attempts[].engine_version · variant 1stringopcional——
attempts[].engine_version · variant 2nullopcional——
attempts[].input_bytesanyOf<integer | null>opcional——
attempts[].input_bytes · variant 1integeropcional——
attempts[].input_bytes · variant 2nullopcional——
attempts[].output_bytesanyOf<integer | null>opcional——
attempts[].output_bytes · variant 1integeropcional——
attempts[].output_bytes · variant 2nullopcional——
attempts[].wall_msanyOf<integer | null>opcional——
attempts[].wall_ms · variant 1integeropcional——
attempts[].wall_ms · variant 2nullopcional——
attempts[].cpu_msanyOf<integer | null>opcional——
attempts[].cpu_ms · variant 1integeropcional——
attempts[].cpu_ms · variant 2nullopcional——
attempts[].peak_memory_mbanyOf<integer | null>opcional——
attempts[].peak_memory_mb · variant 1integeropcional——
attempts[].peak_memory_mb · variant 2nullopcional——
attempts[].temp_bytesanyOf<integer | null>opcional——
attempts[].temp_bytes · variant 1integeropcional——
attempts[].temp_bytes · variant 2nullopcional——
attempts[].error_codeanyOf<string | null>opcional——
attempts[].error_code · variant 1stringopcional——
attempts[].error_code · variant 2nullopcional——
attempts[].error_messageanyOf<string | null>opcional——
attempts[].error_message · variant 1stringopcional——
attempts[].error_message · variant 2nullopcional——
attempts[].estimated_creditsanyOf<string | null>opcional——
attempts[].estimated_credits · variant 1stringopcional——
attempts[].estimated_credits · variant 2nullopcional——
attempts[].settled_creditsanyOf<string | null>opcional——
attempts[].settled_credits · variant 1stringopcional——
attempts[].settled_credits · variant 2nullopcional——
attempts[].external_side_effect_started_atanyOf<string | null>opcional——
attempts[].external_side_effect_started_at · variant 1stringopcional—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullopcional——
attempts[].external_side_effect_committed_atanyOf<string | null>opcional——
attempts[].external_side_effect_committed_at · variant 1stringopcional—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullopcional——
attempts[].started_atstringobrigatório—
format: date-time
attempts[].completed_atanyOf<string | null>opcional——
attempts[].completed_at · variant 1stringopcional—
format: date-time
attempts[].completed_at · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
task_idpathstringobrigatório—
timeoutqueryintegeropcional
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>opcional—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
bodyunknownobrigatório——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
task_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
job_idstringobrigatório——
namestringobrigatório——
operationstringobrigatório——
statusstringobrigatório——
progressintegerobrigatório——
inputobjectobrigatório——
optionsobjectobrigatório——
resultobjectobrigatório——
requiredbooleanobrigatório——
runtime_classstringobrigatório——
prioritystringobrigatório——
attempt_countintegerobrigatório——
max_attemptsintegerobrigatório——
error_codeanyOf<string | null>opcional——
error_code · variant 1stringopcional——
error_code · variant 2nullopcional——
error_messageanyOf<string | null>opcional——
error_message · variant 1stringopcional——
error_message · variant 2nullopcional——
created_atstringobrigatório—
format: date-time
queued_atanyOf<string | null>opcional——
queued_at · variant 1stringopcional—
format: date-time
queued_at · variant 2nullopcional——
started_atanyOf<string | null>opcional——
started_at · variant 1stringopcional—
format: date-time
started_at · variant 2nullopcional——
completed_atanyOf<string | null>opcional——
completed_at · variant 1stringopcional—
format: date-time
completed_at · variant 2nullopcional——
attemptsobject[]opcional——
attempts[]objectopcional——
attempts[].idstringobrigatório——
attempts[].attempt_numberintegerobrigatório——
attempts[].statusstringobrigatório——
attempts[].worker_idanyOf<string | null>opcional——
attempts[].worker_id · variant 1stringopcional——
attempts[].worker_id · variant 2nullopcional——
attempts[].runtime_classanyOf<string | null>opcional——
attempts[].runtime_class · variant 1stringopcional——
attempts[].runtime_class · variant 2nullopcional——
attempts[].regionanyOf<string | null>opcional——
attempts[].region · variant 1stringopcional——
attempts[].region · variant 2nullopcional——
attempts[].engineanyOf<string | null>opcional——
attempts[].engine · variant 1stringopcional——
attempts[].engine · variant 2nullopcional——
attempts[].engine_versionanyOf<string | null>opcional——
attempts[].engine_version · variant 1stringopcional——
attempts[].engine_version · variant 2nullopcional——
attempts[].input_bytesanyOf<integer | null>opcional——
attempts[].input_bytes · variant 1integeropcional——
attempts[].input_bytes · variant 2nullopcional——
attempts[].output_bytesanyOf<integer | null>opcional——
attempts[].output_bytes · variant 1integeropcional——
attempts[].output_bytes · variant 2nullopcional——
attempts[].wall_msanyOf<integer | null>opcional——
attempts[].wall_ms · variant 1integeropcional——
attempts[].wall_ms · variant 2nullopcional——
attempts[].cpu_msanyOf<integer | null>opcional——
attempts[].cpu_ms · variant 1integeropcional——
attempts[].cpu_ms · variant 2nullopcional——
attempts[].peak_memory_mbanyOf<integer | null>opcional——
attempts[].peak_memory_mb · variant 1integeropcional——
attempts[].peak_memory_mb · variant 2nullopcional——
attempts[].temp_bytesanyOf<integer | null>opcional——
attempts[].temp_bytes · variant 1integeropcional——
attempts[].temp_bytes · variant 2nullopcional——
attempts[].error_codeanyOf<string | null>opcional——
attempts[].error_code · variant 1stringopcional——
attempts[].error_code · variant 2nullopcional——
attempts[].error_messageanyOf<string | null>opcional——
attempts[].error_message · variant 1stringopcional——
attempts[].error_message · variant 2nullopcional——
attempts[].estimated_creditsanyOf<string | null>opcional——
attempts[].estimated_credits · variant 1stringopcional——
attempts[].estimated_credits · variant 2nullopcional——
attempts[].settled_creditsanyOf<string | null>opcional——
attempts[].settled_credits · variant 1stringopcional——
attempts[].settled_credits · variant 2nullopcional——
attempts[].external_side_effect_started_atanyOf<string | null>opcional——
attempts[].external_side_effect_started_at · variant 1stringopcional—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullopcional——
attempts[].external_side_effect_committed_atanyOf<string | null>opcional——
attempts[].external_side_effect_committed_at · variant 1stringopcional—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullopcional——
attempts[].started_atstringobrigatório—
format: date-time
attempts[].completed_atanyOf<string | null>opcional——
attempts[].completed_at · variant 1stringopcional—
format: date-time
attempts[].completed_at · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
limitqueryintegeropcional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcional—
input_formatqueryanyOf<string | null>opcional—
output_formatqueryanyOf<string | null>opcional—
originqueryanyOf<string | null>opcional—
outcomequeryanyOf<string | null>opcional—
job_idqueryanyOf<string | null>opcional—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
dataobject[]obrigatório——
data[]objectopcional——
data[].idstringobrigatório——
data[].api_key_idanyOf<string | null>opcional——
data[].api_key_id · variant 1stringopcional——
data[].api_key_id · variant 2nullopcional——
data[].originstringobrigatório——
data[].outcomestringopcional—
default: "succeeded"
data[].job_idanyOf<string | null>opcional——
data[].job_id · variant 1stringopcional——
data[].job_id · variant 2nullopcional——
data[].task_idanyOf<string | null>opcional——
data[].task_id · variant 1stringopcional——
data[].task_id · variant 2nullopcional——
data[].input_formatanyOf<string | null>opcional——
data[].input_format · variant 1stringopcional——
data[].input_format · variant 2nullopcional——
data[].output_formatanyOf<string | null>opcional——
data[].output_format · variant 1stringopcional——
data[].output_format · variant 2nullopcional——
data[].engineanyOf<string | null>opcional——
data[].engine · variant 1stringopcional——
data[].engine · variant 2nullopcional——
data[].engine_versionanyOf<string | null>opcional——
data[].engine_version · variant 1stringopcional——
data[].engine_version · variant 2nullopcional——
data[].runtime_classanyOf<string | null>opcional——
data[].runtime_class · variant 1stringopcional——
data[].runtime_class · variant 2nullopcional——
data[].input_bytesanyOf<integer | null>opcional——
data[].input_bytes · variant 1integeropcional——
data[].input_bytes · variant 2nullopcional——
data[].output_bytesanyOf<integer | null>opcional——
data[].output_bytes · variant 1integeropcional——
data[].output_bytes · variant 2nullopcional——
data[].wall_msanyOf<integer | null>opcional——
data[].wall_ms · variant 1integeropcional——
data[].wall_ms · variant 2nullopcional——
data[].creditsanyOf<string | null>opcional——
data[].credits · variant 1stringopcional——
data[].credits · variant 2nullopcional——
data[].created_atstringobrigatório—
format: date-time
paginationobjectobrigatório——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
startqueryanyOf<string | null>opcional—
endqueryanyOf<string | null>opcional—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
startstringobrigatório—
format: date-time
endstringobrigatório—
format: date-time
conversionsintegerobrigatório——
creditsstringobrigatório——
input_bytesintegerobrigatório——
output_bytesintegerobrigatório——
wall_msintegerobrigatório——
by_originobject[]opcional——
by_origin[]objectopcional——
by_origin[].keystringobrigatório——
by_origin[].conversionsintegerobrigatório——
by_origin[].creditsstringobrigatório——
top_pairsobject[]opcional——
top_pairs[]objectopcional——
top_pairs[].keystringobrigatório——
top_pairs[].conversionsintegerobrigatório——
top_pairs[].creditsstringobrigatório——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
delivery_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
webhook_idstringobrigatório——
event_idstringobrigatório——
statusstringobrigatório——
attemptintegerobrigatório——
request_headersobjectobrigatório——
request_bodyobjectobrigatório——
response_statusanyOf<integer | null>opcional——
response_status · variant 1integeropcional——
response_status · variant 2nullopcional——
response_bodyanyOf<string | null>opcional——
response_body · variant 1stringopcional——
response_body · variant 2nullopcional——
latency_msanyOf<integer | null>opcional——
latency_ms · variant 1integeropcional——
latency_ms · variant 2nullopcional——
error_messageanyOf<string | null>opcional——
error_message · variant 1stringopcional——
error_message · variant 2nullopcional——
next_retry_atanyOf<string | null>opcional——
next_retry_at · variant 1stringopcional—
format: date-time
next_retry_at · variant 2nullopcional——
delivered_atanyOf<string | null>opcional——
delivered_at · variant 1stringopcional—
format: date-time
delivered_at · variant 2nullopcional——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
delivery_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
webhook_idstringobrigatório——
event_idstringobrigatório——
statusstringobrigatório——
attemptintegerobrigatório——
request_headersobjectobrigatório——
request_bodyobjectobrigatório——
response_statusanyOf<integer | null>opcional——
response_status · variant 1integeropcional——
response_status · variant 2nullopcional——
response_bodyanyOf<string | null>opcional——
response_body · variant 1stringopcional——
response_body · variant 2nullopcional——
latency_msanyOf<integer | null>opcional——
latency_ms · variant 1integeropcional——
latency_ms · variant 2nullopcional——
error_messageanyOf<string | null>opcional——
error_message · variant 1stringopcional——
error_message · variant 2nullopcional——
next_retry_atanyOf<string | null>opcional——
next_retry_at · variant 1stringopcional—
format: date-time
next_retry_at · variant 2nullopcional——
delivered_atanyOf<string | null>opcional——
delivered_at · variant 1stringopcional—
format: date-time
delivered_at · variant 2nullopcional——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
bodyobject[]obrigatório——
items[]objectopcional——
items[].idstringobrigatório——
items[].urlstringobrigatório——
items[].descriptionanyOf<string | null>opcional——
items[].description · variant 1stringopcional——
items[].description · variant 2nullopcional——
items[].event_typesstring[]obrigatório——
items[].enabledbooleanobrigatório——
items[].failure_countintegerobrigatório——
items[].created_atstringobrigatório—
format: date-time
items[].updated_atstringobrigatório—
format: date-time
items[].signing_secretanyOf<string | null>opcional——
items[].signing_secret · variant 1stringopcional——
items[].signing_secret · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
urlstringobrigatório—
min length: 1max length: 2048
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional—
max length: 512
description · variant 2nullopcional——
event_typesstring[]opcional——

Respostas

201Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
urlstringobrigatório——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional——
description · variant 2nullopcional——
event_typesstring[]obrigatório——
enabledbooleanobrigatório——
failure_countintegerobrigatório——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
signing_secretanyOf<string | null>opcional——
signing_secret · variant 1stringopcional——
signing_secret · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
webhook_idpathstringobrigatório—

Respostas

204Successful Response

Sem corpo de resposta.

400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
webhook_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
urlstringobrigatório——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional——
description · variant 2nullopcional——
event_typesstring[]obrigatório——
enabledbooleanobrigatório——
failure_countintegerobrigatório——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
signing_secretanyOf<string | null>opcional——
signing_secret · variant 1stringopcional——
signing_secret · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
webhook_idpathstringobrigatório—

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
urlanyOf<string | null>opcional——
url · variant 1stringopcional—
min length: 1max length: 2048
url · variant 2nullopcional——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional—
max length: 512
description · variant 2nullopcional——
event_typesanyOf<string[] | null>opcional——
event_types · variant 1string[]opcional——
event_types · variant 2nullopcional——
enabledanyOf<boolean | null>opcional——
enabled · variant 1booleanopcional——
enabled · variant 2nullopcional——

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
urlstringobrigatório——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional——
description · variant 2nullopcional——
event_typesstring[]obrigatório——
enabledbooleanobrigatório——
failure_countintegerobrigatório——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
signing_secretanyOf<string | null>opcional——
signing_secret · variant 1stringopcional——
signing_secret · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
webhook_idpathstringobrigatório—
limitqueryintegeropcional
default: 50min: 1max: 100
afterqueryanyOf<string | null>opcional—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
dataobject[]obrigatório——
data[]objectopcional——
data[].idstringobrigatório——
data[].webhook_idstringobrigatório——
data[].event_idstringobrigatório——
data[].statusstringobrigatório——
data[].attemptintegerobrigatório——
data[].request_headersobjectobrigatório——
data[].request_bodyobjectobrigatório——
data[].response_statusanyOf<integer | null>opcional——
data[].response_status · variant 1integeropcional——
data[].response_status · variant 2nullopcional——
data[].response_bodyanyOf<string | null>opcional——
data[].response_body · variant 1stringopcional——
data[].response_body · variant 2nullopcional——
data[].latency_msanyOf<integer | null>opcional——
data[].latency_ms · variant 1integeropcional——
data[].latency_ms · variant 2nullopcional——
data[].error_messageanyOf<string | null>opcional——
data[].error_message · variant 1stringopcional——
data[].error_message · variant 2nullopcional——
data[].next_retry_atanyOf<string | null>opcional——
data[].next_retry_at · variant 1stringopcional—
format: date-time
data[].next_retry_at · variant 2nullopcional——
data[].delivered_atanyOf<string | null>opcional——
data[].delivered_at · variant 1stringopcional—
format: date-time
data[].delivered_at · variant 2nullopcional——
data[].created_atstringobrigatório—
format: date-time
data[].updated_atstringobrigatório—
format: date-time
paginationobjectobrigatório——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
webhook_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
signing_secretstringobrigatório——
previous_secret_valid_untilanyOf<string | null>opcional——
previous_secret_valid_until · variant 1stringopcional—
format: date-time
previous_secret_valid_until · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
limitqueryintegeropcional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcional—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
dataobject[]obrigatório——
data[]objectopcional——
data[].idstringobrigatório——
data[].namestringobrigatório——
data[].descriptionanyOf<string | null>opcional——
data[].description · variant 1stringopcional——
data[].description · variant 2nullopcional——
data[].current_versionintegerobrigatório——
data[].definitionobjectobrigatório——
data[].variables_schemaobjectobrigatório——
data[].metadataobjectobrigatório——
data[].created_atstringobrigatório—
format: date-time
data[].updated_atstringobrigatório—
format: date-time
paginationobjectobrigatório——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
namestringobrigatório—
min length: 1max length: 255
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional—
max length: 2000
description · variant 2nullopcional——
definitionobjectobrigatório——
definition.tasksobjectobrigatório——
definition.taganyOf<string | null>opcional——
definition.tag · variant 1stringopcional—
max length: 255
definition.tag · variant 2nullopcional——
definition.client_reference_idanyOf<string | null>opcional——
definition.client_reference_id · variant 1stringopcional—
max length: 255
definition.client_reference_id · variant 2nullopcional——
definition.metadataobjectopcional——
definition.prioritystringopcional—
enum: "low", "normal", "high"default: "normal"
definition.retention_secondsanyOf<integer | null>opcional——
definition.retention_seconds · variant 1integeropcional—
min: 0max: 86400
definition.retention_seconds · variant 2nullopcional——
variables_schemaobjectopcional——
metadataobjectopcional——

Respostas

201Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
namestringobrigatório——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional——
description · variant 2nullopcional——
current_versionintegerobrigatório——
definitionobjectobrigatório——
variables_schemaobjectobrigatório——
metadataobjectobrigatório——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
workflow_idpathstringobrigatório—

Respostas

204Successful Response

Sem corpo de resposta.

400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
workflow_idpathstringobrigatório—

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
namestringobrigatório——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional——
description · variant 2nullopcional——
current_versionintegerobrigatório——
definitionobjectobrigatório——
variables_schemaobjectobrigatório——
metadataobjectobrigatório——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
workflow_idpathstringobrigatório—

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
nameanyOf<string | null>opcional——
name · variant 1stringopcional—
min length: 1max length: 255
name · variant 2nullopcional——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional—
max length: 2000
description · variant 2nullopcional——
definitionanyOf<object | null>opcional——
definition · variant 1objectopcional——
definition · variant 1.tasksobjectobrigatório——
definition · variant 1.taganyOf<string | null>opcional——
definition · variant 1.tag · variant 1stringopcional—
max length: 255
definition · variant 1.tag · variant 2nullopcional——
definition · variant 1.client_reference_idanyOf<string | null>opcional——
definition · variant 1.client_reference_id · variant 1stringopcional—
max length: 255
definition · variant 1.client_reference_id · variant 2nullopcional——
definition · variant 1.metadataobjectopcional——
definition · variant 1.prioritystringopcional—
enum: "low", "normal", "high"default: "normal"
definition · variant 1.retention_secondsanyOf<integer | null>opcional——
definition · variant 1.retention_seconds · variant 1integeropcional—
min: 0max: 86400
definition · variant 1.retention_seconds · variant 2nullopcional——
definition · variant 2nullopcional——
variables_schemaanyOf<object | null>opcional——
variables_schema · variant 1objectopcional——
variables_schema · variant 2nullopcional——
metadataanyOf<object | null>opcional——
metadata · variant 1objectopcional——
metadata · variant 2nullopcional——

Respostas

200Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
namestringobrigatório——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional——
description · variant 2nullopcional——
current_versionintegerobrigatório——
definitionobjectobrigatório——
variables_schemaobjectobrigatório——
metadataobjectobrigatório——
created_atstringobrigatório—
format: date-time
updated_atstringobrigatório—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
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.

Autenticação
ConverterHQBearerhttp / bearer

Parâmetros

NomeLocalizaçãoTipoObrigatórioDescrição / restrições
workflow_idpathstringobrigatório—
Idempotency-KeyheaderanyOf<string | null>opcional—

Corpo do pedido obrigatório

application/json
CampoTipoObrigatórioDescriçãoRestrições
variablesobjectopcional——
client_reference_idanyOf<string | null>opcional——
client_reference_id · variant 1stringopcional—
max length: 255
client_reference_id · variant 2nullopcional——
metadataobjectopcional——

Respostas

201Successful Response
application/json
CampoTipoObrigatórioDescriçãoRestrições
idstringobrigatório——
kindstringobrigatório——
statusstringobrigatório——
progressintegerobrigatório——
taganyOf<string | null>opcional——
tag · variant 1stringopcional——
tag · variant 2nullopcional——
client_reference_idanyOf<string | null>opcional——
client_reference_id · variant 1stringopcional——
client_reference_id · variant 2nullopcional——
metadataobjectopcional——
prioritystringobrigatório——
concurrency_limitintegeropcional—
default: 1
originstringobrigatório——
created_atstringobrigatório—
format: date-time
started_atanyOf<string | null>opcional——
started_at · variant 1stringopcional—
format: date-time
started_at · variant 2nullopcional——
completed_atanyOf<string | null>opcional——
completed_at · variant 1stringopcional—
format: date-time
completed_at · variant 2nullopcional——
error_codeanyOf<string | null>opcional——
error_code · variant 1stringopcional——
error_code · variant 2nullopcional——
error_messageanyOf<string | null>opcional——
error_message · variant 1stringopcional——
error_message · variant 2nullopcional——
tasksobject[]opcional——
tasks[]objectopcional——
tasks[].idstringobrigatório——
tasks[].job_idstringobrigatório——
tasks[].namestringobrigatório——
tasks[].operationstringobrigatório——
tasks[].statusstringobrigatório——
tasks[].progressintegerobrigatório——
tasks[].inputobjectobrigatório——
tasks[].optionsobjectobrigatório——
tasks[].resultobjectobrigatório——
tasks[].requiredbooleanobrigatório——
tasks[].runtime_classstringobrigatório——
tasks[].prioritystringobrigatório——
tasks[].attempt_countintegerobrigatório——
tasks[].max_attemptsintegerobrigatório——
tasks[].error_codeanyOf<string | null>opcional——
tasks[].error_code · variant 1stringopcional——
tasks[].error_code · variant 2nullopcional——
tasks[].error_messageanyOf<string | null>opcional——
tasks[].error_message · variant 1stringopcional——
tasks[].error_message · variant 2nullopcional——
tasks[].created_atstringobrigatório—
format: date-time
tasks[].queued_atanyOf<string | null>opcional——
tasks[].queued_at · variant 1stringopcional—
format: date-time
tasks[].queued_at · variant 2nullopcional——
tasks[].started_atanyOf<string | null>opcional——
tasks[].started_at · variant 1stringopcional—
format: date-time
tasks[].started_at · variant 2nullopcional——
tasks[].completed_atanyOf<string | null>opcional——
tasks[].completed_at · variant 1stringopcional—
format: date-time
tasks[].completed_at · variant 2nullopcional——
tasks[].attemptsobject[]opcional——
tasks[].attempts[]objectopcional——
tasks[].attempts[].idstringobrigatório——
tasks[].attempts[].attempt_numberintegerobrigatório——
tasks[].attempts[].statusstringobrigatório——
tasks[].attempts[].worker_idanyOf<string | null>opcional——
tasks[].attempts[].worker_id · variant 1stringopcional——
tasks[].attempts[].worker_id · variant 2nullopcional——
tasks[].attempts[].runtime_classanyOf<string | null>opcional——
tasks[].attempts[].runtime_class · variant 1stringopcional——
tasks[].attempts[].runtime_class · variant 2nullopcional——
tasks[].attempts[].regionanyOf<string | null>opcional——
tasks[].attempts[].region · variant 1stringopcional——
tasks[].attempts[].region · variant 2nullopcional——
tasks[].attempts[].engineanyOf<string | null>opcional——
tasks[].attempts[].engine · variant 1stringopcional——
tasks[].attempts[].engine · variant 2nullopcional——
tasks[].attempts[].engine_versionanyOf<string | null>opcional——
tasks[].attempts[].engine_version · variant 1stringopcional——
tasks[].attempts[].engine_version · variant 2nullopcional——
tasks[].attempts[].input_bytesanyOf<integer | null>opcional——
tasks[].attempts[].input_bytes · variant 1integeropcional——
tasks[].attempts[].input_bytes · variant 2nullopcional——
tasks[].attempts[].output_bytesanyOf<integer | null>opcional——
tasks[].attempts[].output_bytes · variant 1integeropcional——
tasks[].attempts[].output_bytes · variant 2nullopcional——
tasks[].attempts[].wall_msanyOf<integer | null>opcional——
tasks[].attempts[].wall_ms · variant 1integeropcional——
tasks[].attempts[].wall_ms · variant 2nullopcional——
tasks[].attempts[].cpu_msanyOf<integer | null>opcional——
tasks[].attempts[].cpu_ms · variant 1integeropcional——
tasks[].attempts[].cpu_ms · variant 2nullopcional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcional——
tasks[].attempts[].peak_memory_mb · variant 1integeropcional——
tasks[].attempts[].peak_memory_mb · variant 2nullopcional——
tasks[].attempts[].temp_bytesanyOf<integer | null>opcional——
tasks[].attempts[].temp_bytes · variant 1integeropcional——
tasks[].attempts[].temp_bytes · variant 2nullopcional——
tasks[].attempts[].error_codeanyOf<string | null>opcional——
tasks[].attempts[].error_code · variant 1stringopcional——
tasks[].attempts[].error_code · variant 2nullopcional——
tasks[].attempts[].error_messageanyOf<string | null>opcional——
tasks[].attempts[].error_message · variant 1stringopcional——
tasks[].attempts[].error_message · variant 2nullopcional——
tasks[].attempts[].estimated_creditsanyOf<string | null>opcional——
tasks[].attempts[].estimated_credits · variant 1stringopcional——
tasks[].attempts[].estimated_credits · variant 2nullopcional——
tasks[].attempts[].settled_creditsanyOf<string | null>opcional——
tasks[].attempts[].settled_credits · variant 1stringopcional——
tasks[].attempts[].settled_credits · variant 2nullopcional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopcional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcional——
tasks[].attempts[].started_atstringobrigatório—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opcional——
tasks[].attempts[].completed_at · variant 1stringopcional—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
422Validation Error
application/json
CampoTipoObrigatórioDescriçãoRestrições
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obrigatório——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobrigatório——
detail[].typestringobrigatório——
429The caller has exceeded an admission-control limit.
Cabeçalhos de respostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
500An unexpected server error occurred.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObrigatórioDescriçãoRestrições
typestringobrigatório—
default: "about:blank"
titlestringobrigatório——
statusintegerobrigatório—
min: 400max: 599
codestringobrigatório——
detailstringobrigatório——
retryablebooleanobrigatório——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——