ConverterHQDevelopers
Généré depuis le contrat OpenAPI public sélectionné

Référence de l’API REST

Inspectez paramètres, authentification, champs imbriqués, schémas de réponse, erreurs et exemples exécutables. Les routes grand public, SEO et d’administration sont exclues.

74 endpoints affichés74 opérations au total17 étiquettes3.1.0 schéma
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.

AuthentificationPublic / aucune sécurité propre à l’opération

Paramètres

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

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
dataobject[]obligatoire——
data[]objectfacultatif——
data[].supportedbooleanobligatoire——
data[].input_formatstringobligatoire——
data[].output_formatstringobligatoire——
data[].maturitystringfacultatif—
enum: "stable", "disabled"default: "stable"
data[].settings_scopestringfacultatifSettings 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[].routeobjectfacultatif——
data[].route.multi_stepbooleanfacultatifTrue 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[]facultatifSetting 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>facultatifStable 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 1stringfacultatif——
data[].options_version · variant 2nullfacultatif——
data[].optionsobject[]facultatifSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
data[].options[]objectfacultatif——
data[].options[].namestringobligatoire——
data[].options[].typestringobligatoire——
data[].options[].labelstringobligatoire——
data[].options[].descriptionanyOf<string | null>facultatif——
data[].options[].description · variant 1stringfacultatif——
data[].options[].description · variant 2nullfacultatif——
data[].options[].requiredbooleanfacultatif—
default: false
data[].options[].advancedbooleanfacultatif—
default: false
data[].options[].groupanyOf<string | null>facultatif——
data[].options[].group · variant 1stringfacultatif——
data[].options[].group · variant 2nullfacultatif——
data[].options[].defaultunknownfacultatif——
data[].options[].possible_valuesanyOf<unknown[] | null>facultatif——
data[].options[].possible_values · variant 1unknown[]facultatif——
data[].options[].possible_values · variant 2nullfacultatif——
data[].options[].minimumanyOf<integer | number | null>facultatif——
data[].options[].minimum · variant 1integerfacultatif——
data[].options[].minimum · variant 2numberfacultatif——
data[].options[].minimum · variant 3nullfacultatif——
data[].options[].maximumanyOf<integer | number | null>facultatif——
data[].options[].maximum · variant 1integerfacultatif——
data[].options[].maximum · variant 2numberfacultatif——
data[].options[].maximum · variant 3nullfacultatif——
data[].options[].depends_onobject[]facultatif——
data[].options[].conflicts_withstring[]facultatif——
data[].options[].schemaanyOf<object | null>facultatif——
data[].options[].schema · variant 1objectfacultatif——
data[].options[].schema · variant 2nullfacultatif——
data[].options_schemaobjectfacultatifStrict JSON Schema for the settings accepted by this pair-level conversion task.—
data[].limitsobjectfacultatif——
data[].billingobjectfacultatif——
paginationobjectobligatoire——
pagination.nextanyOf<string | null>facultatif——
pagination.next · variant 1stringfacultatif——
pagination.next · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

AuthentificationPublic / aucune sécurité propre à l’opération

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
from_formatpathstringobligatoire—
to_formatpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
supportedbooleanobligatoire——
input_formatstringobligatoire——
output_formatstringobligatoire——
maturitystringfacultatif—
enum: "stable", "disabled"default: "stable"
settings_scopestringfacultatifSettings 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"
routeobjectfacultatif——
route.multi_stepbooleanfacultatifTrue 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[]facultatifSetting 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>facultatifStable 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 1stringfacultatif——
options_version · variant 2nullfacultatif——
optionsobject[]facultatifSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
options[]objectfacultatif——
options[].namestringobligatoire——
options[].typestringobligatoire——
options[].labelstringobligatoire——
options[].descriptionanyOf<string | null>facultatif——
options[].description · variant 1stringfacultatif——
options[].description · variant 2nullfacultatif——
options[].requiredbooleanfacultatif—
default: false
options[].advancedbooleanfacultatif—
default: false
options[].groupanyOf<string | null>facultatif——
options[].group · variant 1stringfacultatif——
options[].group · variant 2nullfacultatif——
options[].defaultunknownfacultatif——
options[].possible_valuesanyOf<unknown[] | null>facultatif——
options[].possible_values · variant 1unknown[]facultatif——
options[].possible_values · variant 2nullfacultatif——
options[].minimumanyOf<integer | number | null>facultatif——
options[].minimum · variant 1integerfacultatif——
options[].minimum · variant 2numberfacultatif——
options[].minimum · variant 3nullfacultatif——
options[].maximumanyOf<integer | number | null>facultatif——
options[].maximum · variant 1integerfacultatif——
options[].maximum · variant 2numberfacultatif——
options[].maximum · variant 3nullfacultatif——
options[].depends_onobject[]facultatif——
options[].conflicts_withstring[]facultatif——
options[].schemaanyOf<object | null>facultatif——
options[].schema · variant 1objectfacultatif——
options[].schema · variant 2nullfacultatif——
options_schemaobjectfacultatifStrict JSON Schema for the settings accepted by this pair-level conversion task.—
limitsobjectfacultatif——
billingobjectfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
account_idstringobligatoire——
productstringobligatoire——
api_enabledbooleanobligatoire——
plansstring[]obligatoire——
effective_planobjectobligatoire——
effective_plan.codestringobligatoire——
effective_plan.namestringobligatoire——
effective_plan.familyanyOf<string | null>facultatif——
effective_plan.family · variant 1stringfacultatif——
effective_plan.family · variant 2nullfacultatif——
effective_plan.billing_intervalanyOf<string | null>facultatif——
effective_plan.billing_interval · variant 1stringfacultatif——
effective_plan.billing_interval · variant 2nullfacultatif——
creditsobjectobligatoire——
credits.availablestringobligatoire——
credits.reservedstringobligatoire——
credits.debtstringobligatoire——
quotaanyOf<object | null>facultatif——
quota · variant 1objectfacultatif——
quota · variant 1.keystringobligatoire——
quota · variant 1.periodstringobligatoire——
quota · variant 1.period_keystringobligatoire——
quota · variant 1.limitstringobligatoire——
quota · variant 1.usedstringobligatoire——
quota · variant 1.remainingstringobligatoire——
quota · variant 1.period_startstringobligatoire—
format: date-time
quota · variant 1.period_endstringobligatoire—
format: date-time
quota · variant 2nullfacultatif——
subscriptionsobject[]obligatoire——
subscriptions[]objectfacultatif——
subscriptions[].idstringobligatoire——
subscriptions[].planstringobligatoire——
subscriptions[].statusstringobligatoire——
subscriptions[].billing_intervalanyOf<string | null>facultatif——
subscriptions[].billing_interval · variant 1stringfacultatif——
subscriptions[].billing_interval · variant 2nullfacultatif——
subscriptions[].current_period_startanyOf<string | null>facultatif——
subscriptions[].current_period_start · variant 1stringfacultatif—
format: date-time
subscriptions[].current_period_start · variant 2nullfacultatif——
subscriptions[].current_period_endanyOf<string | null>facultatif——
subscriptions[].current_period_end · variant 1stringfacultatif—
format: date-time
subscriptions[].current_period_end · variant 2nullfacultatif——
subscriptions[].next_billed_atanyOf<string | null>facultatif——
subscriptions[].next_billed_at · variant 1stringfacultatif—
format: date-time
subscriptions[].next_billed_at · variant 2nullfacultatif——
passesobject[]obligatoire——
passes[]objectfacultatif——
passes[].idstringobligatoire——
passes[].offerstringobligatoire——
passes[].planstringobligatoire——
passes[].starts_atstringobligatoire—
format: date-time
passes[].expires_atstringobligatoire—
format: date-time
generated_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
limitqueryintegerfacultatif
default: 50min: 1max: 200
afterqueryanyOf<string | null>facultatif—
providerqueryanyOf<string | null>facultatif—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
dataobject[]obligatoire——
data[]objectfacultatif——
data[].idstringobligatoire——
data[].namestringobligatoire——
data[].providerstringobligatoire—
enum: "s3", "gcs", "azure", "sftp"
data[].config_summaryobjectobligatoire——
data[].enabledbooleanobligatoire——
data[].created_atstringobligatoire—
format: date-time
data[].updated_atstringobligatoire—
format: date-time
paginationobjectobligatoire——
pagination.nextanyOf<string | null>facultatif——
pagination.next · variant 1stringfacultatif——
pagination.next · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
namestringobligatoire—
min length: 1max length: 255
providerstringobligatoire—
enum: "s3", "gcs", "azure", "sftp"
configobjectobligatoire——

Réponses

201Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
namestringobligatoire——
providerstringobligatoire—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectobligatoire——
enabledbooleanobligatoire——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
connection_idpathstringobligatoire—

Réponses

204Successful Response

Aucun corps de réponse.

400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
connection_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
namestringobligatoire——
providerstringobligatoire—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectobligatoire——
enabledbooleanobligatoire——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
connection_idpathstringobligatoire—

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
nameanyOf<string | null>facultatif——
name · variant 1stringfacultatif—
min length: 1max length: 255
name · variant 2nullfacultatif——
configanyOf<object | null>facultatif——
config · variant 1objectfacultatif——
config · variant 2nullfacultatif——
enabledanyOf<boolean | null>facultatif——
enabled · variant 1booleanfacultatif——
enabled · variant 2nullfacultatif——

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
namestringobligatoire——
providerstringobligatoire—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectobligatoire——
enabledbooleanobligatoire——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
connection_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
okbooleanobligatoire——
providerstringobligatoire——
detailsobjectfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
PreferheaderanyOf<string | null>facultatif—
Idempotency-KeyheaderanyOf<string | null>facultatif—

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
inputobjectobligatoire——
input.file_idanyOf<string | null>facultatif—
default: null
input.file_id · variant 1stringfacultatif——
input.file_id · variant 2nullfacultatif——
input.urlanyOf<string | null>facultatif—
default: null
input.url · variant 1stringfacultatif——
input.url · variant 2nullfacultatif——
input_formatanyOf<string | null>facultatif—
default: null
input_format · variant 1stringfacultatif——
input_format · variant 2nullfacultatif——
output_formatstringobligatoire—
min length: 1max length: 64
optionsobjectfacultatif——
filenameanyOf<string | null>facultatif—
default: null
filename · variant 1stringfacultatif—
max length: 512
filename · variant 2nullfacultatif——
metadataobjectfacultatif——
client_reference_idanyOf<string | null>facultatif—
default: null
client_reference_id · variant 1stringfacultatif—
max length: 255
client_reference_id · variant 2nullfacultatif——
retention_secondsanyOf<integer | null>facultatif—
default: null
retention_seconds · variant 1integerfacultatif—
min: 0max: 86400
retention_seconds · variant 2nullfacultatif——
multipart/form-data
ChampTypeObligatoireDescriptionContraintes
filestringobligatoireInput file, up to 4 MiB.
format: binary
input_formatstringfacultatifOptional source format when it cannot be detected.—
output_formatstringobligatoireRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringfacultatifJSON object containing pair-specific conversion options.—
metadatastringfacultatifJSON object copied to the created Job.—
filenamestringfacultatifOptional output filename hint.—
client_reference_idstringfacultatifOptional caller-defined reference.—
retention_secondsintegerfacultatif—
min: 0max: 86400

Réponses

200Conversion completed within the requested wait window.
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
job_idstringobligatoire——
statusstringobligatoire——
progressintegerobligatoire——
input_formatanyOf<string | null>facultatif——
input_format · variant 1stringfacultatif——
input_format · variant 2nullfacultatif——
output_formatstringobligatoire——
output_fileanyOf<object | null>facultatif——
output_file · variant 1objectfacultatif——
output_file · variant 1.idstringobligatoire——
output_file · variant 1.statusstringobligatoire——
output_file · variant 1.rolestringobligatoire——
output_file · variant 1.filenamestringobligatoire——
output_file · variant 1.content_typeanyOf<string | null>facultatif——
output_file · variant 1.content_type · variant 1stringfacultatif——
output_file · variant 1.content_type · variant 2nullfacultatif——
output_file · variant 1.detected_content_typeanyOf<string | null>facultatif——
output_file · variant 1.detected_content_type · variant 1stringfacultatif——
output_file · variant 1.detected_content_type · variant 2nullfacultatif——
output_file · variant 1.detected_formatanyOf<string | null>facultatif——
output_file · variant 1.detected_format · variant 1stringfacultatif——
output_file · variant 1.detected_format · variant 2nullfacultatif——
output_file · variant 1.size_bytesanyOf<integer | null>facultatif——
output_file · variant 1.size_bytes · variant 1integerfacultatif——
output_file · variant 1.size_bytes · variant 2nullfacultatif——
output_file · variant 1.checksum_sha256anyOf<string | null>facultatif——
output_file · variant 1.checksum_sha256 · variant 1stringfacultatif——
output_file · variant 1.checksum_sha256 · variant 2nullfacultatif——
output_file · variant 1.source_typestringobligatoire——
output_file · variant 1.created_atstringobligatoire—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>facultatif——
output_file · variant 1.ready_at · variant 1stringfacultatif—
format: date-time
output_file · variant 1.ready_at · variant 2nullfacultatif——
output_file · variant 1.expires_atanyOf<string | null>facultatif——
output_file · variant 1.expires_at · variant 1stringfacultatif—
format: date-time
output_file · variant 1.expires_at · variant 2nullfacultatif——
output_file · variant 1.metadataobjectfacultatif——
output_file · variant 1.uploadanyOf<object | null>facultatif——
output_file · variant 1.upload · variant 1objectfacultatif——
output_file · variant 1.upload · variant 1.methodstringfacultatif—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringobligatoire——
output_file · variant 1.upload · variant 1.expires_atstringobligatoire—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectfacultatif——
output_file · variant 1.upload · variant 2nullfacultatif——
output_file · variant 1.download_urlanyOf<string | null>facultatif——
output_file · variant 1.download_url · variant 1stringfacultatif——
output_file · variant 1.download_url · variant 2nullfacultatif——
output_file · variant 1.download_expires_atanyOf<string | null>facultatif——
output_file · variant 1.download_expires_at · variant 1stringfacultatif—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullfacultatif——
output_file · variant 2nullfacultatif——
created_atstringobligatoire—
format: date-time
202Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
job_idstringobligatoire——
statusstringobligatoire——
progressintegerobligatoire——
input_formatanyOf<string | null>facultatif——
input_format · variant 1stringfacultatif——
input_format · variant 2nullfacultatif——
output_formatstringobligatoire——
output_fileanyOf<object | null>facultatif——
output_file · variant 1objectfacultatif——
output_file · variant 1.idstringobligatoire——
output_file · variant 1.statusstringobligatoire——
output_file · variant 1.rolestringobligatoire——
output_file · variant 1.filenamestringobligatoire——
output_file · variant 1.content_typeanyOf<string | null>facultatif——
output_file · variant 1.content_type · variant 1stringfacultatif——
output_file · variant 1.content_type · variant 2nullfacultatif——
output_file · variant 1.detected_content_typeanyOf<string | null>facultatif——
output_file · variant 1.detected_content_type · variant 1stringfacultatif——
output_file · variant 1.detected_content_type · variant 2nullfacultatif——
output_file · variant 1.detected_formatanyOf<string | null>facultatif——
output_file · variant 1.detected_format · variant 1stringfacultatif——
output_file · variant 1.detected_format · variant 2nullfacultatif——
output_file · variant 1.size_bytesanyOf<integer | null>facultatif——
output_file · variant 1.size_bytes · variant 1integerfacultatif——
output_file · variant 1.size_bytes · variant 2nullfacultatif——
output_file · variant 1.checksum_sha256anyOf<string | null>facultatif——
output_file · variant 1.checksum_sha256 · variant 1stringfacultatif——
output_file · variant 1.checksum_sha256 · variant 2nullfacultatif——
output_file · variant 1.source_typestringobligatoire——
output_file · variant 1.created_atstringobligatoire—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>facultatif——
output_file · variant 1.ready_at · variant 1stringfacultatif—
format: date-time
output_file · variant 1.ready_at · variant 2nullfacultatif——
output_file · variant 1.expires_atanyOf<string | null>facultatif——
output_file · variant 1.expires_at · variant 1stringfacultatif—
format: date-time
output_file · variant 1.expires_at · variant 2nullfacultatif——
output_file · variant 1.metadataobjectfacultatif——
output_file · variant 1.uploadanyOf<object | null>facultatif——
output_file · variant 1.upload · variant 1objectfacultatif——
output_file · variant 1.upload · variant 1.methodstringfacultatif—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringobligatoire——
output_file · variant 1.upload · variant 1.expires_atstringobligatoire—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectfacultatif——
output_file · variant 1.upload · variant 2nullfacultatif——
output_file · variant 1.download_urlanyOf<string | null>facultatif——
output_file · variant 1.download_url · variant 1stringfacultatif——
output_file · variant 1.download_url · variant 2nullfacultatif——
output_file · variant 1.download_expires_atanyOf<string | null>facultatif——
output_file · variant 1.download_expires_at · variant 1stringfacultatif—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullfacultatif——
output_file · variant 2nullfacultatif——
created_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
from_formatpathstringobligatoire—
to_formatpathstringobligatoire—
PreferheaderanyOf<string | null>facultatif—
Idempotency-KeyheaderanyOf<string | null>facultatif—

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
inputobjectobligatoire——
input.file_idanyOf<string | null>facultatif—
default: null
input.file_id · variant 1stringfacultatif——
input.file_id · variant 2nullfacultatif——
input.urlanyOf<string | null>facultatif—
default: null
input.url · variant 1stringfacultatif——
input.url · variant 2nullfacultatif——
input_formatanyOf<string | null>facultatif—
default: null
input_format · variant 1stringfacultatif——
input_format · variant 2nullfacultatif——
output_formatstringobligatoire—
min length: 1max length: 64
optionsobjectfacultatif——
filenameanyOf<string | null>facultatif—
default: null
filename · variant 1stringfacultatif—
max length: 512
filename · variant 2nullfacultatif——
metadataobjectfacultatif——
client_reference_idanyOf<string | null>facultatif—
default: null
client_reference_id · variant 1stringfacultatif—
max length: 255
client_reference_id · variant 2nullfacultatif——
retention_secondsanyOf<integer | null>facultatif—
default: null
retention_seconds · variant 1integerfacultatif—
min: 0max: 86400
retention_seconds · variant 2nullfacultatif——
multipart/form-data
ChampTypeObligatoireDescriptionContraintes
filestringobligatoireInput file, up to 4 MiB.
format: binary
input_formatstringfacultatifOptional source format when it cannot be detected.—
output_formatstringfacultatifRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringfacultatifJSON object containing pair-specific conversion options.—
metadatastringfacultatifJSON object copied to the created Job.—
filenamestringfacultatifOptional output filename hint.—
client_reference_idstringfacultatifOptional caller-defined reference.—
retention_secondsintegerfacultatif—
min: 0max: 86400

Réponses

200Conversion completed within the requested wait window.
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
job_idstringobligatoire——
statusstringobligatoire——
progressintegerobligatoire——
input_formatanyOf<string | null>facultatif——
input_format · variant 1stringfacultatif——
input_format · variant 2nullfacultatif——
output_formatstringobligatoire——
output_fileanyOf<object | null>facultatif——
output_file · variant 1objectfacultatif——
output_file · variant 1.idstringobligatoire——
output_file · variant 1.statusstringobligatoire——
output_file · variant 1.rolestringobligatoire——
output_file · variant 1.filenamestringobligatoire——
output_file · variant 1.content_typeanyOf<string | null>facultatif——
output_file · variant 1.content_type · variant 1stringfacultatif——
output_file · variant 1.content_type · variant 2nullfacultatif——
output_file · variant 1.detected_content_typeanyOf<string | null>facultatif——
output_file · variant 1.detected_content_type · variant 1stringfacultatif——
output_file · variant 1.detected_content_type · variant 2nullfacultatif——
output_file · variant 1.detected_formatanyOf<string | null>facultatif——
output_file · variant 1.detected_format · variant 1stringfacultatif——
output_file · variant 1.detected_format · variant 2nullfacultatif——
output_file · variant 1.size_bytesanyOf<integer | null>facultatif——
output_file · variant 1.size_bytes · variant 1integerfacultatif——
output_file · variant 1.size_bytes · variant 2nullfacultatif——
output_file · variant 1.checksum_sha256anyOf<string | null>facultatif——
output_file · variant 1.checksum_sha256 · variant 1stringfacultatif——
output_file · variant 1.checksum_sha256 · variant 2nullfacultatif——
output_file · variant 1.source_typestringobligatoire——
output_file · variant 1.created_atstringobligatoire—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>facultatif——
output_file · variant 1.ready_at · variant 1stringfacultatif—
format: date-time
output_file · variant 1.ready_at · variant 2nullfacultatif——
output_file · variant 1.expires_atanyOf<string | null>facultatif——
output_file · variant 1.expires_at · variant 1stringfacultatif—
format: date-time
output_file · variant 1.expires_at · variant 2nullfacultatif——
output_file · variant 1.metadataobjectfacultatif——
output_file · variant 1.uploadanyOf<object | null>facultatif——
output_file · variant 1.upload · variant 1objectfacultatif——
output_file · variant 1.upload · variant 1.methodstringfacultatif—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringobligatoire——
output_file · variant 1.upload · variant 1.expires_atstringobligatoire—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectfacultatif——
output_file · variant 1.upload · variant 2nullfacultatif——
output_file · variant 1.download_urlanyOf<string | null>facultatif——
output_file · variant 1.download_url · variant 1stringfacultatif——
output_file · variant 1.download_url · variant 2nullfacultatif——
output_file · variant 1.download_expires_atanyOf<string | null>facultatif——
output_file · variant 1.download_expires_at · variant 1stringfacultatif—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullfacultatif——
output_file · variant 2nullfacultatif——
created_atstringobligatoire—
format: date-time
202Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
job_idstringobligatoire——
statusstringobligatoire——
progressintegerobligatoire——
input_formatanyOf<string | null>facultatif——
input_format · variant 1stringfacultatif——
input_format · variant 2nullfacultatif——
output_formatstringobligatoire——
output_fileanyOf<object | null>facultatif——
output_file · variant 1objectfacultatif——
output_file · variant 1.idstringobligatoire——
output_file · variant 1.statusstringobligatoire——
output_file · variant 1.rolestringobligatoire——
output_file · variant 1.filenamestringobligatoire——
output_file · variant 1.content_typeanyOf<string | null>facultatif——
output_file · variant 1.content_type · variant 1stringfacultatif——
output_file · variant 1.content_type · variant 2nullfacultatif——
output_file · variant 1.detected_content_typeanyOf<string | null>facultatif——
output_file · variant 1.detected_content_type · variant 1stringfacultatif——
output_file · variant 1.detected_content_type · variant 2nullfacultatif——
output_file · variant 1.detected_formatanyOf<string | null>facultatif——
output_file · variant 1.detected_format · variant 1stringfacultatif——
output_file · variant 1.detected_format · variant 2nullfacultatif——
output_file · variant 1.size_bytesanyOf<integer | null>facultatif——
output_file · variant 1.size_bytes · variant 1integerfacultatif——
output_file · variant 1.size_bytes · variant 2nullfacultatif——
output_file · variant 1.checksum_sha256anyOf<string | null>facultatif——
output_file · variant 1.checksum_sha256 · variant 1stringfacultatif——
output_file · variant 1.checksum_sha256 · variant 2nullfacultatif——
output_file · variant 1.source_typestringobligatoire——
output_file · variant 1.created_atstringobligatoire—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>facultatif——
output_file · variant 1.ready_at · variant 1stringfacultatif—
format: date-time
output_file · variant 1.ready_at · variant 2nullfacultatif——
output_file · variant 1.expires_atanyOf<string | null>facultatif——
output_file · variant 1.expires_at · variant 1stringfacultatif—
format: date-time
output_file · variant 1.expires_at · variant 2nullfacultatif——
output_file · variant 1.metadataobjectfacultatif——
output_file · variant 1.uploadanyOf<object | null>facultatif——
output_file · variant 1.upload · variant 1objectfacultatif——
output_file · variant 1.upload · variant 1.methodstringfacultatif—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringobligatoire——
output_file · variant 1.upload · variant 1.expires_atstringobligatoire—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectfacultatif——
output_file · variant 1.upload · variant 2nullfacultatif——
output_file · variant 1.download_urlanyOf<string | null>facultatif——
output_file · variant 1.download_url · variant 1stringfacultatif——
output_file · variant 1.download_url · variant 2nullfacultatif——
output_file · variant 1.download_expires_atanyOf<string | null>facultatif——
output_file · variant 1.download_expires_at · variant 1stringfacultatif—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullfacultatif——
output_file · variant 2nullfacultatif——
created_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
input_formatstringobligatoire——
output_formatstringobligatoire——
size_bytesanyOf<integer | null>facultatif——
size_bytes · variant 1integerfacultatif—
min: 0
size_bytes · variant 2nullfacultatif——
page_countanyOf<integer | null>facultatif——
page_count · variant 1integerfacultatif—
min: 0
page_count · variant 2nullfacultatif——
duration_secondsanyOf<number | null>facultatif——
duration_seconds · variant 1numberfacultatif—
min: 0
duration_seconds · variant 2nullfacultatif——
optionsobjectfacultatif——

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
supportedbooleanobligatoire——
recommended_modestringobligatoire—
enum: "sync", "async"
creditsobjectobligatoire——
warningsstring[]facultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
GET/v1/event-typesEvent TypesDiscovery#

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

AuthentificationPublic / aucune sécurité propre à l’opération

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
dataobject[]obligatoire——
data[]objectfacultatif——
data[].typestringobligatoire——
data[].descriptionstringobligatoire——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
limitqueryintegerfacultatif
default: 50min: 1max: 200
afterqueryanyOf<string | null>facultatif—
statusqueryanyOf<string | null>facultatif—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
dataobject[]obligatoire——
data[]objectfacultatif——
data[].idstringobligatoire——
data[].statusstringobligatoire——
data[].rolestringobligatoire——
data[].filenamestringobligatoire——
data[].content_typeanyOf<string | null>facultatif——
data[].content_type · variant 1stringfacultatif——
data[].content_type · variant 2nullfacultatif——
data[].detected_content_typeanyOf<string | null>facultatif——
data[].detected_content_type · variant 1stringfacultatif——
data[].detected_content_type · variant 2nullfacultatif——
data[].detected_formatanyOf<string | null>facultatif——
data[].detected_format · variant 1stringfacultatif——
data[].detected_format · variant 2nullfacultatif——
data[].size_bytesanyOf<integer | null>facultatif——
data[].size_bytes · variant 1integerfacultatif——
data[].size_bytes · variant 2nullfacultatif——
data[].checksum_sha256anyOf<string | null>facultatif——
data[].checksum_sha256 · variant 1stringfacultatif——
data[].checksum_sha256 · variant 2nullfacultatif——
data[].source_typestringobligatoire——
data[].created_atstringobligatoire—
format: date-time
data[].ready_atanyOf<string | null>facultatif——
data[].ready_at · variant 1stringfacultatif—
format: date-time
data[].ready_at · variant 2nullfacultatif——
data[].expires_atanyOf<string | null>facultatif——
data[].expires_at · variant 1stringfacultatif—
format: date-time
data[].expires_at · variant 2nullfacultatif——
data[].metadataobjectfacultatif——
data[].uploadanyOf<object | null>facultatif——
data[].upload · variant 1objectfacultatif——
data[].upload · variant 1.methodstringfacultatif—
default: "PUT"
data[].upload · variant 1.urlstringobligatoire——
data[].upload · variant 1.expires_atstringobligatoire—
format: date-time
data[].upload · variant 1.headersobjectfacultatif——
data[].upload · variant 2nullfacultatif——
data[].download_urlanyOf<string | null>facultatif——
data[].download_url · variant 1stringfacultatif——
data[].download_url · variant 2nullfacultatif——
data[].download_expires_atanyOf<string | null>facultatif——
data[].download_expires_at · variant 1stringfacultatif—
format: date-time
data[].download_expires_at · variant 2nullfacultatif——
paginationobjectobligatoire——
pagination.nextanyOf<string | null>facultatif——
pagination.next · variant 1stringfacultatif——
pagination.next · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
filenamestringobligatoire—
min length: 1max length: 512
size_bytesanyOf<integer | null>facultatif——
size_bytes · variant 1integerfacultatif—
min: 0
size_bytes · variant 2nullfacultatif——
content_typeanyOf<string | null>facultatif——
content_type · variant 1stringfacultatif—
max length: 255
content_type · variant 2nullfacultatif——
checksum_sha256anyOf<string | null>facultatif——
checksum_sha256 · variant 1stringfacultatif—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullfacultatif——
retention_secondsanyOf<integer | null>facultatif——
retention_seconds · variant 1integerfacultatif—
min: 0max: 86400
retention_seconds · variant 2nullfacultatif——
metadataobjectfacultatif——

Réponses

201Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
statusstringobligatoire——
rolestringobligatoire——
filenamestringobligatoire——
content_typeanyOf<string | null>facultatif——
content_type · variant 1stringfacultatif——
content_type · variant 2nullfacultatif——
detected_content_typeanyOf<string | null>facultatif——
detected_content_type · variant 1stringfacultatif——
detected_content_type · variant 2nullfacultatif——
detected_formatanyOf<string | null>facultatif——
detected_format · variant 1stringfacultatif——
detected_format · variant 2nullfacultatif——
size_bytesanyOf<integer | null>facultatif——
size_bytes · variant 1integerfacultatif——
size_bytes · variant 2nullfacultatif——
checksum_sha256anyOf<string | null>facultatif——
checksum_sha256 · variant 1stringfacultatif——
checksum_sha256 · variant 2nullfacultatif——
source_typestringobligatoire——
created_atstringobligatoire—
format: date-time
ready_atanyOf<string | null>facultatif——
ready_at · variant 1stringfacultatif—
format: date-time
ready_at · variant 2nullfacultatif——
expires_atanyOf<string | null>facultatif——
expires_at · variant 1stringfacultatif—
format: date-time
expires_at · variant 2nullfacultatif——
metadataobjectfacultatif——
uploadanyOf<object | null>facultatif——
upload · variant 1objectfacultatif——
upload · variant 1.methodstringfacultatif—
default: "PUT"
upload · variant 1.urlstringobligatoire——
upload · variant 1.expires_atstringobligatoire—
format: date-time
upload · variant 1.headersobjectfacultatif——
upload · variant 2nullfacultatif——
download_urlanyOf<string | null>facultatif——
download_url · variant 1stringfacultatif——
download_url · variant 2nullfacultatif——
download_expires_atanyOf<string | null>facultatif——
download_expires_at · variant 1stringfacultatif—
format: date-time
download_expires_at · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
file_idpathstringobligatoire—

Réponses

204Successful Response

Aucun corps de réponse.

400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
file_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
statusstringobligatoire——
rolestringobligatoire——
filenamestringobligatoire——
content_typeanyOf<string | null>facultatif——
content_type · variant 1stringfacultatif——
content_type · variant 2nullfacultatif——
detected_content_typeanyOf<string | null>facultatif——
detected_content_type · variant 1stringfacultatif——
detected_content_type · variant 2nullfacultatif——
detected_formatanyOf<string | null>facultatif——
detected_format · variant 1stringfacultatif——
detected_format · variant 2nullfacultatif——
size_bytesanyOf<integer | null>facultatif——
size_bytes · variant 1integerfacultatif——
size_bytes · variant 2nullfacultatif——
checksum_sha256anyOf<string | null>facultatif——
checksum_sha256 · variant 1stringfacultatif——
checksum_sha256 · variant 2nullfacultatif——
source_typestringobligatoire——
created_atstringobligatoire—
format: date-time
ready_atanyOf<string | null>facultatif——
ready_at · variant 1stringfacultatif—
format: date-time
ready_at · variant 2nullfacultatif——
expires_atanyOf<string | null>facultatif——
expires_at · variant 1stringfacultatif—
format: date-time
expires_at · variant 2nullfacultatif——
metadataobjectfacultatif——
uploadanyOf<object | null>facultatif——
upload · variant 1objectfacultatif——
upload · variant 1.methodstringfacultatif—
default: "PUT"
upload · variant 1.urlstringobligatoire——
upload · variant 1.expires_atstringobligatoire—
format: date-time
upload · variant 1.headersobjectfacultatif——
upload · variant 2nullfacultatif——
download_urlanyOf<string | null>facultatif——
download_url · variant 1stringfacultatif——
download_url · variant 2nullfacultatif——
download_expires_atanyOf<string | null>facultatif——
download_expires_at · variant 1stringfacultatif—
format: date-time
download_expires_at · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
file_idpathstringobligatoire—

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
checksum_sha256anyOf<string | null>facultatif——
checksum_sha256 · variant 1stringfacultatif—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullfacultatif——

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
statusstringobligatoire——
rolestringobligatoire——
filenamestringobligatoire——
content_typeanyOf<string | null>facultatif——
content_type · variant 1stringfacultatif——
content_type · variant 2nullfacultatif——
detected_content_typeanyOf<string | null>facultatif——
detected_content_type · variant 1stringfacultatif——
detected_content_type · variant 2nullfacultatif——
detected_formatanyOf<string | null>facultatif——
detected_format · variant 1stringfacultatif——
detected_format · variant 2nullfacultatif——
size_bytesanyOf<integer | null>facultatif——
size_bytes · variant 1integerfacultatif——
size_bytes · variant 2nullfacultatif——
checksum_sha256anyOf<string | null>facultatif——
checksum_sha256 · variant 1stringfacultatif——
checksum_sha256 · variant 2nullfacultatif——
source_typestringobligatoire——
created_atstringobligatoire—
format: date-time
ready_atanyOf<string | null>facultatif——
ready_at · variant 1stringfacultatif—
format: date-time
ready_at · variant 2nullfacultatif——
expires_atanyOf<string | null>facultatif——
expires_at · variant 1stringfacultatif—
format: date-time
expires_at · variant 2nullfacultatif——
metadataobjectfacultatif——
uploadanyOf<object | null>facultatif——
upload · variant 1objectfacultatif——
upload · variant 1.methodstringfacultatif—
default: "PUT"
upload · variant 1.urlstringobligatoire——
upload · variant 1.expires_atstringobligatoire—
format: date-time
upload · variant 1.headersobjectfacultatif——
upload · variant 2nullfacultatif——
download_urlanyOf<string | null>facultatif——
download_url · variant 1stringfacultatif——
download_url · variant 2nullfacultatif——
download_expires_atanyOf<string | null>facultatif——
download_expires_at · variant 1stringfacultatif—
format: date-time
download_expires_at · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
file_idpathstringobligatoire—

Réponses

204Successful Response

Aucun corps de réponse.

400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
file_idpathstringobligatoire—

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
part_sizeanyOf<integer | null>facultatif——
part_size · variant 1integerfacultatif—
min: 5242880max: 5368709120
part_size · variant 2nullfacultatif——

Réponses

201Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
file_idstringobligatoire——
upload_idstringobligatoire——
part_sizeintegerobligatoire——
max_partsintegerfacultatif—
default: 10000
expires_atstringobligatoire—
format: date-time
partsobject[]facultatif——
parts[]objectfacultatif——
parts[].part_numberintegerobligatoire——
parts[].urlstringobligatoire——
parts[].expires_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
file_idpathstringobligatoire—

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
partsobject[]obligatoire—
min items: 1max items: 10000
parts[]objectfacultatif——
parts[].part_numberintegerobligatoire—
min: 1max: 10000
parts[].etagstringobligatoire—
min length: 1max length: 512
checksum_sha256anyOf<string | null>facultatif——
checksum_sha256 · variant 1stringfacultatif—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullfacultatif——

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
statusstringobligatoire——
rolestringobligatoire——
filenamestringobligatoire——
content_typeanyOf<string | null>facultatif——
content_type · variant 1stringfacultatif——
content_type · variant 2nullfacultatif——
detected_content_typeanyOf<string | null>facultatif——
detected_content_type · variant 1stringfacultatif——
detected_content_type · variant 2nullfacultatif——
detected_formatanyOf<string | null>facultatif——
detected_format · variant 1stringfacultatif——
detected_format · variant 2nullfacultatif——
size_bytesanyOf<integer | null>facultatif——
size_bytes · variant 1integerfacultatif——
size_bytes · variant 2nullfacultatif——
checksum_sha256anyOf<string | null>facultatif——
checksum_sha256 · variant 1stringfacultatif——
checksum_sha256 · variant 2nullfacultatif——
source_typestringobligatoire——
created_atstringobligatoire—
format: date-time
ready_atanyOf<string | null>facultatif——
ready_at · variant 1stringfacultatif—
format: date-time
ready_at · variant 2nullfacultatif——
expires_atanyOf<string | null>facultatif——
expires_at · variant 1stringfacultatif—
format: date-time
expires_at · variant 2nullfacultatif——
metadataobjectfacultatif——
uploadanyOf<object | null>facultatif——
upload · variant 1objectfacultatif——
upload · variant 1.methodstringfacultatif—
default: "PUT"
upload · variant 1.urlstringobligatoire——
upload · variant 1.expires_atstringobligatoire—
format: date-time
upload · variant 1.headersobjectfacultatif——
upload · variant 2nullfacultatif——
download_urlanyOf<string | null>facultatif——
download_url · variant 1stringfacultatif——
download_url · variant 2nullfacultatif——
download_expires_atanyOf<string | null>facultatif——
download_expires_at · variant 1stringfacultatif—
format: date-time
download_expires_at · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
file_idpathstringobligatoire—

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
part_numbersinteger[]obligatoire—
min items: 1max items: 1000

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
file_idstringobligatoire——
upload_idstringobligatoire——
part_sizeintegerobligatoire——
max_partsintegerfacultatif—
default: 10000
expires_atstringobligatoire—
format: date-time
partsobject[]facultatif——
parts[]objectfacultatif——
parts[].part_numberintegerobligatoire——
parts[].urlstringobligatoire——
parts[].expires_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

AuthentificationPublic / aucune sécurité propre à l’opération

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
limitqueryintegerfacultatif
default: 500min: 1max: 500

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
dataobject[]obligatoire——
data[]objectfacultatif——
data[].slugstringobligatoire——
data[].labelstringobligatoire——
data[].categorystringobligatoire——
data[].mime_typesstring[]obligatoire——
data[].extensionsstring[]obligatoire——
paginationobjectobligatoire——
pagination.nextanyOf<string | null>facultatif——
pagination.next · variant 1stringfacultatif——
pagination.next · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

AuthentificationPublic / aucune sécurité propre à l’opération

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
slugpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
slugstringobligatoire——
labelstringobligatoire——
categorystringobligatoire——
mime_typesstring[]obligatoire——
extensionsstring[]obligatoire——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

AuthentificationPublic / aucune sécurité propre à l’opération

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
slugpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
dataobject[]obligatoire——
data[]objectfacultatif——
data[].slugstringobligatoire——
data[].labelstringobligatoire——
data[].categorystringobligatoire——
data[].mime_typesstring[]obligatoire——
data[].extensionsstring[]obligatoire——
paginationobjectobligatoire——
pagination.nextanyOf<string | null>facultatif——
pagination.next · variant 1stringfacultatif——
pagination.next · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

AuthentificationPublic / aucune sécurité propre à l’opération

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
slugpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
dataobject[]obligatoire——
data[]objectfacultatif——
data[].slugstringobligatoire——
data[].labelstringobligatoire——
data[].categorystringobligatoire——
data[].mime_typesstring[]obligatoire——
data[].extensionsstring[]obligatoire——
paginationobjectobligatoire——
pagination.nextanyOf<string | null>facultatif——
pagination.next · variant 1stringfacultatif——
pagination.next · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
limitqueryintegerfacultatif
default: 50min: 1max: 200
afterqueryanyOf<string | null>facultatif—
statusqueryanyOf<string | null>facultatif—
tagqueryanyOf<string | null>facultatif—
originqueryanyOf<string | null>facultatif—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
dataobject[]obligatoire——
data[]objectfacultatif——
data[].idstringobligatoire——
data[].kindstringobligatoire——
data[].statusstringobligatoire——
data[].progressintegerobligatoire——
data[].taganyOf<string | null>facultatif——
data[].tag · variant 1stringfacultatif——
data[].tag · variant 2nullfacultatif——
data[].client_reference_idanyOf<string | null>facultatif——
data[].client_reference_id · variant 1stringfacultatif——
data[].client_reference_id · variant 2nullfacultatif——
data[].metadataobjectfacultatif——
data[].prioritystringobligatoire——
data[].concurrency_limitintegerfacultatif—
default: 1
data[].originstringobligatoire——
data[].created_atstringobligatoire—
format: date-time
data[].started_atanyOf<string | null>facultatif——
data[].started_at · variant 1stringfacultatif—
format: date-time
data[].started_at · variant 2nullfacultatif——
data[].completed_atanyOf<string | null>facultatif——
data[].completed_at · variant 1stringfacultatif—
format: date-time
data[].completed_at · variant 2nullfacultatif——
data[].error_codeanyOf<string | null>facultatif——
data[].error_code · variant 1stringfacultatif——
data[].error_code · variant 2nullfacultatif——
data[].error_messageanyOf<string | null>facultatif——
data[].error_message · variant 1stringfacultatif——
data[].error_message · variant 2nullfacultatif——
data[].tasksobject[]facultatif——
data[].tasks[]objectfacultatif——
data[].tasks[].idstringobligatoire——
data[].tasks[].job_idstringobligatoire——
data[].tasks[].namestringobligatoire——
data[].tasks[].operationstringobligatoire——
data[].tasks[].statusstringobligatoire——
data[].tasks[].progressintegerobligatoire——
data[].tasks[].inputobjectobligatoire——
data[].tasks[].optionsobjectobligatoire——
data[].tasks[].resultobjectobligatoire——
data[].tasks[].requiredbooleanobligatoire——
data[].tasks[].runtime_classstringobligatoire——
data[].tasks[].prioritystringobligatoire——
data[].tasks[].attempt_countintegerobligatoire——
data[].tasks[].max_attemptsintegerobligatoire——
data[].tasks[].error_codeanyOf<string | null>facultatif——
data[].tasks[].error_code · variant 1stringfacultatif——
data[].tasks[].error_code · variant 2nullfacultatif——
data[].tasks[].error_messageanyOf<string | null>facultatif——
data[].tasks[].error_message · variant 1stringfacultatif——
data[].tasks[].error_message · variant 2nullfacultatif——
data[].tasks[].created_atstringobligatoire—
format: date-time
data[].tasks[].queued_atanyOf<string | null>facultatif——
data[].tasks[].queued_at · variant 1stringfacultatif—
format: date-time
data[].tasks[].queued_at · variant 2nullfacultatif——
data[].tasks[].started_atanyOf<string | null>facultatif——
data[].tasks[].started_at · variant 1stringfacultatif—
format: date-time
data[].tasks[].started_at · variant 2nullfacultatif——
data[].tasks[].completed_atanyOf<string | null>facultatif——
data[].tasks[].completed_at · variant 1stringfacultatif—
format: date-time
data[].tasks[].completed_at · variant 2nullfacultatif——
data[].tasks[].attemptsobject[]facultatif——
data[].tasks[].attempts[]objectfacultatif——
data[].tasks[].attempts[].idstringobligatoire——
data[].tasks[].attempts[].attempt_numberintegerobligatoire——
data[].tasks[].attempts[].statusstringobligatoire——
data[].tasks[].attempts[].worker_idanyOf<string | null>facultatif——
data[].tasks[].attempts[].worker_id · variant 1stringfacultatif——
data[].tasks[].attempts[].worker_id · variant 2nullfacultatif——
data[].tasks[].attempts[].runtime_classanyOf<string | null>facultatif——
data[].tasks[].attempts[].runtime_class · variant 1stringfacultatif——
data[].tasks[].attempts[].runtime_class · variant 2nullfacultatif——
data[].tasks[].attempts[].regionanyOf<string | null>facultatif——
data[].tasks[].attempts[].region · variant 1stringfacultatif——
data[].tasks[].attempts[].region · variant 2nullfacultatif——
data[].tasks[].attempts[].engineanyOf<string | null>facultatif——
data[].tasks[].attempts[].engine · variant 1stringfacultatif——
data[].tasks[].attempts[].engine · variant 2nullfacultatif——
data[].tasks[].attempts[].engine_versionanyOf<string | null>facultatif——
data[].tasks[].attempts[].engine_version · variant 1stringfacultatif——
data[].tasks[].attempts[].engine_version · variant 2nullfacultatif——
data[].tasks[].attempts[].input_bytesanyOf<integer | null>facultatif——
data[].tasks[].attempts[].input_bytes · variant 1integerfacultatif——
data[].tasks[].attempts[].input_bytes · variant 2nullfacultatif——
data[].tasks[].attempts[].output_bytesanyOf<integer | null>facultatif——
data[].tasks[].attempts[].output_bytes · variant 1integerfacultatif——
data[].tasks[].attempts[].output_bytes · variant 2nullfacultatif——
data[].tasks[].attempts[].wall_msanyOf<integer | null>facultatif——
data[].tasks[].attempts[].wall_ms · variant 1integerfacultatif——
data[].tasks[].attempts[].wall_ms · variant 2nullfacultatif——
data[].tasks[].attempts[].cpu_msanyOf<integer | null>facultatif——
data[].tasks[].attempts[].cpu_ms · variant 1integerfacultatif——
data[].tasks[].attempts[].cpu_ms · variant 2nullfacultatif——
data[].tasks[].attempts[].peak_memory_mbanyOf<integer | null>facultatif——
data[].tasks[].attempts[].peak_memory_mb · variant 1integerfacultatif——
data[].tasks[].attempts[].peak_memory_mb · variant 2nullfacultatif——
data[].tasks[].attempts[].temp_bytesanyOf<integer | null>facultatif——
data[].tasks[].attempts[].temp_bytes · variant 1integerfacultatif——
data[].tasks[].attempts[].temp_bytes · variant 2nullfacultatif——
data[].tasks[].attempts[].error_codeanyOf<string | null>facultatif——
data[].tasks[].attempts[].error_code · variant 1stringfacultatif——
data[].tasks[].attempts[].error_code · variant 2nullfacultatif——
data[].tasks[].attempts[].error_messageanyOf<string | null>facultatif——
data[].tasks[].attempts[].error_message · variant 1stringfacultatif——
data[].tasks[].attempts[].error_message · variant 2nullfacultatif——
data[].tasks[].attempts[].estimated_creditsanyOf<string | null>facultatif——
data[].tasks[].attempts[].estimated_credits · variant 1stringfacultatif——
data[].tasks[].attempts[].estimated_credits · variant 2nullfacultatif——
data[].tasks[].attempts[].settled_creditsanyOf<string | null>facultatif——
data[].tasks[].attempts[].settled_credits · variant 1stringfacultatif——
data[].tasks[].attempts[].settled_credits · variant 2nullfacultatif——
data[].tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facultatif——
data[].tasks[].attempts[].external_side_effect_started_at · variant 1stringfacultatif—
format: date-time
data[].tasks[].attempts[].external_side_effect_started_at · variant 2nullfacultatif——
data[].tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facultatif——
data[].tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacultatif—
format: date-time
data[].tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacultatif——
data[].tasks[].attempts[].started_atstringobligatoire—
format: date-time
data[].tasks[].attempts[].completed_atanyOf<string | null>facultatif——
data[].tasks[].attempts[].completed_at · variant 1stringfacultatif—
format: date-time
data[].tasks[].attempts[].completed_at · variant 2nullfacultatif——
paginationobjectobligatoire——
pagination.nextanyOf<string | null>facultatif——
pagination.next · variant 1stringfacultatif——
pagination.next · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
Idempotency-KeyheaderanyOf<string | null>facultatif—

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
tasksobjectobligatoire——
taganyOf<string | null>facultatif——
tag · variant 1stringfacultatif—
max length: 255
tag · variant 2nullfacultatif——
client_reference_idanyOf<string | null>facultatif——
client_reference_id · variant 1stringfacultatif—
max length: 255
client_reference_id · variant 2nullfacultatif——
metadataobjectfacultatif——
prioritystringfacultatif—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>facultatif——
retention_seconds · variant 1integerfacultatif—
min: 0max: 86400
retention_seconds · variant 2nullfacultatif——

Réponses

201Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
kindstringobligatoire——
statusstringobligatoire——
progressintegerobligatoire——
taganyOf<string | null>facultatif——
tag · variant 1stringfacultatif——
tag · variant 2nullfacultatif——
client_reference_idanyOf<string | null>facultatif——
client_reference_id · variant 1stringfacultatif——
client_reference_id · variant 2nullfacultatif——
metadataobjectfacultatif——
prioritystringobligatoire——
concurrency_limitintegerfacultatif—
default: 1
originstringobligatoire——
created_atstringobligatoire—
format: date-time
started_atanyOf<string | null>facultatif——
started_at · variant 1stringfacultatif—
format: date-time
started_at · variant 2nullfacultatif——
completed_atanyOf<string | null>facultatif——
completed_at · variant 1stringfacultatif—
format: date-time
completed_at · variant 2nullfacultatif——
error_codeanyOf<string | null>facultatif——
error_code · variant 1stringfacultatif——
error_code · variant 2nullfacultatif——
error_messageanyOf<string | null>facultatif——
error_message · variant 1stringfacultatif——
error_message · variant 2nullfacultatif——
tasksobject[]facultatif——
tasks[]objectfacultatif——
tasks[].idstringobligatoire——
tasks[].job_idstringobligatoire——
tasks[].namestringobligatoire——
tasks[].operationstringobligatoire——
tasks[].statusstringobligatoire——
tasks[].progressintegerobligatoire——
tasks[].inputobjectobligatoire——
tasks[].optionsobjectobligatoire——
tasks[].resultobjectobligatoire——
tasks[].requiredbooleanobligatoire——
tasks[].runtime_classstringobligatoire——
tasks[].prioritystringobligatoire——
tasks[].attempt_countintegerobligatoire——
tasks[].max_attemptsintegerobligatoire——
tasks[].error_codeanyOf<string | null>facultatif——
tasks[].error_code · variant 1stringfacultatif——
tasks[].error_code · variant 2nullfacultatif——
tasks[].error_messageanyOf<string | null>facultatif——
tasks[].error_message · variant 1stringfacultatif——
tasks[].error_message · variant 2nullfacultatif——
tasks[].created_atstringobligatoire—
format: date-time
tasks[].queued_atanyOf<string | null>facultatif——
tasks[].queued_at · variant 1stringfacultatif—
format: date-time
tasks[].queued_at · variant 2nullfacultatif——
tasks[].started_atanyOf<string | null>facultatif——
tasks[].started_at · variant 1stringfacultatif—
format: date-time
tasks[].started_at · variant 2nullfacultatif——
tasks[].completed_atanyOf<string | null>facultatif——
tasks[].completed_at · variant 1stringfacultatif—
format: date-time
tasks[].completed_at · variant 2nullfacultatif——
tasks[].attemptsobject[]facultatif——
tasks[].attempts[]objectfacultatif——
tasks[].attempts[].idstringobligatoire——
tasks[].attempts[].attempt_numberintegerobligatoire——
tasks[].attempts[].statusstringobligatoire——
tasks[].attempts[].worker_idanyOf<string | null>facultatif——
tasks[].attempts[].worker_id · variant 1stringfacultatif——
tasks[].attempts[].worker_id · variant 2nullfacultatif——
tasks[].attempts[].runtime_classanyOf<string | null>facultatif——
tasks[].attempts[].runtime_class · variant 1stringfacultatif——
tasks[].attempts[].runtime_class · variant 2nullfacultatif——
tasks[].attempts[].regionanyOf<string | null>facultatif——
tasks[].attempts[].region · variant 1stringfacultatif——
tasks[].attempts[].region · variant 2nullfacultatif——
tasks[].attempts[].engineanyOf<string | null>facultatif——
tasks[].attempts[].engine · variant 1stringfacultatif——
tasks[].attempts[].engine · variant 2nullfacultatif——
tasks[].attempts[].engine_versionanyOf<string | null>facultatif——
tasks[].attempts[].engine_version · variant 1stringfacultatif——
tasks[].attempts[].engine_version · variant 2nullfacultatif——
tasks[].attempts[].input_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].input_bytes · variant 1integerfacultatif——
tasks[].attempts[].input_bytes · variant 2nullfacultatif——
tasks[].attempts[].output_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].output_bytes · variant 1integerfacultatif——
tasks[].attempts[].output_bytes · variant 2nullfacultatif——
tasks[].attempts[].wall_msanyOf<integer | null>facultatif——
tasks[].attempts[].wall_ms · variant 1integerfacultatif——
tasks[].attempts[].wall_ms · variant 2nullfacultatif——
tasks[].attempts[].cpu_msanyOf<integer | null>facultatif——
tasks[].attempts[].cpu_ms · variant 1integerfacultatif——
tasks[].attempts[].cpu_ms · variant 2nullfacultatif——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>facultatif——
tasks[].attempts[].peak_memory_mb · variant 1integerfacultatif——
tasks[].attempts[].peak_memory_mb · variant 2nullfacultatif——
tasks[].attempts[].temp_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].temp_bytes · variant 1integerfacultatif——
tasks[].attempts[].temp_bytes · variant 2nullfacultatif——
tasks[].attempts[].error_codeanyOf<string | null>facultatif——
tasks[].attempts[].error_code · variant 1stringfacultatif——
tasks[].attempts[].error_code · variant 2nullfacultatif——
tasks[].attempts[].error_messageanyOf<string | null>facultatif——
tasks[].attempts[].error_message · variant 1stringfacultatif——
tasks[].attempts[].error_message · variant 2nullfacultatif——
tasks[].attempts[].estimated_creditsanyOf<string | null>facultatif——
tasks[].attempts[].estimated_credits · variant 1stringfacultatif——
tasks[].attempts[].estimated_credits · variant 2nullfacultatif——
tasks[].attempts[].settled_creditsanyOf<string | null>facultatif——
tasks[].attempts[].settled_credits · variant 1stringfacultatif——
tasks[].attempts[].settled_credits · variant 2nullfacultatif——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facultatif——
tasks[].attempts[].external_side_effect_started_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullfacultatif——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facultatif——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacultatif——
tasks[].attempts[].started_atstringobligatoire—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>facultatif——
tasks[].attempts[].completed_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].completed_at · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
job_idpathstringobligatoire—
include_attemptsquerybooleanfacultatif
default: false

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
kindstringobligatoire——
statusstringobligatoire——
progressintegerobligatoire——
taganyOf<string | null>facultatif——
tag · variant 1stringfacultatif——
tag · variant 2nullfacultatif——
client_reference_idanyOf<string | null>facultatif——
client_reference_id · variant 1stringfacultatif——
client_reference_id · variant 2nullfacultatif——
metadataobjectfacultatif——
prioritystringobligatoire——
concurrency_limitintegerfacultatif—
default: 1
originstringobligatoire——
created_atstringobligatoire—
format: date-time
started_atanyOf<string | null>facultatif——
started_at · variant 1stringfacultatif—
format: date-time
started_at · variant 2nullfacultatif——
completed_atanyOf<string | null>facultatif——
completed_at · variant 1stringfacultatif—
format: date-time
completed_at · variant 2nullfacultatif——
error_codeanyOf<string | null>facultatif——
error_code · variant 1stringfacultatif——
error_code · variant 2nullfacultatif——
error_messageanyOf<string | null>facultatif——
error_message · variant 1stringfacultatif——
error_message · variant 2nullfacultatif——
tasksobject[]facultatif——
tasks[]objectfacultatif——
tasks[].idstringobligatoire——
tasks[].job_idstringobligatoire——
tasks[].namestringobligatoire——
tasks[].operationstringobligatoire——
tasks[].statusstringobligatoire——
tasks[].progressintegerobligatoire——
tasks[].inputobjectobligatoire——
tasks[].optionsobjectobligatoire——
tasks[].resultobjectobligatoire——
tasks[].requiredbooleanobligatoire——
tasks[].runtime_classstringobligatoire——
tasks[].prioritystringobligatoire——
tasks[].attempt_countintegerobligatoire——
tasks[].max_attemptsintegerobligatoire——
tasks[].error_codeanyOf<string | null>facultatif——
tasks[].error_code · variant 1stringfacultatif——
tasks[].error_code · variant 2nullfacultatif——
tasks[].error_messageanyOf<string | null>facultatif——
tasks[].error_message · variant 1stringfacultatif——
tasks[].error_message · variant 2nullfacultatif——
tasks[].created_atstringobligatoire—
format: date-time
tasks[].queued_atanyOf<string | null>facultatif——
tasks[].queued_at · variant 1stringfacultatif—
format: date-time
tasks[].queued_at · variant 2nullfacultatif——
tasks[].started_atanyOf<string | null>facultatif——
tasks[].started_at · variant 1stringfacultatif—
format: date-time
tasks[].started_at · variant 2nullfacultatif——
tasks[].completed_atanyOf<string | null>facultatif——
tasks[].completed_at · variant 1stringfacultatif—
format: date-time
tasks[].completed_at · variant 2nullfacultatif——
tasks[].attemptsobject[]facultatif——
tasks[].attempts[]objectfacultatif——
tasks[].attempts[].idstringobligatoire——
tasks[].attempts[].attempt_numberintegerobligatoire——
tasks[].attempts[].statusstringobligatoire——
tasks[].attempts[].worker_idanyOf<string | null>facultatif——
tasks[].attempts[].worker_id · variant 1stringfacultatif——
tasks[].attempts[].worker_id · variant 2nullfacultatif——
tasks[].attempts[].runtime_classanyOf<string | null>facultatif——
tasks[].attempts[].runtime_class · variant 1stringfacultatif——
tasks[].attempts[].runtime_class · variant 2nullfacultatif——
tasks[].attempts[].regionanyOf<string | null>facultatif——
tasks[].attempts[].region · variant 1stringfacultatif——
tasks[].attempts[].region · variant 2nullfacultatif——
tasks[].attempts[].engineanyOf<string | null>facultatif——
tasks[].attempts[].engine · variant 1stringfacultatif——
tasks[].attempts[].engine · variant 2nullfacultatif——
tasks[].attempts[].engine_versionanyOf<string | null>facultatif——
tasks[].attempts[].engine_version · variant 1stringfacultatif——
tasks[].attempts[].engine_version · variant 2nullfacultatif——
tasks[].attempts[].input_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].input_bytes · variant 1integerfacultatif——
tasks[].attempts[].input_bytes · variant 2nullfacultatif——
tasks[].attempts[].output_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].output_bytes · variant 1integerfacultatif——
tasks[].attempts[].output_bytes · variant 2nullfacultatif——
tasks[].attempts[].wall_msanyOf<integer | null>facultatif——
tasks[].attempts[].wall_ms · variant 1integerfacultatif——
tasks[].attempts[].wall_ms · variant 2nullfacultatif——
tasks[].attempts[].cpu_msanyOf<integer | null>facultatif——
tasks[].attempts[].cpu_ms · variant 1integerfacultatif——
tasks[].attempts[].cpu_ms · variant 2nullfacultatif——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>facultatif——
tasks[].attempts[].peak_memory_mb · variant 1integerfacultatif——
tasks[].attempts[].peak_memory_mb · variant 2nullfacultatif——
tasks[].attempts[].temp_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].temp_bytes · variant 1integerfacultatif——
tasks[].attempts[].temp_bytes · variant 2nullfacultatif——
tasks[].attempts[].error_codeanyOf<string | null>facultatif——
tasks[].attempts[].error_code · variant 1stringfacultatif——
tasks[].attempts[].error_code · variant 2nullfacultatif——
tasks[].attempts[].error_messageanyOf<string | null>facultatif——
tasks[].attempts[].error_message · variant 1stringfacultatif——
tasks[].attempts[].error_message · variant 2nullfacultatif——
tasks[].attempts[].estimated_creditsanyOf<string | null>facultatif——
tasks[].attempts[].estimated_credits · variant 1stringfacultatif——
tasks[].attempts[].estimated_credits · variant 2nullfacultatif——
tasks[].attempts[].settled_creditsanyOf<string | null>facultatif——
tasks[].attempts[].settled_credits · variant 1stringfacultatif——
tasks[].attempts[].settled_credits · variant 2nullfacultatif——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facultatif——
tasks[].attempts[].external_side_effect_started_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullfacultatif——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facultatif——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacultatif——
tasks[].attempts[].started_atstringobligatoire—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>facultatif——
tasks[].attempts[].completed_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].completed_at · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
job_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
kindstringobligatoire——
statusstringobligatoire——
progressintegerobligatoire——
taganyOf<string | null>facultatif——
tag · variant 1stringfacultatif——
tag · variant 2nullfacultatif——
client_reference_idanyOf<string | null>facultatif——
client_reference_id · variant 1stringfacultatif——
client_reference_id · variant 2nullfacultatif——
metadataobjectfacultatif——
prioritystringobligatoire——
concurrency_limitintegerfacultatif—
default: 1
originstringobligatoire——
created_atstringobligatoire—
format: date-time
started_atanyOf<string | null>facultatif——
started_at · variant 1stringfacultatif—
format: date-time
started_at · variant 2nullfacultatif——
completed_atanyOf<string | null>facultatif——
completed_at · variant 1stringfacultatif—
format: date-time
completed_at · variant 2nullfacultatif——
error_codeanyOf<string | null>facultatif——
error_code · variant 1stringfacultatif——
error_code · variant 2nullfacultatif——
error_messageanyOf<string | null>facultatif——
error_message · variant 1stringfacultatif——
error_message · variant 2nullfacultatif——
tasksobject[]facultatif——
tasks[]objectfacultatif——
tasks[].idstringobligatoire——
tasks[].job_idstringobligatoire——
tasks[].namestringobligatoire——
tasks[].operationstringobligatoire——
tasks[].statusstringobligatoire——
tasks[].progressintegerobligatoire——
tasks[].inputobjectobligatoire——
tasks[].optionsobjectobligatoire——
tasks[].resultobjectobligatoire——
tasks[].requiredbooleanobligatoire——
tasks[].runtime_classstringobligatoire——
tasks[].prioritystringobligatoire——
tasks[].attempt_countintegerobligatoire——
tasks[].max_attemptsintegerobligatoire——
tasks[].error_codeanyOf<string | null>facultatif——
tasks[].error_code · variant 1stringfacultatif——
tasks[].error_code · variant 2nullfacultatif——
tasks[].error_messageanyOf<string | null>facultatif——
tasks[].error_message · variant 1stringfacultatif——
tasks[].error_message · variant 2nullfacultatif——
tasks[].created_atstringobligatoire—
format: date-time
tasks[].queued_atanyOf<string | null>facultatif——
tasks[].queued_at · variant 1stringfacultatif—
format: date-time
tasks[].queued_at · variant 2nullfacultatif——
tasks[].started_atanyOf<string | null>facultatif——
tasks[].started_at · variant 1stringfacultatif—
format: date-time
tasks[].started_at · variant 2nullfacultatif——
tasks[].completed_atanyOf<string | null>facultatif——
tasks[].completed_at · variant 1stringfacultatif—
format: date-time
tasks[].completed_at · variant 2nullfacultatif——
tasks[].attemptsobject[]facultatif——
tasks[].attempts[]objectfacultatif——
tasks[].attempts[].idstringobligatoire——
tasks[].attempts[].attempt_numberintegerobligatoire——
tasks[].attempts[].statusstringobligatoire——
tasks[].attempts[].worker_idanyOf<string | null>facultatif——
tasks[].attempts[].worker_id · variant 1stringfacultatif——
tasks[].attempts[].worker_id · variant 2nullfacultatif——
tasks[].attempts[].runtime_classanyOf<string | null>facultatif——
tasks[].attempts[].runtime_class · variant 1stringfacultatif——
tasks[].attempts[].runtime_class · variant 2nullfacultatif——
tasks[].attempts[].regionanyOf<string | null>facultatif——
tasks[].attempts[].region · variant 1stringfacultatif——
tasks[].attempts[].region · variant 2nullfacultatif——
tasks[].attempts[].engineanyOf<string | null>facultatif——
tasks[].attempts[].engine · variant 1stringfacultatif——
tasks[].attempts[].engine · variant 2nullfacultatif——
tasks[].attempts[].engine_versionanyOf<string | null>facultatif——
tasks[].attempts[].engine_version · variant 1stringfacultatif——
tasks[].attempts[].engine_version · variant 2nullfacultatif——
tasks[].attempts[].input_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].input_bytes · variant 1integerfacultatif——
tasks[].attempts[].input_bytes · variant 2nullfacultatif——
tasks[].attempts[].output_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].output_bytes · variant 1integerfacultatif——
tasks[].attempts[].output_bytes · variant 2nullfacultatif——
tasks[].attempts[].wall_msanyOf<integer | null>facultatif——
tasks[].attempts[].wall_ms · variant 1integerfacultatif——
tasks[].attempts[].wall_ms · variant 2nullfacultatif——
tasks[].attempts[].cpu_msanyOf<integer | null>facultatif——
tasks[].attempts[].cpu_ms · variant 1integerfacultatif——
tasks[].attempts[].cpu_ms · variant 2nullfacultatif——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>facultatif——
tasks[].attempts[].peak_memory_mb · variant 1integerfacultatif——
tasks[].attempts[].peak_memory_mb · variant 2nullfacultatif——
tasks[].attempts[].temp_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].temp_bytes · variant 1integerfacultatif——
tasks[].attempts[].temp_bytes · variant 2nullfacultatif——
tasks[].attempts[].error_codeanyOf<string | null>facultatif——
tasks[].attempts[].error_code · variant 1stringfacultatif——
tasks[].attempts[].error_code · variant 2nullfacultatif——
tasks[].attempts[].error_messageanyOf<string | null>facultatif——
tasks[].attempts[].error_message · variant 1stringfacultatif——
tasks[].attempts[].error_message · variant 2nullfacultatif——
tasks[].attempts[].estimated_creditsanyOf<string | null>facultatif——
tasks[].attempts[].estimated_credits · variant 1stringfacultatif——
tasks[].attempts[].estimated_credits · variant 2nullfacultatif——
tasks[].attempts[].settled_creditsanyOf<string | null>facultatif——
tasks[].attempts[].settled_credits · variant 1stringfacultatif——
tasks[].attempts[].settled_credits · variant 2nullfacultatif——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facultatif——
tasks[].attempts[].external_side_effect_started_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullfacultatif——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facultatif——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacultatif——
tasks[].attempts[].started_atstringobligatoire—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>facultatif——
tasks[].attempts[].completed_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].completed_at · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
job_idpathstringobligatoire—
timeoutqueryintegerfacultatif
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>facultatif—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
bodyunknownobligatoire——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
job_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
kindstringobligatoire——
statusstringobligatoire——
progressintegerobligatoire——
taganyOf<string | null>facultatif——
tag · variant 1stringfacultatif——
tag · variant 2nullfacultatif——
client_reference_idanyOf<string | null>facultatif——
client_reference_id · variant 1stringfacultatif——
client_reference_id · variant 2nullfacultatif——
metadataobjectfacultatif——
prioritystringobligatoire——
concurrency_limitintegerfacultatif—
default: 1
originstringobligatoire——
created_atstringobligatoire—
format: date-time
started_atanyOf<string | null>facultatif——
started_at · variant 1stringfacultatif—
format: date-time
started_at · variant 2nullfacultatif——
completed_atanyOf<string | null>facultatif——
completed_at · variant 1stringfacultatif—
format: date-time
completed_at · variant 2nullfacultatif——
error_codeanyOf<string | null>facultatif——
error_code · variant 1stringfacultatif——
error_code · variant 2nullfacultatif——
error_messageanyOf<string | null>facultatif——
error_message · variant 1stringfacultatif——
error_message · variant 2nullfacultatif——
tasksobject[]facultatif——
tasks[]objectfacultatif——
tasks[].idstringobligatoire——
tasks[].job_idstringobligatoire——
tasks[].namestringobligatoire——
tasks[].operationstringobligatoire——
tasks[].statusstringobligatoire——
tasks[].progressintegerobligatoire——
tasks[].inputobjectobligatoire——
tasks[].optionsobjectobligatoire——
tasks[].resultobjectobligatoire——
tasks[].requiredbooleanobligatoire——
tasks[].runtime_classstringobligatoire——
tasks[].prioritystringobligatoire——
tasks[].attempt_countintegerobligatoire——
tasks[].max_attemptsintegerobligatoire——
tasks[].error_codeanyOf<string | null>facultatif——
tasks[].error_code · variant 1stringfacultatif——
tasks[].error_code · variant 2nullfacultatif——
tasks[].error_messageanyOf<string | null>facultatif——
tasks[].error_message · variant 1stringfacultatif——
tasks[].error_message · variant 2nullfacultatif——
tasks[].created_atstringobligatoire—
format: date-time
tasks[].queued_atanyOf<string | null>facultatif——
tasks[].queued_at · variant 1stringfacultatif—
format: date-time
tasks[].queued_at · variant 2nullfacultatif——
tasks[].started_atanyOf<string | null>facultatif——
tasks[].started_at · variant 1stringfacultatif—
format: date-time
tasks[].started_at · variant 2nullfacultatif——
tasks[].completed_atanyOf<string | null>facultatif——
tasks[].completed_at · variant 1stringfacultatif—
format: date-time
tasks[].completed_at · variant 2nullfacultatif——
tasks[].attemptsobject[]facultatif——
tasks[].attempts[]objectfacultatif——
tasks[].attempts[].idstringobligatoire——
tasks[].attempts[].attempt_numberintegerobligatoire——
tasks[].attempts[].statusstringobligatoire——
tasks[].attempts[].worker_idanyOf<string | null>facultatif——
tasks[].attempts[].worker_id · variant 1stringfacultatif——
tasks[].attempts[].worker_id · variant 2nullfacultatif——
tasks[].attempts[].runtime_classanyOf<string | null>facultatif——
tasks[].attempts[].runtime_class · variant 1stringfacultatif——
tasks[].attempts[].runtime_class · variant 2nullfacultatif——
tasks[].attempts[].regionanyOf<string | null>facultatif——
tasks[].attempts[].region · variant 1stringfacultatif——
tasks[].attempts[].region · variant 2nullfacultatif——
tasks[].attempts[].engineanyOf<string | null>facultatif——
tasks[].attempts[].engine · variant 1stringfacultatif——
tasks[].attempts[].engine · variant 2nullfacultatif——
tasks[].attempts[].engine_versionanyOf<string | null>facultatif——
tasks[].attempts[].engine_version · variant 1stringfacultatif——
tasks[].attempts[].engine_version · variant 2nullfacultatif——
tasks[].attempts[].input_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].input_bytes · variant 1integerfacultatif——
tasks[].attempts[].input_bytes · variant 2nullfacultatif——
tasks[].attempts[].output_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].output_bytes · variant 1integerfacultatif——
tasks[].attempts[].output_bytes · variant 2nullfacultatif——
tasks[].attempts[].wall_msanyOf<integer | null>facultatif——
tasks[].attempts[].wall_ms · variant 1integerfacultatif——
tasks[].attempts[].wall_ms · variant 2nullfacultatif——
tasks[].attempts[].cpu_msanyOf<integer | null>facultatif——
tasks[].attempts[].cpu_ms · variant 1integerfacultatif——
tasks[].attempts[].cpu_ms · variant 2nullfacultatif——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>facultatif——
tasks[].attempts[].peak_memory_mb · variant 1integerfacultatif——
tasks[].attempts[].peak_memory_mb · variant 2nullfacultatif——
tasks[].attempts[].temp_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].temp_bytes · variant 1integerfacultatif——
tasks[].attempts[].temp_bytes · variant 2nullfacultatif——
tasks[].attempts[].error_codeanyOf<string | null>facultatif——
tasks[].attempts[].error_code · variant 1stringfacultatif——
tasks[].attempts[].error_code · variant 2nullfacultatif——
tasks[].attempts[].error_messageanyOf<string | null>facultatif——
tasks[].attempts[].error_message · variant 1stringfacultatif——
tasks[].attempts[].error_message · variant 2nullfacultatif——
tasks[].attempts[].estimated_creditsanyOf<string | null>facultatif——
tasks[].attempts[].estimated_credits · variant 1stringfacultatif——
tasks[].attempts[].estimated_credits · variant 2nullfacultatif——
tasks[].attempts[].settled_creditsanyOf<string | null>facultatif——
tasks[].attempts[].settled_credits · variant 1stringfacultatif——
tasks[].attempts[].settled_credits · variant 2nullfacultatif——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facultatif——
tasks[].attempts[].external_side_effect_started_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullfacultatif——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facultatif——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacultatif——
tasks[].attempts[].started_atstringobligatoire—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>facultatif——
tasks[].attempts[].completed_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].completed_at · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
job_idpathstringobligatoire—
timeoutqueryintegerfacultatif
default: 20min: 0max: 30

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
kindstringobligatoire——
statusstringobligatoire——
progressintegerobligatoire——
taganyOf<string | null>facultatif——
tag · variant 1stringfacultatif——
tag · variant 2nullfacultatif——
client_reference_idanyOf<string | null>facultatif——
client_reference_id · variant 1stringfacultatif——
client_reference_id · variant 2nullfacultatif——
metadataobjectfacultatif——
prioritystringobligatoire——
concurrency_limitintegerfacultatif—
default: 1
originstringobligatoire——
created_atstringobligatoire—
format: date-time
started_atanyOf<string | null>facultatif——
started_at · variant 1stringfacultatif—
format: date-time
started_at · variant 2nullfacultatif——
completed_atanyOf<string | null>facultatif——
completed_at · variant 1stringfacultatif—
format: date-time
completed_at · variant 2nullfacultatif——
error_codeanyOf<string | null>facultatif——
error_code · variant 1stringfacultatif——
error_code · variant 2nullfacultatif——
error_messageanyOf<string | null>facultatif——
error_message · variant 1stringfacultatif——
error_message · variant 2nullfacultatif——
tasksobject[]facultatif——
tasks[]objectfacultatif——
tasks[].idstringobligatoire——
tasks[].job_idstringobligatoire——
tasks[].namestringobligatoire——
tasks[].operationstringobligatoire——
tasks[].statusstringobligatoire——
tasks[].progressintegerobligatoire——
tasks[].inputobjectobligatoire——
tasks[].optionsobjectobligatoire——
tasks[].resultobjectobligatoire——
tasks[].requiredbooleanobligatoire——
tasks[].runtime_classstringobligatoire——
tasks[].prioritystringobligatoire——
tasks[].attempt_countintegerobligatoire——
tasks[].max_attemptsintegerobligatoire——
tasks[].error_codeanyOf<string | null>facultatif——
tasks[].error_code · variant 1stringfacultatif——
tasks[].error_code · variant 2nullfacultatif——
tasks[].error_messageanyOf<string | null>facultatif——
tasks[].error_message · variant 1stringfacultatif——
tasks[].error_message · variant 2nullfacultatif——
tasks[].created_atstringobligatoire—
format: date-time
tasks[].queued_atanyOf<string | null>facultatif——
tasks[].queued_at · variant 1stringfacultatif—
format: date-time
tasks[].queued_at · variant 2nullfacultatif——
tasks[].started_atanyOf<string | null>facultatif——
tasks[].started_at · variant 1stringfacultatif—
format: date-time
tasks[].started_at · variant 2nullfacultatif——
tasks[].completed_atanyOf<string | null>facultatif——
tasks[].completed_at · variant 1stringfacultatif—
format: date-time
tasks[].completed_at · variant 2nullfacultatif——
tasks[].attemptsobject[]facultatif——
tasks[].attempts[]objectfacultatif——
tasks[].attempts[].idstringobligatoire——
tasks[].attempts[].attempt_numberintegerobligatoire——
tasks[].attempts[].statusstringobligatoire——
tasks[].attempts[].worker_idanyOf<string | null>facultatif——
tasks[].attempts[].worker_id · variant 1stringfacultatif——
tasks[].attempts[].worker_id · variant 2nullfacultatif——
tasks[].attempts[].runtime_classanyOf<string | null>facultatif——
tasks[].attempts[].runtime_class · variant 1stringfacultatif——
tasks[].attempts[].runtime_class · variant 2nullfacultatif——
tasks[].attempts[].regionanyOf<string | null>facultatif——
tasks[].attempts[].region · variant 1stringfacultatif——
tasks[].attempts[].region · variant 2nullfacultatif——
tasks[].attempts[].engineanyOf<string | null>facultatif——
tasks[].attempts[].engine · variant 1stringfacultatif——
tasks[].attempts[].engine · variant 2nullfacultatif——
tasks[].attempts[].engine_versionanyOf<string | null>facultatif——
tasks[].attempts[].engine_version · variant 1stringfacultatif——
tasks[].attempts[].engine_version · variant 2nullfacultatif——
tasks[].attempts[].input_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].input_bytes · variant 1integerfacultatif——
tasks[].attempts[].input_bytes · variant 2nullfacultatif——
tasks[].attempts[].output_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].output_bytes · variant 1integerfacultatif——
tasks[].attempts[].output_bytes · variant 2nullfacultatif——
tasks[].attempts[].wall_msanyOf<integer | null>facultatif——
tasks[].attempts[].wall_ms · variant 1integerfacultatif——
tasks[].attempts[].wall_ms · variant 2nullfacultatif——
tasks[].attempts[].cpu_msanyOf<integer | null>facultatif——
tasks[].attempts[].cpu_ms · variant 1integerfacultatif——
tasks[].attempts[].cpu_ms · variant 2nullfacultatif——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>facultatif——
tasks[].attempts[].peak_memory_mb · variant 1integerfacultatif——
tasks[].attempts[].peak_memory_mb · variant 2nullfacultatif——
tasks[].attempts[].temp_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].temp_bytes · variant 1integerfacultatif——
tasks[].attempts[].temp_bytes · variant 2nullfacultatif——
tasks[].attempts[].error_codeanyOf<string | null>facultatif——
tasks[].attempts[].error_code · variant 1stringfacultatif——
tasks[].attempts[].error_code · variant 2nullfacultatif——
tasks[].attempts[].error_messageanyOf<string | null>facultatif——
tasks[].attempts[].error_message · variant 1stringfacultatif——
tasks[].attempts[].error_message · variant 2nullfacultatif——
tasks[].attempts[].estimated_creditsanyOf<string | null>facultatif——
tasks[].attempts[].estimated_credits · variant 1stringfacultatif——
tasks[].attempts[].estimated_credits · variant 2nullfacultatif——
tasks[].attempts[].settled_creditsanyOf<string | null>facultatif——
tasks[].attempts[].settled_credits · variant 1stringfacultatif——
tasks[].attempts[].settled_credits · variant 2nullfacultatif——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facultatif——
tasks[].attempts[].external_side_effect_started_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullfacultatif——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facultatif——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacultatif——
tasks[].attempts[].started_atstringobligatoire—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>facultatif——
tasks[].attempts[].completed_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].completed_at · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
tasksobjectobligatoire——
taganyOf<string | null>facultatif——
tag · variant 1stringfacultatif—
max length: 255
tag · variant 2nullfacultatif——
client_reference_idanyOf<string | null>facultatif——
client_reference_id · variant 1stringfacultatif—
max length: 255
client_reference_id · variant 2nullfacultatif——
metadataobjectfacultatif——
prioritystringfacultatif—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>facultatif——
retention_seconds · variant 1integerfacultatif—
min: 0max: 86400
retention_seconds · variant 2nullfacultatif——

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
validbooleanobligatoire——
task_countintegerobligatoire——
execution_orderstring[]obligatoire——
root_tasksstring[]obligatoire——
warningsstring[]facultatif——
estimated_creditsanyOf<object | null>facultatif——
estimated_credits · variant 1objectfacultatif——
estimated_credits · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
limitqueryintegerfacultatif
default: 50min: 1max: 200
afterqueryanyOf<string | null>facultatif—
status_codequeryanyOf<integer | null>facultatif—
path_prefixqueryanyOf<string | null>facultatif—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
dataobject[]obligatoire——
data[]objectfacultatif——
data[].request_idstringobligatoire——
data[].methodstringobligatoire——
data[].pathstringobligatoire——
data[].status_codeintegerobligatoire——
data[].latency_msintegerobligatoire——
data[].api_key_idanyOf<string | null>facultatif——
data[].api_key_id · variant 1stringfacultatif——
data[].api_key_id · variant 2nullfacultatif——
data[].auth_typestringobligatoire——
data[].user_agentanyOf<string | null>facultatif——
data[].user_agent · variant 1stringfacultatif——
data[].user_agent · variant 2nullfacultatif——
data[].created_atstringobligatoire——
paginationobjectobligatoire——
pagination.nextanyOf<string | null>facultatif——
pagination.next · variant 1stringfacultatif——
pagination.next · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
request_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
request_idstringobligatoire——
methodstringobligatoire——
pathstringobligatoire——
status_codeintegerobligatoire——
latency_msintegerobligatoire——
api_key_idanyOf<string | null>facultatif——
api_key_id · variant 1stringfacultatif——
api_key_id · variant 2nullfacultatif——
auth_typestringobligatoire——
user_agentanyOf<string | null>facultatif——
user_agent · variant 1stringfacultatif——
user_agent · variant 2nullfacultatif——
created_atstringobligatoire——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
account_idstringobligatoire——
actor_idstringobligatoire——
auth_typestringobligatoire——
environmentstringobligatoire——
access_tierstringfacultatif—
enum: "sandbox", "paid"default: "paid"
scopesstring[]obligatoire——
roleanyOf<string | null>facultatif——
role · variant 1stringfacultatif——
role · variant 2nullfacultatif——
authorized_partyanyOf<string | null>facultatif——
authorized_party · variant 1stringfacultatif——
authorized_party · variant 2nullfacultatif——
limitsanyOf<object | null>facultatif——
limits · variant 1objectfacultatif——
limits · variant 1.monthly_callsanyOf<integer | null>facultatif——
limits · variant 1.monthly_calls · variant 1integerfacultatif——
limits · variant 1.monthly_calls · variant 2nullfacultatif——
limits · variant 1.rate_limit_per_minuteanyOf<integer | null>facultatif——
limits · variant 1.rate_limit_per_minute · variant 1integerfacultatif——
limits · variant 1.rate_limit_per_minute · variant 2nullfacultatif——
limits · variant 1.daily_requestsanyOf<integer | null>facultatif——
limits · variant 1.daily_requests · variant 1integerfacultatif——
limits · variant 1.daily_requests · variant 2nullfacultatif——
limits · variant 1.concurrencyanyOf<integer | null>facultatif——
limits · variant 1.concurrency · variant 1integerfacultatif——
limits · variant 1.concurrency · variant 2nullfacultatif——
limits · variant 1.max_file_mbanyOf<integer | null>facultatif——
limits · variant 1.max_file_mb · variant 1integerfacultatif——
limits · variant 1.max_file_mb · variant 2nullfacultatif——
limits · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
GET/v1/operationsOperationsDiscovery#

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

AuthentificationPublic / aucune sécurité propre à l’opération

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
dataobject[]obligatoire——
data[]objectfacultatif——
data[].operationstringobligatoire——
data[].categorystringobligatoire—
enum: "import", "processing", "export"
data[].descriptionstringobligatoire——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
account_idstringobligatoire——
environmentstringobligatoire——
scopedbooleanobligatoire——
project_idanyOf<string | null>facultatif——
project_id · variant 1stringfacultatif——
project_id · variant 2nullfacultatif——
project_nameanyOf<string | null>facultatif——
project_name · variant 1stringfacultatif——
project_name · variant 2nullfacultatif——
project_sluganyOf<string | null>facultatif——
project_slug · variant 1stringfacultatif——
project_slug · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
GET/v1/project/legacy-migrationPreview Legacy MigrationAuthentication · Projects#

Preview account/environment resources still in the legacy namespace.

Authentification
ConverterHQBearerhttp / bearer

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
bodyobjectobligatoire——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
POST/v1/project/legacy-migrationMigrate Legacy Project ResourcesAuthentication · Projects#

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

Authentification
ConverterHQBearerhttp / bearer

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
confirm_project_idstringobligatoire—
min length: 1max length: 64

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
bodyobjectobligatoire——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
tokenstringobligatoire——
expires_atstringobligatoire—
format: date-time
websocket_urlstringobligatoire——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
bodyobjectobligatoire——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
fixture_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
bodyobjectobligatoire——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
bodyobject[]obligatoire——
items[]objectfacultatif——
items[].idstringobligatoire——
items[].namestringobligatoire——
items[].workflow_idanyOf<string | null>facultatif——
items[].workflow_id · variant 1stringfacultatif——
items[].workflow_id · variant 2nullfacultatif——
items[].workflow_versionanyOf<integer | null>facultatif——
items[].workflow_version · variant 1integerfacultatif——
items[].workflow_version · variant 2nullfacultatif——
items[].inline_definitionanyOf<object | null>facultatif——
items[].inline_definition · variant 1objectfacultatif——
items[].inline_definition · variant 2nullfacultatif——
items[].variables_schemaobjectobligatoire——
items[].allowed_source_hostsstring[]obligatoire——
items[].max_file_size_bytesanyOf<integer | null>facultatif——
items[].max_file_size_bytes · variant 1integerfacultatif——
items[].max_file_size_bytes · variant 2nullfacultatif——
items[].max_credits_per_requestanyOf<string | null>facultatif——
items[].max_credits_per_request · variant 1stringfacultatif——
items[].max_credits_per_request · variant 2nullfacultatif——
items[].max_usesanyOf<integer | null>facultatif——
items[].max_uses · variant 1integerfacultatif——
items[].max_uses · variant 2nullfacultatif——
items[].use_countintegerobligatoire——
items[].cache_ttl_secondsintegerobligatoire——
items[].enabledbooleanobligatoire——
items[].created_atstringobligatoire—
format: date-time
items[].updated_atstringobligatoire—
format: date-time
items[].signing_secretanyOf<string | null>facultatif——
items[].signing_secret · variant 1stringfacultatif——
items[].signing_secret · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
namestringobligatoire—
min length: 1max length: 255
workflow_idanyOf<string | null>facultatif——
workflow_id · variant 1stringfacultatif——
workflow_id · variant 2nullfacultatif——
inline_definitionanyOf<object | null>facultatif——
inline_definition · variant 1objectfacultatif——
inline_definition · variant 1.tasksobjectobligatoire——
inline_definition · variant 1.taganyOf<string | null>facultatif——
inline_definition · variant 1.tag · variant 1stringfacultatif—
max length: 255
inline_definition · variant 1.tag · variant 2nullfacultatif——
inline_definition · variant 1.client_reference_idanyOf<string | null>facultatif——
inline_definition · variant 1.client_reference_id · variant 1stringfacultatif—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nullfacultatif——
inline_definition · variant 1.metadataobjectfacultatif——
inline_definition · variant 1.prioritystringfacultatif—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>facultatif——
inline_definition · variant 1.retention_seconds · variant 1integerfacultatif—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nullfacultatif——
inline_definition · variant 2nullfacultatif——
variables_schemaobjectfacultatif——
allowed_source_hostsstring[]facultatif——
max_file_size_bytesanyOf<integer | null>facultatif——
max_file_size_bytes · variant 1integerfacultatif——
max_file_size_bytes · variant 2nullfacultatif——
max_credits_per_requestanyOf<string | null>facultatif——
max_credits_per_request · variant 1stringfacultatif—
max length: 64
max_credits_per_request · variant 2nullfacultatif——
max_usesanyOf<integer | null>facultatif——
max_uses · variant 1integerfacultatif——
max_uses · variant 2nullfacultatif——
cache_ttl_secondsintegerfacultatif—
default: 0min: 0max: 86400

Réponses

201Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
namestringobligatoire——
workflow_idanyOf<string | null>facultatif——
workflow_id · variant 1stringfacultatif——
workflow_id · variant 2nullfacultatif——
workflow_versionanyOf<integer | null>facultatif——
workflow_version · variant 1integerfacultatif——
workflow_version · variant 2nullfacultatif——
inline_definitionanyOf<object | null>facultatif——
inline_definition · variant 1objectfacultatif——
inline_definition · variant 2nullfacultatif——
variables_schemaobjectobligatoire——
allowed_source_hostsstring[]obligatoire——
max_file_size_bytesanyOf<integer | null>facultatif——
max_file_size_bytes · variant 1integerfacultatif——
max_file_size_bytes · variant 2nullfacultatif——
max_credits_per_requestanyOf<string | null>facultatif——
max_credits_per_request · variant 1stringfacultatif——
max_credits_per_request · variant 2nullfacultatif——
max_usesanyOf<integer | null>facultatif——
max_uses · variant 1integerfacultatif——
max_uses · variant 2nullfacultatif——
use_countintegerobligatoire——
cache_ttl_secondsintegerobligatoire——
enabledbooleanobligatoire——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
signing_secretanyOf<string | null>facultatif——
signing_secret · variant 1stringfacultatif——
signing_secret · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
base_idpathstringobligatoire—

Réponses

204Successful Response

Aucun corps de réponse.

400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
base_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
namestringobligatoire——
workflow_idanyOf<string | null>facultatif——
workflow_id · variant 1stringfacultatif——
workflow_id · variant 2nullfacultatif——
workflow_versionanyOf<integer | null>facultatif——
workflow_version · variant 1integerfacultatif——
workflow_version · variant 2nullfacultatif——
inline_definitionanyOf<object | null>facultatif——
inline_definition · variant 1objectfacultatif——
inline_definition · variant 2nullfacultatif——
variables_schemaobjectobligatoire——
allowed_source_hostsstring[]obligatoire——
max_file_size_bytesanyOf<integer | null>facultatif——
max_file_size_bytes · variant 1integerfacultatif——
max_file_size_bytes · variant 2nullfacultatif——
max_credits_per_requestanyOf<string | null>facultatif——
max_credits_per_request · variant 1stringfacultatif——
max_credits_per_request · variant 2nullfacultatif——
max_usesanyOf<integer | null>facultatif——
max_uses · variant 1integerfacultatif——
max_uses · variant 2nullfacultatif——
use_countintegerobligatoire——
cache_ttl_secondsintegerobligatoire——
enabledbooleanobligatoire——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
signing_secretanyOf<string | null>facultatif——
signing_secret · variant 1stringfacultatif——
signing_secret · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
base_idpathstringobligatoire—

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
nameanyOf<string | null>facultatif——
name · variant 1stringfacultatif—
min length: 1max length: 255
name · variant 2nullfacultatif——
workflow_idanyOf<string | null>facultatif——
workflow_id · variant 1stringfacultatif——
workflow_id · variant 2nullfacultatif——
inline_definitionanyOf<object | null>facultatif——
inline_definition · variant 1objectfacultatif——
inline_definition · variant 1.tasksobjectobligatoire——
inline_definition · variant 1.taganyOf<string | null>facultatif——
inline_definition · variant 1.tag · variant 1stringfacultatif—
max length: 255
inline_definition · variant 1.tag · variant 2nullfacultatif——
inline_definition · variant 1.client_reference_idanyOf<string | null>facultatif——
inline_definition · variant 1.client_reference_id · variant 1stringfacultatif—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nullfacultatif——
inline_definition · variant 1.metadataobjectfacultatif——
inline_definition · variant 1.prioritystringfacultatif—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>facultatif——
inline_definition · variant 1.retention_seconds · variant 1integerfacultatif—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nullfacultatif——
inline_definition · variant 2nullfacultatif——
variables_schemaanyOf<object | null>facultatif——
variables_schema · variant 1objectfacultatif——
variables_schema · variant 2nullfacultatif——
allowed_source_hostsanyOf<string[] | null>facultatif——
allowed_source_hosts · variant 1string[]facultatif——
allowed_source_hosts · variant 2nullfacultatif——
max_file_size_bytesanyOf<integer | null>facultatif——
max_file_size_bytes · variant 1integerfacultatif——
max_file_size_bytes · variant 2nullfacultatif——
max_credits_per_requestanyOf<string | null>facultatif——
max_credits_per_request · variant 1stringfacultatif—
max length: 64
max_credits_per_request · variant 2nullfacultatif——
max_usesanyOf<integer | null>facultatif——
max_uses · variant 1integerfacultatif——
max_uses · variant 2nullfacultatif——
cache_ttl_secondsanyOf<integer | null>facultatif——
cache_ttl_seconds · variant 1integerfacultatif—
min: 0max: 86400
cache_ttl_seconds · variant 2nullfacultatif——
enabledanyOf<boolean | null>facultatif——
enabled · variant 1booleanfacultatif——
enabled · variant 2nullfacultatif——

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
namestringobligatoire——
workflow_idanyOf<string | null>facultatif——
workflow_id · variant 1stringfacultatif——
workflow_id · variant 2nullfacultatif——
workflow_versionanyOf<integer | null>facultatif——
workflow_version · variant 1integerfacultatif——
workflow_version · variant 2nullfacultatif——
inline_definitionanyOf<object | null>facultatif——
inline_definition · variant 1objectfacultatif——
inline_definition · variant 2nullfacultatif——
variables_schemaobjectobligatoire——
allowed_source_hostsstring[]obligatoire——
max_file_size_bytesanyOf<integer | null>facultatif——
max_file_size_bytes · variant 1integerfacultatif——
max_file_size_bytes · variant 2nullfacultatif——
max_credits_per_requestanyOf<string | null>facultatif——
max_credits_per_request · variant 1stringfacultatif——
max_credits_per_request · variant 2nullfacultatif——
max_usesanyOf<integer | null>facultatif——
max_uses · variant 1integerfacultatif——
max_uses · variant 2nullfacultatif——
use_countintegerobligatoire——
cache_ttl_secondsintegerobligatoire——
enabledbooleanobligatoire——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
signing_secretanyOf<string | null>facultatif——
signing_secret · variant 1stringfacultatif——
signing_secret · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
base_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
namestringobligatoire——
workflow_idanyOf<string | null>facultatif——
workflow_id · variant 1stringfacultatif——
workflow_id · variant 2nullfacultatif——
workflow_versionanyOf<integer | null>facultatif——
workflow_version · variant 1integerfacultatif——
workflow_version · variant 2nullfacultatif——
inline_definitionanyOf<object | null>facultatif——
inline_definition · variant 1objectfacultatif——
inline_definition · variant 2nullfacultatif——
variables_schemaobjectobligatoire——
allowed_source_hostsstring[]obligatoire——
max_file_size_bytesanyOf<integer | null>facultatif——
max_file_size_bytes · variant 1integerfacultatif——
max_file_size_bytes · variant 2nullfacultatif——
max_credits_per_requestanyOf<string | null>facultatif——
max_credits_per_request · variant 1stringfacultatif——
max_credits_per_request · variant 2nullfacultatif——
max_usesanyOf<integer | null>facultatif——
max_uses · variant 1integerfacultatif——
max_uses · variant 2nullfacultatif——
use_countintegerobligatoire——
cache_ttl_secondsintegerobligatoire——
enabledbooleanobligatoire——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
signing_secretanyOf<string | null>facultatif——
signing_secret · variant 1stringfacultatif——
signing_secret · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
base_idpathstringobligatoire—

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
variablesobjectfacultatif——
expires_inintegerfacultatif—
default: 3600min: 60max: 86400
cache_keyanyOf<string | null>facultatif——
cache_key · variant 1stringfacultatif—
max length: 255
cache_key · variant 2nullfacultatif——

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
urlstringobligatoire——
expires_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

AuthentificationPublic / aucune sécurité propre à l’opération

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
statusstringobligatoire—
enum: "ok", "degraded"
servicestringfacultatif—
default: "converterhq-api"
api_versionstringfacultatif—
default: "v1"
timestampstringobligatoire—
format: date-time
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

AuthentificationPublic / aucune sécurité propre à l’opération

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
successful_conversionsintegerobligatoire——
input_bytes_processedintegerobligatoire——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
task_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
job_idstringobligatoire——
namestringobligatoire——
operationstringobligatoire——
statusstringobligatoire——
progressintegerobligatoire——
inputobjectobligatoire——
optionsobjectobligatoire——
resultobjectobligatoire——
requiredbooleanobligatoire——
runtime_classstringobligatoire——
prioritystringobligatoire——
attempt_countintegerobligatoire——
max_attemptsintegerobligatoire——
error_codeanyOf<string | null>facultatif——
error_code · variant 1stringfacultatif——
error_code · variant 2nullfacultatif——
error_messageanyOf<string | null>facultatif——
error_message · variant 1stringfacultatif——
error_message · variant 2nullfacultatif——
created_atstringobligatoire—
format: date-time
queued_atanyOf<string | null>facultatif——
queued_at · variant 1stringfacultatif—
format: date-time
queued_at · variant 2nullfacultatif——
started_atanyOf<string | null>facultatif——
started_at · variant 1stringfacultatif—
format: date-time
started_at · variant 2nullfacultatif——
completed_atanyOf<string | null>facultatif——
completed_at · variant 1stringfacultatif—
format: date-time
completed_at · variant 2nullfacultatif——
attemptsobject[]facultatif——
attempts[]objectfacultatif——
attempts[].idstringobligatoire——
attempts[].attempt_numberintegerobligatoire——
attempts[].statusstringobligatoire——
attempts[].worker_idanyOf<string | null>facultatif——
attempts[].worker_id · variant 1stringfacultatif——
attempts[].worker_id · variant 2nullfacultatif——
attempts[].runtime_classanyOf<string | null>facultatif——
attempts[].runtime_class · variant 1stringfacultatif——
attempts[].runtime_class · variant 2nullfacultatif——
attempts[].regionanyOf<string | null>facultatif——
attempts[].region · variant 1stringfacultatif——
attempts[].region · variant 2nullfacultatif——
attempts[].engineanyOf<string | null>facultatif——
attempts[].engine · variant 1stringfacultatif——
attempts[].engine · variant 2nullfacultatif——
attempts[].engine_versionanyOf<string | null>facultatif——
attempts[].engine_version · variant 1stringfacultatif——
attempts[].engine_version · variant 2nullfacultatif——
attempts[].input_bytesanyOf<integer | null>facultatif——
attempts[].input_bytes · variant 1integerfacultatif——
attempts[].input_bytes · variant 2nullfacultatif——
attempts[].output_bytesanyOf<integer | null>facultatif——
attempts[].output_bytes · variant 1integerfacultatif——
attempts[].output_bytes · variant 2nullfacultatif——
attempts[].wall_msanyOf<integer | null>facultatif——
attempts[].wall_ms · variant 1integerfacultatif——
attempts[].wall_ms · variant 2nullfacultatif——
attempts[].cpu_msanyOf<integer | null>facultatif——
attempts[].cpu_ms · variant 1integerfacultatif——
attempts[].cpu_ms · variant 2nullfacultatif——
attempts[].peak_memory_mbanyOf<integer | null>facultatif——
attempts[].peak_memory_mb · variant 1integerfacultatif——
attempts[].peak_memory_mb · variant 2nullfacultatif——
attempts[].temp_bytesanyOf<integer | null>facultatif——
attempts[].temp_bytes · variant 1integerfacultatif——
attempts[].temp_bytes · variant 2nullfacultatif——
attempts[].error_codeanyOf<string | null>facultatif——
attempts[].error_code · variant 1stringfacultatif——
attempts[].error_code · variant 2nullfacultatif——
attempts[].error_messageanyOf<string | null>facultatif——
attempts[].error_message · variant 1stringfacultatif——
attempts[].error_message · variant 2nullfacultatif——
attempts[].estimated_creditsanyOf<string | null>facultatif——
attempts[].estimated_credits · variant 1stringfacultatif——
attempts[].estimated_credits · variant 2nullfacultatif——
attempts[].settled_creditsanyOf<string | null>facultatif——
attempts[].settled_credits · variant 1stringfacultatif——
attempts[].settled_credits · variant 2nullfacultatif——
attempts[].external_side_effect_started_atanyOf<string | null>facultatif——
attempts[].external_side_effect_started_at · variant 1stringfacultatif—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullfacultatif——
attempts[].external_side_effect_committed_atanyOf<string | null>facultatif——
attempts[].external_side_effect_committed_at · variant 1stringfacultatif—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullfacultatif——
attempts[].started_atstringobligatoire—
format: date-time
attempts[].completed_atanyOf<string | null>facultatif——
attempts[].completed_at · variant 1stringfacultatif—
format: date-time
attempts[].completed_at · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
task_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
job_idstringobligatoire——
namestringobligatoire——
operationstringobligatoire——
statusstringobligatoire——
progressintegerobligatoire——
inputobjectobligatoire——
optionsobjectobligatoire——
resultobjectobligatoire——
requiredbooleanobligatoire——
runtime_classstringobligatoire——
prioritystringobligatoire——
attempt_countintegerobligatoire——
max_attemptsintegerobligatoire——
error_codeanyOf<string | null>facultatif——
error_code · variant 1stringfacultatif——
error_code · variant 2nullfacultatif——
error_messageanyOf<string | null>facultatif——
error_message · variant 1stringfacultatif——
error_message · variant 2nullfacultatif——
created_atstringobligatoire—
format: date-time
queued_atanyOf<string | null>facultatif——
queued_at · variant 1stringfacultatif—
format: date-time
queued_at · variant 2nullfacultatif——
started_atanyOf<string | null>facultatif——
started_at · variant 1stringfacultatif—
format: date-time
started_at · variant 2nullfacultatif——
completed_atanyOf<string | null>facultatif——
completed_at · variant 1stringfacultatif—
format: date-time
completed_at · variant 2nullfacultatif——
attemptsobject[]facultatif——
attempts[]objectfacultatif——
attempts[].idstringobligatoire——
attempts[].attempt_numberintegerobligatoire——
attempts[].statusstringobligatoire——
attempts[].worker_idanyOf<string | null>facultatif——
attempts[].worker_id · variant 1stringfacultatif——
attempts[].worker_id · variant 2nullfacultatif——
attempts[].runtime_classanyOf<string | null>facultatif——
attempts[].runtime_class · variant 1stringfacultatif——
attempts[].runtime_class · variant 2nullfacultatif——
attempts[].regionanyOf<string | null>facultatif——
attempts[].region · variant 1stringfacultatif——
attempts[].region · variant 2nullfacultatif——
attempts[].engineanyOf<string | null>facultatif——
attempts[].engine · variant 1stringfacultatif——
attempts[].engine · variant 2nullfacultatif——
attempts[].engine_versionanyOf<string | null>facultatif——
attempts[].engine_version · variant 1stringfacultatif——
attempts[].engine_version · variant 2nullfacultatif——
attempts[].input_bytesanyOf<integer | null>facultatif——
attempts[].input_bytes · variant 1integerfacultatif——
attempts[].input_bytes · variant 2nullfacultatif——
attempts[].output_bytesanyOf<integer | null>facultatif——
attempts[].output_bytes · variant 1integerfacultatif——
attempts[].output_bytes · variant 2nullfacultatif——
attempts[].wall_msanyOf<integer | null>facultatif——
attempts[].wall_ms · variant 1integerfacultatif——
attempts[].wall_ms · variant 2nullfacultatif——
attempts[].cpu_msanyOf<integer | null>facultatif——
attempts[].cpu_ms · variant 1integerfacultatif——
attempts[].cpu_ms · variant 2nullfacultatif——
attempts[].peak_memory_mbanyOf<integer | null>facultatif——
attempts[].peak_memory_mb · variant 1integerfacultatif——
attempts[].peak_memory_mb · variant 2nullfacultatif——
attempts[].temp_bytesanyOf<integer | null>facultatif——
attempts[].temp_bytes · variant 1integerfacultatif——
attempts[].temp_bytes · variant 2nullfacultatif——
attempts[].error_codeanyOf<string | null>facultatif——
attempts[].error_code · variant 1stringfacultatif——
attempts[].error_code · variant 2nullfacultatif——
attempts[].error_messageanyOf<string | null>facultatif——
attempts[].error_message · variant 1stringfacultatif——
attempts[].error_message · variant 2nullfacultatif——
attempts[].estimated_creditsanyOf<string | null>facultatif——
attempts[].estimated_credits · variant 1stringfacultatif——
attempts[].estimated_credits · variant 2nullfacultatif——
attempts[].settled_creditsanyOf<string | null>facultatif——
attempts[].settled_credits · variant 1stringfacultatif——
attempts[].settled_credits · variant 2nullfacultatif——
attempts[].external_side_effect_started_atanyOf<string | null>facultatif——
attempts[].external_side_effect_started_at · variant 1stringfacultatif—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullfacultatif——
attempts[].external_side_effect_committed_atanyOf<string | null>facultatif——
attempts[].external_side_effect_committed_at · variant 1stringfacultatif—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullfacultatif——
attempts[].started_atstringobligatoire—
format: date-time
attempts[].completed_atanyOf<string | null>facultatif——
attempts[].completed_at · variant 1stringfacultatif—
format: date-time
attempts[].completed_at · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
task_idpathstringobligatoire—
timeoutqueryintegerfacultatif
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>facultatif—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
bodyunknownobligatoire——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
task_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
job_idstringobligatoire——
namestringobligatoire——
operationstringobligatoire——
statusstringobligatoire——
progressintegerobligatoire——
inputobjectobligatoire——
optionsobjectobligatoire——
resultobjectobligatoire——
requiredbooleanobligatoire——
runtime_classstringobligatoire——
prioritystringobligatoire——
attempt_countintegerobligatoire——
max_attemptsintegerobligatoire——
error_codeanyOf<string | null>facultatif——
error_code · variant 1stringfacultatif——
error_code · variant 2nullfacultatif——
error_messageanyOf<string | null>facultatif——
error_message · variant 1stringfacultatif——
error_message · variant 2nullfacultatif——
created_atstringobligatoire—
format: date-time
queued_atanyOf<string | null>facultatif——
queued_at · variant 1stringfacultatif—
format: date-time
queued_at · variant 2nullfacultatif——
started_atanyOf<string | null>facultatif——
started_at · variant 1stringfacultatif—
format: date-time
started_at · variant 2nullfacultatif——
completed_atanyOf<string | null>facultatif——
completed_at · variant 1stringfacultatif—
format: date-time
completed_at · variant 2nullfacultatif——
attemptsobject[]facultatif——
attempts[]objectfacultatif——
attempts[].idstringobligatoire——
attempts[].attempt_numberintegerobligatoire——
attempts[].statusstringobligatoire——
attempts[].worker_idanyOf<string | null>facultatif——
attempts[].worker_id · variant 1stringfacultatif——
attempts[].worker_id · variant 2nullfacultatif——
attempts[].runtime_classanyOf<string | null>facultatif——
attempts[].runtime_class · variant 1stringfacultatif——
attempts[].runtime_class · variant 2nullfacultatif——
attempts[].regionanyOf<string | null>facultatif——
attempts[].region · variant 1stringfacultatif——
attempts[].region · variant 2nullfacultatif——
attempts[].engineanyOf<string | null>facultatif——
attempts[].engine · variant 1stringfacultatif——
attempts[].engine · variant 2nullfacultatif——
attempts[].engine_versionanyOf<string | null>facultatif——
attempts[].engine_version · variant 1stringfacultatif——
attempts[].engine_version · variant 2nullfacultatif——
attempts[].input_bytesanyOf<integer | null>facultatif——
attempts[].input_bytes · variant 1integerfacultatif——
attempts[].input_bytes · variant 2nullfacultatif——
attempts[].output_bytesanyOf<integer | null>facultatif——
attempts[].output_bytes · variant 1integerfacultatif——
attempts[].output_bytes · variant 2nullfacultatif——
attempts[].wall_msanyOf<integer | null>facultatif——
attempts[].wall_ms · variant 1integerfacultatif——
attempts[].wall_ms · variant 2nullfacultatif——
attempts[].cpu_msanyOf<integer | null>facultatif——
attempts[].cpu_ms · variant 1integerfacultatif——
attempts[].cpu_ms · variant 2nullfacultatif——
attempts[].peak_memory_mbanyOf<integer | null>facultatif——
attempts[].peak_memory_mb · variant 1integerfacultatif——
attempts[].peak_memory_mb · variant 2nullfacultatif——
attempts[].temp_bytesanyOf<integer | null>facultatif——
attempts[].temp_bytes · variant 1integerfacultatif——
attempts[].temp_bytes · variant 2nullfacultatif——
attempts[].error_codeanyOf<string | null>facultatif——
attempts[].error_code · variant 1stringfacultatif——
attempts[].error_code · variant 2nullfacultatif——
attempts[].error_messageanyOf<string | null>facultatif——
attempts[].error_message · variant 1stringfacultatif——
attempts[].error_message · variant 2nullfacultatif——
attempts[].estimated_creditsanyOf<string | null>facultatif——
attempts[].estimated_credits · variant 1stringfacultatif——
attempts[].estimated_credits · variant 2nullfacultatif——
attempts[].settled_creditsanyOf<string | null>facultatif——
attempts[].settled_credits · variant 1stringfacultatif——
attempts[].settled_credits · variant 2nullfacultatif——
attempts[].external_side_effect_started_atanyOf<string | null>facultatif——
attempts[].external_side_effect_started_at · variant 1stringfacultatif—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullfacultatif——
attempts[].external_side_effect_committed_atanyOf<string | null>facultatif——
attempts[].external_side_effect_committed_at · variant 1stringfacultatif—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullfacultatif——
attempts[].started_atstringobligatoire—
format: date-time
attempts[].completed_atanyOf<string | null>facultatif——
attempts[].completed_at · variant 1stringfacultatif—
format: date-time
attempts[].completed_at · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
limitqueryintegerfacultatif
default: 50min: 1max: 200
afterqueryanyOf<string | null>facultatif—
input_formatqueryanyOf<string | null>facultatif—
output_formatqueryanyOf<string | null>facultatif—
originqueryanyOf<string | null>facultatif—
outcomequeryanyOf<string | null>facultatif—
job_idqueryanyOf<string | null>facultatif—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
dataobject[]obligatoire——
data[]objectfacultatif——
data[].idstringobligatoire——
data[].api_key_idanyOf<string | null>facultatif——
data[].api_key_id · variant 1stringfacultatif——
data[].api_key_id · variant 2nullfacultatif——
data[].originstringobligatoire——
data[].outcomestringfacultatif—
default: "succeeded"
data[].job_idanyOf<string | null>facultatif——
data[].job_id · variant 1stringfacultatif——
data[].job_id · variant 2nullfacultatif——
data[].task_idanyOf<string | null>facultatif——
data[].task_id · variant 1stringfacultatif——
data[].task_id · variant 2nullfacultatif——
data[].input_formatanyOf<string | null>facultatif——
data[].input_format · variant 1stringfacultatif——
data[].input_format · variant 2nullfacultatif——
data[].output_formatanyOf<string | null>facultatif——
data[].output_format · variant 1stringfacultatif——
data[].output_format · variant 2nullfacultatif——
data[].engineanyOf<string | null>facultatif——
data[].engine · variant 1stringfacultatif——
data[].engine · variant 2nullfacultatif——
data[].engine_versionanyOf<string | null>facultatif——
data[].engine_version · variant 1stringfacultatif——
data[].engine_version · variant 2nullfacultatif——
data[].runtime_classanyOf<string | null>facultatif——
data[].runtime_class · variant 1stringfacultatif——
data[].runtime_class · variant 2nullfacultatif——
data[].input_bytesanyOf<integer | null>facultatif——
data[].input_bytes · variant 1integerfacultatif——
data[].input_bytes · variant 2nullfacultatif——
data[].output_bytesanyOf<integer | null>facultatif——
data[].output_bytes · variant 1integerfacultatif——
data[].output_bytes · variant 2nullfacultatif——
data[].wall_msanyOf<integer | null>facultatif——
data[].wall_ms · variant 1integerfacultatif——
data[].wall_ms · variant 2nullfacultatif——
data[].creditsanyOf<string | null>facultatif——
data[].credits · variant 1stringfacultatif——
data[].credits · variant 2nullfacultatif——
data[].created_atstringobligatoire—
format: date-time
paginationobjectobligatoire——
pagination.nextanyOf<string | null>facultatif——
pagination.next · variant 1stringfacultatif——
pagination.next · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
startqueryanyOf<string | null>facultatif—
endqueryanyOf<string | null>facultatif—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
startstringobligatoire—
format: date-time
endstringobligatoire—
format: date-time
conversionsintegerobligatoire——
creditsstringobligatoire——
input_bytesintegerobligatoire——
output_bytesintegerobligatoire——
wall_msintegerobligatoire——
by_originobject[]facultatif——
by_origin[]objectfacultatif——
by_origin[].keystringobligatoire——
by_origin[].conversionsintegerobligatoire——
by_origin[].creditsstringobligatoire——
top_pairsobject[]facultatif——
top_pairs[]objectfacultatif——
top_pairs[].keystringobligatoire——
top_pairs[].conversionsintegerobligatoire——
top_pairs[].creditsstringobligatoire——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
delivery_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
webhook_idstringobligatoire——
event_idstringobligatoire——
statusstringobligatoire——
attemptintegerobligatoire——
request_headersobjectobligatoire——
request_bodyobjectobligatoire——
response_statusanyOf<integer | null>facultatif——
response_status · variant 1integerfacultatif——
response_status · variant 2nullfacultatif——
response_bodyanyOf<string | null>facultatif——
response_body · variant 1stringfacultatif——
response_body · variant 2nullfacultatif——
latency_msanyOf<integer | null>facultatif——
latency_ms · variant 1integerfacultatif——
latency_ms · variant 2nullfacultatif——
error_messageanyOf<string | null>facultatif——
error_message · variant 1stringfacultatif——
error_message · variant 2nullfacultatif——
next_retry_atanyOf<string | null>facultatif——
next_retry_at · variant 1stringfacultatif—
format: date-time
next_retry_at · variant 2nullfacultatif——
delivered_atanyOf<string | null>facultatif——
delivered_at · variant 1stringfacultatif—
format: date-time
delivered_at · variant 2nullfacultatif——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
delivery_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
webhook_idstringobligatoire——
event_idstringobligatoire——
statusstringobligatoire——
attemptintegerobligatoire——
request_headersobjectobligatoire——
request_bodyobjectobligatoire——
response_statusanyOf<integer | null>facultatif——
response_status · variant 1integerfacultatif——
response_status · variant 2nullfacultatif——
response_bodyanyOf<string | null>facultatif——
response_body · variant 1stringfacultatif——
response_body · variant 2nullfacultatif——
latency_msanyOf<integer | null>facultatif——
latency_ms · variant 1integerfacultatif——
latency_ms · variant 2nullfacultatif——
error_messageanyOf<string | null>facultatif——
error_message · variant 1stringfacultatif——
error_message · variant 2nullfacultatif——
next_retry_atanyOf<string | null>facultatif——
next_retry_at · variant 1stringfacultatif—
format: date-time
next_retry_at · variant 2nullfacultatif——
delivered_atanyOf<string | null>facultatif——
delivered_at · variant 1stringfacultatif—
format: date-time
delivered_at · variant 2nullfacultatif——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
bodyobject[]obligatoire——
items[]objectfacultatif——
items[].idstringobligatoire——
items[].urlstringobligatoire——
items[].descriptionanyOf<string | null>facultatif——
items[].description · variant 1stringfacultatif——
items[].description · variant 2nullfacultatif——
items[].event_typesstring[]obligatoire——
items[].enabledbooleanobligatoire——
items[].failure_countintegerobligatoire——
items[].created_atstringobligatoire—
format: date-time
items[].updated_atstringobligatoire—
format: date-time
items[].signing_secretanyOf<string | null>facultatif——
items[].signing_secret · variant 1stringfacultatif——
items[].signing_secret · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
urlstringobligatoire—
min length: 1max length: 2048
descriptionanyOf<string | null>facultatif——
description · variant 1stringfacultatif—
max length: 512
description · variant 2nullfacultatif——
event_typesstring[]facultatif——

Réponses

201Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
urlstringobligatoire——
descriptionanyOf<string | null>facultatif——
description · variant 1stringfacultatif——
description · variant 2nullfacultatif——
event_typesstring[]obligatoire——
enabledbooleanobligatoire——
failure_countintegerobligatoire——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
signing_secretanyOf<string | null>facultatif——
signing_secret · variant 1stringfacultatif——
signing_secret · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
webhook_idpathstringobligatoire—

Réponses

204Successful Response

Aucun corps de réponse.

400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
webhook_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
urlstringobligatoire——
descriptionanyOf<string | null>facultatif——
description · variant 1stringfacultatif——
description · variant 2nullfacultatif——
event_typesstring[]obligatoire——
enabledbooleanobligatoire——
failure_countintegerobligatoire——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
signing_secretanyOf<string | null>facultatif——
signing_secret · variant 1stringfacultatif——
signing_secret · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
webhook_idpathstringobligatoire—

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
urlanyOf<string | null>facultatif——
url · variant 1stringfacultatif—
min length: 1max length: 2048
url · variant 2nullfacultatif——
descriptionanyOf<string | null>facultatif——
description · variant 1stringfacultatif—
max length: 512
description · variant 2nullfacultatif——
event_typesanyOf<string[] | null>facultatif——
event_types · variant 1string[]facultatif——
event_types · variant 2nullfacultatif——
enabledanyOf<boolean | null>facultatif——
enabled · variant 1booleanfacultatif——
enabled · variant 2nullfacultatif——

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
urlstringobligatoire——
descriptionanyOf<string | null>facultatif——
description · variant 1stringfacultatif——
description · variant 2nullfacultatif——
event_typesstring[]obligatoire——
enabledbooleanobligatoire——
failure_countintegerobligatoire——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
signing_secretanyOf<string | null>facultatif——
signing_secret · variant 1stringfacultatif——
signing_secret · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
webhook_idpathstringobligatoire—
limitqueryintegerfacultatif
default: 50min: 1max: 100
afterqueryanyOf<string | null>facultatif—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
dataobject[]obligatoire——
data[]objectfacultatif——
data[].idstringobligatoire——
data[].webhook_idstringobligatoire——
data[].event_idstringobligatoire——
data[].statusstringobligatoire——
data[].attemptintegerobligatoire——
data[].request_headersobjectobligatoire——
data[].request_bodyobjectobligatoire——
data[].response_statusanyOf<integer | null>facultatif——
data[].response_status · variant 1integerfacultatif——
data[].response_status · variant 2nullfacultatif——
data[].response_bodyanyOf<string | null>facultatif——
data[].response_body · variant 1stringfacultatif——
data[].response_body · variant 2nullfacultatif——
data[].latency_msanyOf<integer | null>facultatif——
data[].latency_ms · variant 1integerfacultatif——
data[].latency_ms · variant 2nullfacultatif——
data[].error_messageanyOf<string | null>facultatif——
data[].error_message · variant 1stringfacultatif——
data[].error_message · variant 2nullfacultatif——
data[].next_retry_atanyOf<string | null>facultatif——
data[].next_retry_at · variant 1stringfacultatif—
format: date-time
data[].next_retry_at · variant 2nullfacultatif——
data[].delivered_atanyOf<string | null>facultatif——
data[].delivered_at · variant 1stringfacultatif—
format: date-time
data[].delivered_at · variant 2nullfacultatif——
data[].created_atstringobligatoire—
format: date-time
data[].updated_atstringobligatoire—
format: date-time
paginationobjectobligatoire——
pagination.nextanyOf<string | null>facultatif——
pagination.next · variant 1stringfacultatif——
pagination.next · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
webhook_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
signing_secretstringobligatoire——
previous_secret_valid_untilanyOf<string | null>facultatif——
previous_secret_valid_until · variant 1stringfacultatif—
format: date-time
previous_secret_valid_until · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
limitqueryintegerfacultatif
default: 50min: 1max: 200
afterqueryanyOf<string | null>facultatif—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
dataobject[]obligatoire——
data[]objectfacultatif——
data[].idstringobligatoire——
data[].namestringobligatoire——
data[].descriptionanyOf<string | null>facultatif——
data[].description · variant 1stringfacultatif——
data[].description · variant 2nullfacultatif——
data[].current_versionintegerobligatoire——
data[].definitionobjectobligatoire——
data[].variables_schemaobjectobligatoire——
data[].metadataobjectobligatoire——
data[].created_atstringobligatoire—
format: date-time
data[].updated_atstringobligatoire—
format: date-time
paginationobjectobligatoire——
pagination.nextanyOf<string | null>facultatif——
pagination.next · variant 1stringfacultatif——
pagination.next · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
namestringobligatoire—
min length: 1max length: 255
descriptionanyOf<string | null>facultatif——
description · variant 1stringfacultatif—
max length: 2000
description · variant 2nullfacultatif——
definitionobjectobligatoire——
definition.tasksobjectobligatoire——
definition.taganyOf<string | null>facultatif——
definition.tag · variant 1stringfacultatif—
max length: 255
definition.tag · variant 2nullfacultatif——
definition.client_reference_idanyOf<string | null>facultatif——
definition.client_reference_id · variant 1stringfacultatif—
max length: 255
definition.client_reference_id · variant 2nullfacultatif——
definition.metadataobjectfacultatif——
definition.prioritystringfacultatif—
enum: "low", "normal", "high"default: "normal"
definition.retention_secondsanyOf<integer | null>facultatif——
definition.retention_seconds · variant 1integerfacultatif—
min: 0max: 86400
definition.retention_seconds · variant 2nullfacultatif——
variables_schemaobjectfacultatif——
metadataobjectfacultatif——

Réponses

201Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
namestringobligatoire——
descriptionanyOf<string | null>facultatif——
description · variant 1stringfacultatif——
description · variant 2nullfacultatif——
current_versionintegerobligatoire——
definitionobjectobligatoire——
variables_schemaobjectobligatoire——
metadataobjectobligatoire——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
workflow_idpathstringobligatoire—

Réponses

204Successful Response

Aucun corps de réponse.

400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
workflow_idpathstringobligatoire—

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
namestringobligatoire——
descriptionanyOf<string | null>facultatif——
description · variant 1stringfacultatif——
description · variant 2nullfacultatif——
current_versionintegerobligatoire——
definitionobjectobligatoire——
variables_schemaobjectobligatoire——
metadataobjectobligatoire——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
workflow_idpathstringobligatoire—

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
nameanyOf<string | null>facultatif——
name · variant 1stringfacultatif—
min length: 1max length: 255
name · variant 2nullfacultatif——
descriptionanyOf<string | null>facultatif——
description · variant 1stringfacultatif—
max length: 2000
description · variant 2nullfacultatif——
definitionanyOf<object | null>facultatif——
definition · variant 1objectfacultatif——
definition · variant 1.tasksobjectobligatoire——
definition · variant 1.taganyOf<string | null>facultatif——
definition · variant 1.tag · variant 1stringfacultatif—
max length: 255
definition · variant 1.tag · variant 2nullfacultatif——
definition · variant 1.client_reference_idanyOf<string | null>facultatif——
definition · variant 1.client_reference_id · variant 1stringfacultatif—
max length: 255
definition · variant 1.client_reference_id · variant 2nullfacultatif——
definition · variant 1.metadataobjectfacultatif——
definition · variant 1.prioritystringfacultatif—
enum: "low", "normal", "high"default: "normal"
definition · variant 1.retention_secondsanyOf<integer | null>facultatif——
definition · variant 1.retention_seconds · variant 1integerfacultatif—
min: 0max: 86400
definition · variant 1.retention_seconds · variant 2nullfacultatif——
definition · variant 2nullfacultatif——
variables_schemaanyOf<object | null>facultatif——
variables_schema · variant 1objectfacultatif——
variables_schema · variant 2nullfacultatif——
metadataanyOf<object | null>facultatif——
metadata · variant 1objectfacultatif——
metadata · variant 2nullfacultatif——

Réponses

200Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
namestringobligatoire——
descriptionanyOf<string | null>facultatif——
description · variant 1stringfacultatif——
description · variant 2nullfacultatif——
current_versionintegerobligatoire——
definitionobjectobligatoire——
variables_schemaobjectobligatoire——
metadataobjectobligatoire——
created_atstringobligatoire—
format: date-time
updated_atstringobligatoire—
format: date-time
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
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.

Authentification
ConverterHQBearerhttp / bearer

Paramètres

NomEmplacementTypeObligatoireDescription / contraintes
workflow_idpathstringobligatoire—
Idempotency-KeyheaderanyOf<string | null>facultatif—

Corps de la requête obligatoire

application/json
ChampTypeObligatoireDescriptionContraintes
variablesobjectfacultatif——
client_reference_idanyOf<string | null>facultatif——
client_reference_id · variant 1stringfacultatif—
max length: 255
client_reference_id · variant 2nullfacultatif——
metadataobjectfacultatif——

Réponses

201Successful Response
application/json
ChampTypeObligatoireDescriptionContraintes
idstringobligatoire——
kindstringobligatoire——
statusstringobligatoire——
progressintegerobligatoire——
taganyOf<string | null>facultatif——
tag · variant 1stringfacultatif——
tag · variant 2nullfacultatif——
client_reference_idanyOf<string | null>facultatif——
client_reference_id · variant 1stringfacultatif——
client_reference_id · variant 2nullfacultatif——
metadataobjectfacultatif——
prioritystringobligatoire——
concurrency_limitintegerfacultatif—
default: 1
originstringobligatoire——
created_atstringobligatoire—
format: date-time
started_atanyOf<string | null>facultatif——
started_at · variant 1stringfacultatif—
format: date-time
started_at · variant 2nullfacultatif——
completed_atanyOf<string | null>facultatif——
completed_at · variant 1stringfacultatif—
format: date-time
completed_at · variant 2nullfacultatif——
error_codeanyOf<string | null>facultatif——
error_code · variant 1stringfacultatif——
error_code · variant 2nullfacultatif——
error_messageanyOf<string | null>facultatif——
error_message · variant 1stringfacultatif——
error_message · variant 2nullfacultatif——
tasksobject[]facultatif——
tasks[]objectfacultatif——
tasks[].idstringobligatoire——
tasks[].job_idstringobligatoire——
tasks[].namestringobligatoire——
tasks[].operationstringobligatoire——
tasks[].statusstringobligatoire——
tasks[].progressintegerobligatoire——
tasks[].inputobjectobligatoire——
tasks[].optionsobjectobligatoire——
tasks[].resultobjectobligatoire——
tasks[].requiredbooleanobligatoire——
tasks[].runtime_classstringobligatoire——
tasks[].prioritystringobligatoire——
tasks[].attempt_countintegerobligatoire——
tasks[].max_attemptsintegerobligatoire——
tasks[].error_codeanyOf<string | null>facultatif——
tasks[].error_code · variant 1stringfacultatif——
tasks[].error_code · variant 2nullfacultatif——
tasks[].error_messageanyOf<string | null>facultatif——
tasks[].error_message · variant 1stringfacultatif——
tasks[].error_message · variant 2nullfacultatif——
tasks[].created_atstringobligatoire—
format: date-time
tasks[].queued_atanyOf<string | null>facultatif——
tasks[].queued_at · variant 1stringfacultatif—
format: date-time
tasks[].queued_at · variant 2nullfacultatif——
tasks[].started_atanyOf<string | null>facultatif——
tasks[].started_at · variant 1stringfacultatif—
format: date-time
tasks[].started_at · variant 2nullfacultatif——
tasks[].completed_atanyOf<string | null>facultatif——
tasks[].completed_at · variant 1stringfacultatif—
format: date-time
tasks[].completed_at · variant 2nullfacultatif——
tasks[].attemptsobject[]facultatif——
tasks[].attempts[]objectfacultatif——
tasks[].attempts[].idstringobligatoire——
tasks[].attempts[].attempt_numberintegerobligatoire——
tasks[].attempts[].statusstringobligatoire——
tasks[].attempts[].worker_idanyOf<string | null>facultatif——
tasks[].attempts[].worker_id · variant 1stringfacultatif——
tasks[].attempts[].worker_id · variant 2nullfacultatif——
tasks[].attempts[].runtime_classanyOf<string | null>facultatif——
tasks[].attempts[].runtime_class · variant 1stringfacultatif——
tasks[].attempts[].runtime_class · variant 2nullfacultatif——
tasks[].attempts[].regionanyOf<string | null>facultatif——
tasks[].attempts[].region · variant 1stringfacultatif——
tasks[].attempts[].region · variant 2nullfacultatif——
tasks[].attempts[].engineanyOf<string | null>facultatif——
tasks[].attempts[].engine · variant 1stringfacultatif——
tasks[].attempts[].engine · variant 2nullfacultatif——
tasks[].attempts[].engine_versionanyOf<string | null>facultatif——
tasks[].attempts[].engine_version · variant 1stringfacultatif——
tasks[].attempts[].engine_version · variant 2nullfacultatif——
tasks[].attempts[].input_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].input_bytes · variant 1integerfacultatif——
tasks[].attempts[].input_bytes · variant 2nullfacultatif——
tasks[].attempts[].output_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].output_bytes · variant 1integerfacultatif——
tasks[].attempts[].output_bytes · variant 2nullfacultatif——
tasks[].attempts[].wall_msanyOf<integer | null>facultatif——
tasks[].attempts[].wall_ms · variant 1integerfacultatif——
tasks[].attempts[].wall_ms · variant 2nullfacultatif——
tasks[].attempts[].cpu_msanyOf<integer | null>facultatif——
tasks[].attempts[].cpu_ms · variant 1integerfacultatif——
tasks[].attempts[].cpu_ms · variant 2nullfacultatif——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>facultatif——
tasks[].attempts[].peak_memory_mb · variant 1integerfacultatif——
tasks[].attempts[].peak_memory_mb · variant 2nullfacultatif——
tasks[].attempts[].temp_bytesanyOf<integer | null>facultatif——
tasks[].attempts[].temp_bytes · variant 1integerfacultatif——
tasks[].attempts[].temp_bytes · variant 2nullfacultatif——
tasks[].attempts[].error_codeanyOf<string | null>facultatif——
tasks[].attempts[].error_code · variant 1stringfacultatif——
tasks[].attempts[].error_code · variant 2nullfacultatif——
tasks[].attempts[].error_messageanyOf<string | null>facultatif——
tasks[].attempts[].error_message · variant 1stringfacultatif——
tasks[].attempts[].error_message · variant 2nullfacultatif——
tasks[].attempts[].estimated_creditsanyOf<string | null>facultatif——
tasks[].attempts[].estimated_credits · variant 1stringfacultatif——
tasks[].attempts[].estimated_credits · variant 2nullfacultatif——
tasks[].attempts[].settled_creditsanyOf<string | null>facultatif——
tasks[].attempts[].settled_credits · variant 1stringfacultatif——
tasks[].attempts[].settled_credits · variant 2nullfacultatif——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facultatif——
tasks[].attempts[].external_side_effect_started_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullfacultatif——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facultatif——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacultatif——
tasks[].attempts[].started_atstringobligatoire—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>facultatif——
tasks[].attempts[].completed_at · variant 1stringfacultatif—
format: date-time
tasks[].attempts[].completed_at · variant 2nullfacultatif——
400The request could not be processed.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
401Authentication is missing or invalid.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
403The principal is not allowed to perform this operation.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
409The request conflicts with the current resource or idempotency state.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
422Validation Error
application/json
ChampTypeObligatoireDescriptionContraintes
detailobject[]facultatif——
detail[]objectfacultatif——
detail[].locanyOf<string | integer>[]obligatoire——
detail[].loc[]anyOf<string | integer>facultatif——
detail[].loc[] · variant 1stringfacultatif——
detail[].loc[] · variant 2integerfacultatif——
detail[].msgstringobligatoire——
detail[].typestringobligatoire——
429The caller has exceeded an admission-control limit.
En-têtes de réponseRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
500An unexpected server error occurred.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——
503A required service is temporarily unavailable.
application/problem+json
ChampTypeObligatoireDescriptionContraintes
typestringobligatoire—
default: "about:blank"
titlestringobligatoire——
statusintegerobligatoire—
min: 400max: 599
codestringobligatoire——
detailstringobligatoire——
retryablebooleanobligatoire——
parameteranyOf<string | null>facultatif——
parameter · variant 1stringfacultatif——
parameter · variant 2nullfacultatif——
request_idanyOf<string | null>facultatif——
request_id · variant 1stringfacultatif——
request_id · variant 2nullfacultatif——