ConverterHQDevelopers
Generado desde el contrato OpenAPI público seleccionado

Referencia de la API REST

Examine parámetros, autenticación, campos anidados, esquemas de respuesta, errores y ejemplos ejecutables. Se excluyen las rutas de usuarios finales, SEO y administración.

74 endpoints mostrados74 operaciones en 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.

AutenticaciónPúblico / sin autenticación específica de la operación

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
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—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
dataobject[]obligatorio——
data[]objectopcional——
data[].supportedbooleanobligatorio——
data[].input_formatstringobligatorio——
data[].output_formatstringobligatorio——
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[].namestringobligatorio——
data[].options[].typestringobligatorio——
data[].options[].labelstringobligatorio——
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——
paginationobjectobligatorio——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

AutenticaciónPúblico / sin autenticación específica de la operación

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
from_formatpathstringobligatorio—
to_formatpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
supportedbooleanobligatorio——
input_formatstringobligatorio——
output_formatstringobligatorio——
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[].namestringobligatorio——
options[].typestringobligatorio——
options[].labelstringobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
account_idstringobligatorio——
productstringobligatorio——
api_enabledbooleanobligatorio——
plansstring[]obligatorio——
effective_planobjectobligatorio——
effective_plan.codestringobligatorio——
effective_plan.namestringobligatorio——
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——
creditsobjectobligatorio——
credits.availablestringobligatorio——
credits.reservedstringobligatorio——
credits.debtstringobligatorio——
quotaanyOf<object | null>opcional——
quota · variant 1objectopcional——
quota · variant 1.keystringobligatorio——
quota · variant 1.periodstringobligatorio——
quota · variant 1.period_keystringobligatorio——
quota · variant 1.limitstringobligatorio——
quota · variant 1.usedstringobligatorio——
quota · variant 1.remainingstringobligatorio——
quota · variant 1.period_startstringobligatorio—
format: date-time
quota · variant 1.period_endstringobligatorio—
format: date-time
quota · variant 2nullopcional——
subscriptionsobject[]obligatorio——
subscriptions[]objectopcional——
subscriptions[].idstringobligatorio——
subscriptions[].planstringobligatorio——
subscriptions[].statusstringobligatorio——
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[]obligatorio——
passes[]objectopcional——
passes[].idstringobligatorio——
passes[].offerstringobligatorio——
passes[].planstringobligatorio——
passes[].starts_atstringobligatorio—
format: date-time
passes[].expires_atstringobligatorio—
format: date-time
generated_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
limitqueryintegeropcional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcional—
providerqueryanyOf<string | null>opcional—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
dataobject[]obligatorio——
data[]objectopcional——
data[].idstringobligatorio——
data[].namestringobligatorio——
data[].providerstringobligatorio—
enum: "s3", "gcs", "azure", "sftp"
data[].config_summaryobjectobligatorio——
data[].enabledbooleanobligatorio——
data[].created_atstringobligatorio—
format: date-time
data[].updated_atstringobligatorio—
format: date-time
paginationobjectobligatorio——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
namestringobligatorio—
min length: 1max length: 255
providerstringobligatorio—
enum: "s3", "gcs", "azure", "sftp"
configobjectobligatorio——

Respuestas

201Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
namestringobligatorio——
providerstringobligatorio—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectobligatorio——
enabledbooleanobligatorio——
created_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
connection_idpathstringobligatorio—

Respuestas

204Successful Response

Sin cuerpo de respuesta.

400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
connection_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
namestringobligatorio——
providerstringobligatorio—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectobligatorio——
enabledbooleanobligatorio——
created_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
connection_idpathstringobligatorio—

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
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——

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
namestringobligatorio——
providerstringobligatorio—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectobligatorio——
enabledbooleanobligatorio——
created_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
connection_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
okbooleanobligatorio——
providerstringobligatorio——
detailsobjectopcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
PreferheaderanyOf<string | null>opcional—
Idempotency-KeyheaderanyOf<string | null>opcional—

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
inputobjectobligatorio——
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_formatstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
filestringobligatorioInput file, up to 4 MiB.
format: binary
input_formatstringopcionalOptional source format when it cannot be detected.—
output_formatstringobligatorioRequired 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

Respuestas

200Conversion completed within the requested wait window.
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
job_idstringobligatorio——
statusstringobligatorio——
progressintegerobligatorio——
input_formatanyOf<string | null>opcional——
input_format · variant 1stringopcional——
input_format · variant 2nullopcional——
output_formatstringobligatorio——
output_fileanyOf<object | null>opcional——
output_file · variant 1objectopcional——
output_file · variant 1.idstringobligatorio——
output_file · variant 1.statusstringobligatorio——
output_file · variant 1.rolestringobligatorio——
output_file · variant 1.filenamestringobligatorio——
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_typestringobligatorio——
output_file · variant 1.created_atstringobligatorio—
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.urlstringobligatorio——
output_file · variant 1.upload · variant 1.expires_atstringobligatorio—
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_atstringobligatorio—
format: date-time
202Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
job_idstringobligatorio——
statusstringobligatorio——
progressintegerobligatorio——
input_formatanyOf<string | null>opcional——
input_format · variant 1stringopcional——
input_format · variant 2nullopcional——
output_formatstringobligatorio——
output_fileanyOf<object | null>opcional——
output_file · variant 1objectopcional——
output_file · variant 1.idstringobligatorio——
output_file · variant 1.statusstringobligatorio——
output_file · variant 1.rolestringobligatorio——
output_file · variant 1.filenamestringobligatorio——
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_typestringobligatorio——
output_file · variant 1.created_atstringobligatorio—
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.urlstringobligatorio——
output_file · variant 1.upload · variant 1.expires_atstringobligatorio—
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_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
from_formatpathstringobligatorio—
to_formatpathstringobligatorio—
PreferheaderanyOf<string | null>opcional—
Idempotency-KeyheaderanyOf<string | null>opcional—

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
inputobjectobligatorio——
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_formatstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
filestringobligatorioInput 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

Respuestas

200Conversion completed within the requested wait window.
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
job_idstringobligatorio——
statusstringobligatorio——
progressintegerobligatorio——
input_formatanyOf<string | null>opcional——
input_format · variant 1stringopcional——
input_format · variant 2nullopcional——
output_formatstringobligatorio——
output_fileanyOf<object | null>opcional——
output_file · variant 1objectopcional——
output_file · variant 1.idstringobligatorio——
output_file · variant 1.statusstringobligatorio——
output_file · variant 1.rolestringobligatorio——
output_file · variant 1.filenamestringobligatorio——
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_typestringobligatorio——
output_file · variant 1.created_atstringobligatorio—
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.urlstringobligatorio——
output_file · variant 1.upload · variant 1.expires_atstringobligatorio—
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_atstringobligatorio—
format: date-time
202Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
job_idstringobligatorio——
statusstringobligatorio——
progressintegerobligatorio——
input_formatanyOf<string | null>opcional——
input_format · variant 1stringopcional——
input_format · variant 2nullopcional——
output_formatstringobligatorio——
output_fileanyOf<object | null>opcional——
output_file · variant 1objectopcional——
output_file · variant 1.idstringobligatorio——
output_file · variant 1.statusstringobligatorio——
output_file · variant 1.rolestringobligatorio——
output_file · variant 1.filenamestringobligatorio——
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_typestringobligatorio——
output_file · variant 1.created_atstringobligatorio—
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.urlstringobligatorio——
output_file · variant 1.upload · variant 1.expires_atstringobligatorio—
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_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
input_formatstringobligatorio——
output_formatstringobligatorio——
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——

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
supportedbooleanobligatorio——
recommended_modestringobligatorio—
enum: "sync", "async"
creditsobjectobligatorio——
warningsstring[]opcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

AutenticaciónPúblico / sin autenticación específica de la operación

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
dataobject[]obligatorio——
data[]objectopcional——
data[].typestringobligatorio——
data[].descriptionstringobligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
limitqueryintegeropcional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcional—
statusqueryanyOf<string | null>opcional—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
dataobject[]obligatorio——
data[]objectopcional——
data[].idstringobligatorio——
data[].statusstringobligatorio——
data[].rolestringobligatorio——
data[].filenamestringobligatorio——
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_typestringobligatorio——
data[].created_atstringobligatorio—
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.urlstringobligatorio——
data[].upload · variant 1.expires_atstringobligatorio—
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——
paginationobjectobligatorio——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
filenamestringobligatorio—
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——

Respuestas

201Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
statusstringobligatorio——
rolestringobligatorio——
filenamestringobligatorio——
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_typestringobligatorio——
created_atstringobligatorio—
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.urlstringobligatorio——
upload · variant 1.expires_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
file_idpathstringobligatorio—

Respuestas

204Successful Response

Sin cuerpo de respuesta.

400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
file_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
statusstringobligatorio——
rolestringobligatorio——
filenamestringobligatorio——
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_typestringobligatorio——
created_atstringobligatorio—
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.urlstringobligatorio——
upload · variant 1.expires_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
file_idpathstringobligatorio—

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
checksum_sha256anyOf<string | null>opcional——
checksum_sha256 · variant 1stringopcional—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullopcional——

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
statusstringobligatorio——
rolestringobligatorio——
filenamestringobligatorio——
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_typestringobligatorio——
created_atstringobligatorio—
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.urlstringobligatorio——
upload · variant 1.expires_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
file_idpathstringobligatorio—

Respuestas

204Successful Response

Sin cuerpo de respuesta.

400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
file_idpathstringobligatorio—

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
part_sizeanyOf<integer | null>opcional——
part_size · variant 1integeropcional—
min: 5242880max: 5368709120
part_size · variant 2nullopcional——

Respuestas

201Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
file_idstringobligatorio——
upload_idstringobligatorio——
part_sizeintegerobligatorio——
max_partsintegeropcional—
default: 10000
expires_atstringobligatorio—
format: date-time
partsobject[]opcional——
parts[]objectopcional——
parts[].part_numberintegerobligatorio——
parts[].urlstringobligatorio——
parts[].expires_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
file_idpathstringobligatorio—

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
partsobject[]obligatorio—
min items: 1max items: 10000
parts[]objectopcional——
parts[].part_numberintegerobligatorio—
min: 1max: 10000
parts[].etagstringobligatorio—
min length: 1max length: 512
checksum_sha256anyOf<string | null>opcional——
checksum_sha256 · variant 1stringopcional—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullopcional——

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
statusstringobligatorio——
rolestringobligatorio——
filenamestringobligatorio——
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_typestringobligatorio——
created_atstringobligatorio—
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.urlstringobligatorio——
upload · variant 1.expires_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
file_idpathstringobligatorio—

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
part_numbersinteger[]obligatorio—
min items: 1max items: 1000

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
file_idstringobligatorio——
upload_idstringobligatorio——
part_sizeintegerobligatorio——
max_partsintegeropcional—
default: 10000
expires_atstringobligatorio—
format: date-time
partsobject[]opcional——
parts[]objectopcional——
parts[].part_numberintegerobligatorio——
parts[].urlstringobligatorio——
parts[].expires_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

AutenticaciónPúblico / sin autenticación específica de la operación

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
limitqueryintegeropcional
default: 500min: 1max: 500

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
dataobject[]obligatorio——
data[]objectopcional——
data[].slugstringobligatorio——
data[].labelstringobligatorio——
data[].categorystringobligatorio——
data[].mime_typesstring[]obligatorio——
data[].extensionsstring[]obligatorio——
paginationobjectobligatorio——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

AutenticaciónPúblico / sin autenticación específica de la operación

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
slugpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
slugstringobligatorio——
labelstringobligatorio——
categorystringobligatorio——
mime_typesstring[]obligatorio——
extensionsstring[]obligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

AutenticaciónPúblico / sin autenticación específica de la operación

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
slugpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
dataobject[]obligatorio——
data[]objectopcional——
data[].slugstringobligatorio——
data[].labelstringobligatorio——
data[].categorystringobligatorio——
data[].mime_typesstring[]obligatorio——
data[].extensionsstring[]obligatorio——
paginationobjectobligatorio——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

AutenticaciónPúblico / sin autenticación específica de la operación

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
slugpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
dataobject[]obligatorio——
data[]objectopcional——
data[].slugstringobligatorio——
data[].labelstringobligatorio——
data[].categorystringobligatorio——
data[].mime_typesstring[]obligatorio——
data[].extensionsstring[]obligatorio——
paginationobjectobligatorio——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
limitqueryintegeropcional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcional—
statusqueryanyOf<string | null>opcional—
tagqueryanyOf<string | null>opcional—
originqueryanyOf<string | null>opcional—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
dataobject[]obligatorio——
data[]objectopcional——
data[].idstringobligatorio——
data[].kindstringobligatorio——
data[].statusstringobligatorio——
data[].progressintegerobligatorio——
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[].prioritystringobligatorio——
data[].concurrency_limitintegeropcional—
default: 1
data[].originstringobligatorio——
data[].created_atstringobligatorio—
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[].idstringobligatorio——
data[].tasks[].job_idstringobligatorio——
data[].tasks[].namestringobligatorio——
data[].tasks[].operationstringobligatorio——
data[].tasks[].statusstringobligatorio——
data[].tasks[].progressintegerobligatorio——
data[].tasks[].inputobjectobligatorio——
data[].tasks[].optionsobjectobligatorio——
data[].tasks[].resultobjectobligatorio——
data[].tasks[].requiredbooleanobligatorio——
data[].tasks[].runtime_classstringobligatorio——
data[].tasks[].prioritystringobligatorio——
data[].tasks[].attempt_countintegerobligatorio——
data[].tasks[].max_attemptsintegerobligatorio——
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_atstringobligatorio—
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[].idstringobligatorio——
data[].tasks[].attempts[].attempt_numberintegerobligatorio——
data[].tasks[].attempts[].statusstringobligatorio——
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_atstringobligatorio—
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——
paginationobjectobligatorio——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
Idempotency-KeyheaderanyOf<string | null>opcional—

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
tasksobjectobligatorio——
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——

Respuestas

201Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
kindstringobligatorio——
statusstringobligatorio——
progressintegerobligatorio——
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——
prioritystringobligatorio——
concurrency_limitintegeropcional—
default: 1
originstringobligatorio——
created_atstringobligatorio—
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[].idstringobligatorio——
tasks[].job_idstringobligatorio——
tasks[].namestringobligatorio——
tasks[].operationstringobligatorio——
tasks[].statusstringobligatorio——
tasks[].progressintegerobligatorio——
tasks[].inputobjectobligatorio——
tasks[].optionsobjectobligatorio——
tasks[].resultobjectobligatorio——
tasks[].requiredbooleanobligatorio——
tasks[].runtime_classstringobligatorio——
tasks[].prioritystringobligatorio——
tasks[].attempt_countintegerobligatorio——
tasks[].max_attemptsintegerobligatorio——
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_atstringobligatorio—
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[].idstringobligatorio——
tasks[].attempts[].attempt_numberintegerobligatorio——
tasks[].attempts[].statusstringobligatorio——
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_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
job_idpathstringobligatorio—
include_attemptsquerybooleanopcional
default: false

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
kindstringobligatorio——
statusstringobligatorio——
progressintegerobligatorio——
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——
prioritystringobligatorio——
concurrency_limitintegeropcional—
default: 1
originstringobligatorio——
created_atstringobligatorio—
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[].idstringobligatorio——
tasks[].job_idstringobligatorio——
tasks[].namestringobligatorio——
tasks[].operationstringobligatorio——
tasks[].statusstringobligatorio——
tasks[].progressintegerobligatorio——
tasks[].inputobjectobligatorio——
tasks[].optionsobjectobligatorio——
tasks[].resultobjectobligatorio——
tasks[].requiredbooleanobligatorio——
tasks[].runtime_classstringobligatorio——
tasks[].prioritystringobligatorio——
tasks[].attempt_countintegerobligatorio——
tasks[].max_attemptsintegerobligatorio——
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_atstringobligatorio—
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[].idstringobligatorio——
tasks[].attempts[].attempt_numberintegerobligatorio——
tasks[].attempts[].statusstringobligatorio——
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_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
job_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
kindstringobligatorio——
statusstringobligatorio——
progressintegerobligatorio——
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——
prioritystringobligatorio——
concurrency_limitintegeropcional—
default: 1
originstringobligatorio——
created_atstringobligatorio—
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[].idstringobligatorio——
tasks[].job_idstringobligatorio——
tasks[].namestringobligatorio——
tasks[].operationstringobligatorio——
tasks[].statusstringobligatorio——
tasks[].progressintegerobligatorio——
tasks[].inputobjectobligatorio——
tasks[].optionsobjectobligatorio——
tasks[].resultobjectobligatorio——
tasks[].requiredbooleanobligatorio——
tasks[].runtime_classstringobligatorio——
tasks[].prioritystringobligatorio——
tasks[].attempt_countintegerobligatorio——
tasks[].max_attemptsintegerobligatorio——
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_atstringobligatorio—
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[].idstringobligatorio——
tasks[].attempts[].attempt_numberintegerobligatorio——
tasks[].attempts[].statusstringobligatorio——
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_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
job_idpathstringobligatorio—
timeoutqueryintegeropcional
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>opcional—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
bodyunknownobligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
job_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
kindstringobligatorio——
statusstringobligatorio——
progressintegerobligatorio——
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——
prioritystringobligatorio——
concurrency_limitintegeropcional—
default: 1
originstringobligatorio——
created_atstringobligatorio—
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[].idstringobligatorio——
tasks[].job_idstringobligatorio——
tasks[].namestringobligatorio——
tasks[].operationstringobligatorio——
tasks[].statusstringobligatorio——
tasks[].progressintegerobligatorio——
tasks[].inputobjectobligatorio——
tasks[].optionsobjectobligatorio——
tasks[].resultobjectobligatorio——
tasks[].requiredbooleanobligatorio——
tasks[].runtime_classstringobligatorio——
tasks[].prioritystringobligatorio——
tasks[].attempt_countintegerobligatorio——
tasks[].max_attemptsintegerobligatorio——
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_atstringobligatorio—
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[].idstringobligatorio——
tasks[].attempts[].attempt_numberintegerobligatorio——
tasks[].attempts[].statusstringobligatorio——
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_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
job_idpathstringobligatorio—
timeoutqueryintegeropcional
default: 20min: 0max: 30

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
kindstringobligatorio——
statusstringobligatorio——
progressintegerobligatorio——
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——
prioritystringobligatorio——
concurrency_limitintegeropcional—
default: 1
originstringobligatorio——
created_atstringobligatorio—
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[].idstringobligatorio——
tasks[].job_idstringobligatorio——
tasks[].namestringobligatorio——
tasks[].operationstringobligatorio——
tasks[].statusstringobligatorio——
tasks[].progressintegerobligatorio——
tasks[].inputobjectobligatorio——
tasks[].optionsobjectobligatorio——
tasks[].resultobjectobligatorio——
tasks[].requiredbooleanobligatorio——
tasks[].runtime_classstringobligatorio——
tasks[].prioritystringobligatorio——
tasks[].attempt_countintegerobligatorio——
tasks[].max_attemptsintegerobligatorio——
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_atstringobligatorio—
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[].idstringobligatorio——
tasks[].attempts[].attempt_numberintegerobligatorio——
tasks[].attempts[].statusstringobligatorio——
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_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
tasksobjectobligatorio——
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——

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
validbooleanobligatorio——
task_countintegerobligatorio——
execution_orderstring[]obligatorio——
root_tasksstring[]obligatorio——
warningsstring[]opcional——
estimated_creditsanyOf<object | null>opcional——
estimated_credits · variant 1objectopcional——
estimated_credits · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
limitqueryintegeropcional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcional—
status_codequeryanyOf<integer | null>opcional—
path_prefixqueryanyOf<string | null>opcional—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
dataobject[]obligatorio——
data[]objectopcional——
data[].request_idstringobligatorio——
data[].methodstringobligatorio——
data[].pathstringobligatorio——
data[].status_codeintegerobligatorio——
data[].latency_msintegerobligatorio——
data[].api_key_idanyOf<string | null>opcional——
data[].api_key_id · variant 1stringopcional——
data[].api_key_id · variant 2nullopcional——
data[].auth_typestringobligatorio——
data[].user_agentanyOf<string | null>opcional——
data[].user_agent · variant 1stringopcional——
data[].user_agent · variant 2nullopcional——
data[].created_atstringobligatorio——
paginationobjectobligatorio——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
request_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
request_idstringobligatorio——
methodstringobligatorio——
pathstringobligatorio——
status_codeintegerobligatorio——
latency_msintegerobligatorio——
api_key_idanyOf<string | null>opcional——
api_key_id · variant 1stringopcional——
api_key_id · variant 2nullopcional——
auth_typestringobligatorio——
user_agentanyOf<string | null>opcional——
user_agent · variant 1stringopcional——
user_agent · variant 2nullopcional——
created_atstringobligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
account_idstringobligatorio——
actor_idstringobligatorio——
auth_typestringobligatorio——
environmentstringobligatorio——
access_tierstringopcional—
enum: "sandbox", "paid"default: "paid"
scopesstring[]obligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

AutenticaciónPúblico / sin autenticación específica de la operación

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
dataobject[]obligatorio——
data[]objectopcional——
data[].operationstringobligatorio——
data[].categorystringobligatorio—
enum: "import", "processing", "export"
data[].descriptionstringobligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
account_idstringobligatorio——
environmentstringobligatorio——
scopedbooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
bodyobjectobligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
confirm_project_idstringobligatorio—
min length: 1max length: 64

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
bodyobjectobligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
tokenstringobligatorio——
expires_atstringobligatorio—
format: date-time
websocket_urlstringobligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
bodyobjectobligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
fixture_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
bodyobjectobligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
bodyobject[]obligatorio——
items[]objectopcional——
items[].idstringobligatorio——
items[].namestringobligatorio——
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_schemaobjectobligatorio——
items[].allowed_source_hostsstring[]obligatorio——
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_countintegerobligatorio——
items[].cache_ttl_secondsintegerobligatorio——
items[].enabledbooleanobligatorio——
items[].created_atstringobligatorio—
format: date-time
items[].updated_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
namestringobligatorio—
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.tasksobjectobligatorio——
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

Respuestas

201Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
namestringobligatorio——
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_schemaobjectobligatorio——
allowed_source_hostsstring[]obligatorio——
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_countintegerobligatorio——
cache_ttl_secondsintegerobligatorio——
enabledbooleanobligatorio——
created_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
base_idpathstringobligatorio—

Respuestas

204Successful Response

Sin cuerpo de respuesta.

400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
base_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
namestringobligatorio——
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_schemaobjectobligatorio——
allowed_source_hostsstring[]obligatorio——
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_countintegerobligatorio——
cache_ttl_secondsintegerobligatorio——
enabledbooleanobligatorio——
created_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
base_idpathstringobligatorio—

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
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.tasksobjectobligatorio——
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——

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
namestringobligatorio——
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_schemaobjectobligatorio——
allowed_source_hostsstring[]obligatorio——
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_countintegerobligatorio——
cache_ttl_secondsintegerobligatorio——
enabledbooleanobligatorio——
created_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
base_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
namestringobligatorio——
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_schemaobjectobligatorio——
allowed_source_hostsstring[]obligatorio——
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_countintegerobligatorio——
cache_ttl_secondsintegerobligatorio——
enabledbooleanobligatorio——
created_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
base_idpathstringobligatorio—

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
variablesobjectopcional——
expires_inintegeropcional—
default: 3600min: 60max: 86400
cache_keyanyOf<string | null>opcional——
cache_key · variant 1stringopcional—
max length: 255
cache_key · variant 2nullopcional——

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
urlstringobligatorio——
expires_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

AutenticaciónPúblico / sin autenticación específica de la operación

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
statusstringobligatorio—
enum: "ok", "degraded"
servicestringopcional—
default: "converterhq-api"
api_versionstringopcional—
default: "v1"
timestampstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

AutenticaciónPúblico / sin autenticación específica de la operación

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
successful_conversionsintegerobligatorio——
input_bytes_processedintegerobligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
task_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
job_idstringobligatorio——
namestringobligatorio——
operationstringobligatorio——
statusstringobligatorio——
progressintegerobligatorio——
inputobjectobligatorio——
optionsobjectobligatorio——
resultobjectobligatorio——
requiredbooleanobligatorio——
runtime_classstringobligatorio——
prioritystringobligatorio——
attempt_countintegerobligatorio——
max_attemptsintegerobligatorio——
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_atstringobligatorio—
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[].idstringobligatorio——
attempts[].attempt_numberintegerobligatorio——
attempts[].statusstringobligatorio——
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_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
task_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
job_idstringobligatorio——
namestringobligatorio——
operationstringobligatorio——
statusstringobligatorio——
progressintegerobligatorio——
inputobjectobligatorio——
optionsobjectobligatorio——
resultobjectobligatorio——
requiredbooleanobligatorio——
runtime_classstringobligatorio——
prioritystringobligatorio——
attempt_countintegerobligatorio——
max_attemptsintegerobligatorio——
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_atstringobligatorio—
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[].idstringobligatorio——
attempts[].attempt_numberintegerobligatorio——
attempts[].statusstringobligatorio——
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_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
task_idpathstringobligatorio—
timeoutqueryintegeropcional
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>opcional—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
bodyunknownobligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
task_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
job_idstringobligatorio——
namestringobligatorio——
operationstringobligatorio——
statusstringobligatorio——
progressintegerobligatorio——
inputobjectobligatorio——
optionsobjectobligatorio——
resultobjectobligatorio——
requiredbooleanobligatorio——
runtime_classstringobligatorio——
prioritystringobligatorio——
attempt_countintegerobligatorio——
max_attemptsintegerobligatorio——
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_atstringobligatorio—
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[].idstringobligatorio——
attempts[].attempt_numberintegerobligatorio——
attempts[].statusstringobligatorio——
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_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
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—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
dataobject[]obligatorio——
data[]objectopcional——
data[].idstringobligatorio——
data[].api_key_idanyOf<string | null>opcional——
data[].api_key_id · variant 1stringopcional——
data[].api_key_id · variant 2nullopcional——
data[].originstringobligatorio——
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_atstringobligatorio—
format: date-time
paginationobjectobligatorio——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
startqueryanyOf<string | null>opcional—
endqueryanyOf<string | null>opcional—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
startstringobligatorio—
format: date-time
endstringobligatorio—
format: date-time
conversionsintegerobligatorio——
creditsstringobligatorio——
input_bytesintegerobligatorio——
output_bytesintegerobligatorio——
wall_msintegerobligatorio——
by_originobject[]opcional——
by_origin[]objectopcional——
by_origin[].keystringobligatorio——
by_origin[].conversionsintegerobligatorio——
by_origin[].creditsstringobligatorio——
top_pairsobject[]opcional——
top_pairs[]objectopcional——
top_pairs[].keystringobligatorio——
top_pairs[].conversionsintegerobligatorio——
top_pairs[].creditsstringobligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
delivery_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
webhook_idstringobligatorio——
event_idstringobligatorio——
statusstringobligatorio——
attemptintegerobligatorio——
request_headersobjectobligatorio——
request_bodyobjectobligatorio——
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_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
delivery_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
webhook_idstringobligatorio——
event_idstringobligatorio——
statusstringobligatorio——
attemptintegerobligatorio——
request_headersobjectobligatorio——
request_bodyobjectobligatorio——
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_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
bodyobject[]obligatorio——
items[]objectopcional——
items[].idstringobligatorio——
items[].urlstringobligatorio——
items[].descriptionanyOf<string | null>opcional——
items[].description · variant 1stringopcional——
items[].description · variant 2nullopcional——
items[].event_typesstring[]obligatorio——
items[].enabledbooleanobligatorio——
items[].failure_countintegerobligatorio——
items[].created_atstringobligatorio—
format: date-time
items[].updated_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
urlstringobligatorio—
min length: 1max length: 2048
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional—
max length: 512
description · variant 2nullopcional——
event_typesstring[]opcional——

Respuestas

201Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
urlstringobligatorio——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional——
description · variant 2nullopcional——
event_typesstring[]obligatorio——
enabledbooleanobligatorio——
failure_countintegerobligatorio——
created_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
webhook_idpathstringobligatorio—

Respuestas

204Successful Response

Sin cuerpo de respuesta.

400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
webhook_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
urlstringobligatorio——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional——
description · variant 2nullopcional——
event_typesstring[]obligatorio——
enabledbooleanobligatorio——
failure_countintegerobligatorio——
created_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
webhook_idpathstringobligatorio—

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
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——

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
urlstringobligatorio——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional——
description · variant 2nullopcional——
event_typesstring[]obligatorio——
enabledbooleanobligatorio——
failure_countintegerobligatorio——
created_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
webhook_idpathstringobligatorio—
limitqueryintegeropcional
default: 50min: 1max: 100
afterqueryanyOf<string | null>opcional—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
dataobject[]obligatorio——
data[]objectopcional——
data[].idstringobligatorio——
data[].webhook_idstringobligatorio——
data[].event_idstringobligatorio——
data[].statusstringobligatorio——
data[].attemptintegerobligatorio——
data[].request_headersobjectobligatorio——
data[].request_bodyobjectobligatorio——
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_atstringobligatorio—
format: date-time
data[].updated_atstringobligatorio—
format: date-time
paginationobjectobligatorio——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
webhook_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
signing_secretstringobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
limitqueryintegeropcional
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcional—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
dataobject[]obligatorio——
data[]objectopcional——
data[].idstringobligatorio——
data[].namestringobligatorio——
data[].descriptionanyOf<string | null>opcional——
data[].description · variant 1stringopcional——
data[].description · variant 2nullopcional——
data[].current_versionintegerobligatorio——
data[].definitionobjectobligatorio——
data[].variables_schemaobjectobligatorio——
data[].metadataobjectobligatorio——
data[].created_atstringobligatorio—
format: date-time
data[].updated_atstringobligatorio—
format: date-time
paginationobjectobligatorio——
pagination.nextanyOf<string | null>opcional——
pagination.next · variant 1stringopcional——
pagination.next · variant 2nullopcional——
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
namestringobligatorio—
min length: 1max length: 255
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional—
max length: 2000
description · variant 2nullopcional——
definitionobjectobligatorio——
definition.tasksobjectobligatorio——
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——

Respuestas

201Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
namestringobligatorio——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional——
description · variant 2nullopcional——
current_versionintegerobligatorio——
definitionobjectobligatorio——
variables_schemaobjectobligatorio——
metadataobjectobligatorio——
created_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
workflow_idpathstringobligatorio—

Respuestas

204Successful Response

Sin cuerpo de respuesta.

400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
workflow_idpathstringobligatorio—

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
namestringobligatorio——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional——
description · variant 2nullopcional——
current_versionintegerobligatorio——
definitionobjectobligatorio——
variables_schemaobjectobligatorio——
metadataobjectobligatorio——
created_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
workflow_idpathstringobligatorio—

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
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.tasksobjectobligatorio——
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——

Respuestas

200Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
namestringobligatorio——
descriptionanyOf<string | null>opcional——
description · variant 1stringopcional——
description · variant 2nullopcional——
current_versionintegerobligatorio——
definitionobjectobligatorio——
variables_schemaobjectobligatorio——
metadataobjectobligatorio——
created_atstringobligatorio—
format: date-time
updated_atstringobligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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.

Autenticación
ConverterHQBearerhttp / bearer

Parámetros

NombreUbicaciónTipoObligatorioDescripción / restricciones
workflow_idpathstringobligatorio—
Idempotency-KeyheaderanyOf<string | null>opcional—

Cuerpo de la solicitud obligatorio

application/json
CampoTipoObligatorioDescripciónRestricciones
variablesobjectopcional——
client_reference_idanyOf<string | null>opcional——
client_reference_id · variant 1stringopcional—
max length: 255
client_reference_id · variant 2nullopcional——
metadataobjectopcional——

Respuestas

201Successful Response
application/json
CampoTipoObligatorioDescripciónRestricciones
idstringobligatorio——
kindstringobligatorio——
statusstringobligatorio——
progressintegerobligatorio——
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——
prioritystringobligatorio——
concurrency_limitintegeropcional—
default: 1
originstringobligatorio——
created_atstringobligatorio—
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[].idstringobligatorio——
tasks[].job_idstringobligatorio——
tasks[].namestringobligatorio——
tasks[].operationstringobligatorio——
tasks[].statusstringobligatorio——
tasks[].progressintegerobligatorio——
tasks[].inputobjectobligatorio——
tasks[].optionsobjectobligatorio——
tasks[].resultobjectobligatorio——
tasks[].requiredbooleanobligatorio——
tasks[].runtime_classstringobligatorio——
tasks[].prioritystringobligatorio——
tasks[].attempt_countintegerobligatorio——
tasks[].max_attemptsintegerobligatorio——
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_atstringobligatorio—
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[].idstringobligatorio——
tasks[].attempts[].attempt_numberintegerobligatorio——
tasks[].attempts[].statusstringobligatorio——
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_atstringobligatorio—
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
detailobject[]opcional——
detail[]objectopcional——
detail[].locanyOf<string | integer>[]obligatorio——
detail[].loc[]anyOf<string | integer>opcional——
detail[].loc[] · variant 1stringopcional——
detail[].loc[] · variant 2integeropcional——
detail[].msgstringobligatorio——
detail[].typestringobligatorio——
429The caller has exceeded an admission-control limit.
Cabeceras de respuestaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
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
CampoTipoObligatorioDescripciónRestricciones
typestringobligatorio—
default: "about:blank"
titlestringobligatorio——
statusintegerobligatorio—
min: 400max: 599
codestringobligatorio——
detailstringobligatorio——
retryablebooleanobligatorio——
parameteranyOf<string | null>opcional——
parameter · variant 1stringopcional——
parameter · variant 2nullopcional——
request_idanyOf<string | null>opcional——
request_id · variant 1stringopcional——
request_id · variant 2nullopcional——