ConverterHQDevelopers
Generato dal contratto OpenAPI pubblico selezionato

Riferimento dell’API REST

Esamina parametri, autenticazione, campi annidati, schemi di risposta, errori ed esempi eseguibili. Sono escluse le rotte per utenti finali, SEO e amministrazione.

74 endpoint visualizzati74 operazioni totali17 tag3.1.0 schema
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.

AutenticazionePubblico / nessuna autenticazione specifica dell’operazione

Parametri

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

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
dataobject[]obbligatorio——
data[]objectfacoltativo——
data[].supportedbooleanobbligatorio——
data[].input_formatstringobbligatorio——
data[].output_formatstringobbligatorio——
data[].maturitystringfacoltativo—
enum: "stable", "disabled"default: "stable"
data[].settings_scopestringfacoltativoSettings 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[].routeobjectfacoltativo——
data[].route.multi_stepbooleanfacoltativoTrue 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[]facoltativoSetting 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>facoltativoStable 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 1stringfacoltativo——
data[].options_version · variant 2nullfacoltativo——
data[].optionsobject[]facoltativoSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
data[].options[]objectfacoltativo——
data[].options[].namestringobbligatorio——
data[].options[].typestringobbligatorio——
data[].options[].labelstringobbligatorio——
data[].options[].descriptionanyOf<string | null>facoltativo——
data[].options[].description · variant 1stringfacoltativo——
data[].options[].description · variant 2nullfacoltativo——
data[].options[].requiredbooleanfacoltativo—
default: false
data[].options[].advancedbooleanfacoltativo—
default: false
data[].options[].groupanyOf<string | null>facoltativo——
data[].options[].group · variant 1stringfacoltativo——
data[].options[].group · variant 2nullfacoltativo——
data[].options[].defaultunknownfacoltativo——
data[].options[].possible_valuesanyOf<unknown[] | null>facoltativo——
data[].options[].possible_values · variant 1unknown[]facoltativo——
data[].options[].possible_values · variant 2nullfacoltativo——
data[].options[].minimumanyOf<integer | number | null>facoltativo——
data[].options[].minimum · variant 1integerfacoltativo——
data[].options[].minimum · variant 2numberfacoltativo——
data[].options[].minimum · variant 3nullfacoltativo——
data[].options[].maximumanyOf<integer | number | null>facoltativo——
data[].options[].maximum · variant 1integerfacoltativo——
data[].options[].maximum · variant 2numberfacoltativo——
data[].options[].maximum · variant 3nullfacoltativo——
data[].options[].depends_onobject[]facoltativo——
data[].options[].conflicts_withstring[]facoltativo——
data[].options[].schemaanyOf<object | null>facoltativo——
data[].options[].schema · variant 1objectfacoltativo——
data[].options[].schema · variant 2nullfacoltativo——
data[].options_schemaobjectfacoltativoStrict JSON Schema for the settings accepted by this pair-level conversion task.—
data[].limitsobjectfacoltativo——
data[].billingobjectfacoltativo——
paginationobjectobbligatorio——
pagination.nextanyOf<string | null>facoltativo——
pagination.next · variant 1stringfacoltativo——
pagination.next · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

AutenticazionePubblico / nessuna autenticazione specifica dell’operazione

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
from_formatpathstringobbligatorio—
to_formatpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
supportedbooleanobbligatorio——
input_formatstringobbligatorio——
output_formatstringobbligatorio——
maturitystringfacoltativo—
enum: "stable", "disabled"default: "stable"
settings_scopestringfacoltativoSettings 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"
routeobjectfacoltativo——
route.multi_stepbooleanfacoltativoTrue 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[]facoltativoSetting 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>facoltativoStable 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 1stringfacoltativo——
options_version · variant 2nullfacoltativo——
optionsobject[]facoltativoSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
options[]objectfacoltativo——
options[].namestringobbligatorio——
options[].typestringobbligatorio——
options[].labelstringobbligatorio——
options[].descriptionanyOf<string | null>facoltativo——
options[].description · variant 1stringfacoltativo——
options[].description · variant 2nullfacoltativo——
options[].requiredbooleanfacoltativo—
default: false
options[].advancedbooleanfacoltativo—
default: false
options[].groupanyOf<string | null>facoltativo——
options[].group · variant 1stringfacoltativo——
options[].group · variant 2nullfacoltativo——
options[].defaultunknownfacoltativo——
options[].possible_valuesanyOf<unknown[] | null>facoltativo——
options[].possible_values · variant 1unknown[]facoltativo——
options[].possible_values · variant 2nullfacoltativo——
options[].minimumanyOf<integer | number | null>facoltativo——
options[].minimum · variant 1integerfacoltativo——
options[].minimum · variant 2numberfacoltativo——
options[].minimum · variant 3nullfacoltativo——
options[].maximumanyOf<integer | number | null>facoltativo——
options[].maximum · variant 1integerfacoltativo——
options[].maximum · variant 2numberfacoltativo——
options[].maximum · variant 3nullfacoltativo——
options[].depends_onobject[]facoltativo——
options[].conflicts_withstring[]facoltativo——
options[].schemaanyOf<object | null>facoltativo——
options[].schema · variant 1objectfacoltativo——
options[].schema · variant 2nullfacoltativo——
options_schemaobjectfacoltativoStrict JSON Schema for the settings accepted by this pair-level conversion task.—
limitsobjectfacoltativo——
billingobjectfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
account_idstringobbligatorio——
productstringobbligatorio——
api_enabledbooleanobbligatorio——
plansstring[]obbligatorio——
effective_planobjectobbligatorio——
effective_plan.codestringobbligatorio——
effective_plan.namestringobbligatorio——
effective_plan.familyanyOf<string | null>facoltativo——
effective_plan.family · variant 1stringfacoltativo——
effective_plan.family · variant 2nullfacoltativo——
effective_plan.billing_intervalanyOf<string | null>facoltativo——
effective_plan.billing_interval · variant 1stringfacoltativo——
effective_plan.billing_interval · variant 2nullfacoltativo——
creditsobjectobbligatorio——
credits.availablestringobbligatorio——
credits.reservedstringobbligatorio——
credits.debtstringobbligatorio——
quotaanyOf<object | null>facoltativo——
quota · variant 1objectfacoltativo——
quota · variant 1.keystringobbligatorio——
quota · variant 1.periodstringobbligatorio——
quota · variant 1.period_keystringobbligatorio——
quota · variant 1.limitstringobbligatorio——
quota · variant 1.usedstringobbligatorio——
quota · variant 1.remainingstringobbligatorio——
quota · variant 1.period_startstringobbligatorio—
format: date-time
quota · variant 1.period_endstringobbligatorio—
format: date-time
quota · variant 2nullfacoltativo——
subscriptionsobject[]obbligatorio——
subscriptions[]objectfacoltativo——
subscriptions[].idstringobbligatorio——
subscriptions[].planstringobbligatorio——
subscriptions[].statusstringobbligatorio——
subscriptions[].billing_intervalanyOf<string | null>facoltativo——
subscriptions[].billing_interval · variant 1stringfacoltativo——
subscriptions[].billing_interval · variant 2nullfacoltativo——
subscriptions[].current_period_startanyOf<string | null>facoltativo——
subscriptions[].current_period_start · variant 1stringfacoltativo—
format: date-time
subscriptions[].current_period_start · variant 2nullfacoltativo——
subscriptions[].current_period_endanyOf<string | null>facoltativo——
subscriptions[].current_period_end · variant 1stringfacoltativo—
format: date-time
subscriptions[].current_period_end · variant 2nullfacoltativo——
subscriptions[].next_billed_atanyOf<string | null>facoltativo——
subscriptions[].next_billed_at · variant 1stringfacoltativo—
format: date-time
subscriptions[].next_billed_at · variant 2nullfacoltativo——
passesobject[]obbligatorio——
passes[]objectfacoltativo——
passes[].idstringobbligatorio——
passes[].offerstringobbligatorio——
passes[].planstringobbligatorio——
passes[].starts_atstringobbligatorio—
format: date-time
passes[].expires_atstringobbligatorio—
format: date-time
generated_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
limitqueryintegerfacoltativo
default: 50min: 1max: 200
afterqueryanyOf<string | null>facoltativo—
providerqueryanyOf<string | null>facoltativo—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
dataobject[]obbligatorio——
data[]objectfacoltativo——
data[].idstringobbligatorio——
data[].namestringobbligatorio——
data[].providerstringobbligatorio—
enum: "s3", "gcs", "azure", "sftp"
data[].config_summaryobjectobbligatorio——
data[].enabledbooleanobbligatorio——
data[].created_atstringobbligatorio—
format: date-time
data[].updated_atstringobbligatorio—
format: date-time
paginationobjectobbligatorio——
pagination.nextanyOf<string | null>facoltativo——
pagination.next · variant 1stringfacoltativo——
pagination.next · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
namestringobbligatorio—
min length: 1max length: 255
providerstringobbligatorio—
enum: "s3", "gcs", "azure", "sftp"
configobjectobbligatorio——

Risposte

201Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
namestringobbligatorio——
providerstringobbligatorio—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectobbligatorio——
enabledbooleanobbligatorio——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
connection_idpathstringobbligatorio—

Risposte

204Successful Response

Nessun corpo della risposta.

400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
connection_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
namestringobbligatorio——
providerstringobbligatorio—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectobbligatorio——
enabledbooleanobbligatorio——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
connection_idpathstringobbligatorio—

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
nameanyOf<string | null>facoltativo——
name · variant 1stringfacoltativo—
min length: 1max length: 255
name · variant 2nullfacoltativo——
configanyOf<object | null>facoltativo——
config · variant 1objectfacoltativo——
config · variant 2nullfacoltativo——
enabledanyOf<boolean | null>facoltativo——
enabled · variant 1booleanfacoltativo——
enabled · variant 2nullfacoltativo——

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
namestringobbligatorio——
providerstringobbligatorio—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectobbligatorio——
enabledbooleanobbligatorio——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
connection_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
okbooleanobbligatorio——
providerstringobbligatorio——
detailsobjectfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
PreferheaderanyOf<string | null>facoltativo—
Idempotency-KeyheaderanyOf<string | null>facoltativo—

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
inputobjectobbligatorio——
input.file_idanyOf<string | null>facoltativo—
default: null
input.file_id · variant 1stringfacoltativo——
input.file_id · variant 2nullfacoltativo——
input.urlanyOf<string | null>facoltativo—
default: null
input.url · variant 1stringfacoltativo——
input.url · variant 2nullfacoltativo——
input_formatanyOf<string | null>facoltativo—
default: null
input_format · variant 1stringfacoltativo——
input_format · variant 2nullfacoltativo——
output_formatstringobbligatorio—
min length: 1max length: 64
optionsobjectfacoltativo——
filenameanyOf<string | null>facoltativo—
default: null
filename · variant 1stringfacoltativo—
max length: 512
filename · variant 2nullfacoltativo——
metadataobjectfacoltativo——
client_reference_idanyOf<string | null>facoltativo—
default: null
client_reference_id · variant 1stringfacoltativo—
max length: 255
client_reference_id · variant 2nullfacoltativo——
retention_secondsanyOf<integer | null>facoltativo—
default: null
retention_seconds · variant 1integerfacoltativo—
min: 0max: 86400
retention_seconds · variant 2nullfacoltativo——
multipart/form-data
CampoTipoObbligatorioDescrizioneVincoli
filestringobbligatorioInput file, up to 4 MiB.
format: binary
input_formatstringfacoltativoOptional source format when it cannot be detected.—
output_formatstringobbligatorioRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringfacoltativoJSON object containing pair-specific conversion options.—
metadatastringfacoltativoJSON object copied to the created Job.—
filenamestringfacoltativoOptional output filename hint.—
client_reference_idstringfacoltativoOptional caller-defined reference.—
retention_secondsintegerfacoltativo—
min: 0max: 86400

Risposte

200Conversion completed within the requested wait window.
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
job_idstringobbligatorio——
statusstringobbligatorio——
progressintegerobbligatorio——
input_formatanyOf<string | null>facoltativo——
input_format · variant 1stringfacoltativo——
input_format · variant 2nullfacoltativo——
output_formatstringobbligatorio——
output_fileanyOf<object | null>facoltativo——
output_file · variant 1objectfacoltativo——
output_file · variant 1.idstringobbligatorio——
output_file · variant 1.statusstringobbligatorio——
output_file · variant 1.rolestringobbligatorio——
output_file · variant 1.filenamestringobbligatorio——
output_file · variant 1.content_typeanyOf<string | null>facoltativo——
output_file · variant 1.content_type · variant 1stringfacoltativo——
output_file · variant 1.content_type · variant 2nullfacoltativo——
output_file · variant 1.detected_content_typeanyOf<string | null>facoltativo——
output_file · variant 1.detected_content_type · variant 1stringfacoltativo——
output_file · variant 1.detected_content_type · variant 2nullfacoltativo——
output_file · variant 1.detected_formatanyOf<string | null>facoltativo——
output_file · variant 1.detected_format · variant 1stringfacoltativo——
output_file · variant 1.detected_format · variant 2nullfacoltativo——
output_file · variant 1.size_bytesanyOf<integer | null>facoltativo——
output_file · variant 1.size_bytes · variant 1integerfacoltativo——
output_file · variant 1.size_bytes · variant 2nullfacoltativo——
output_file · variant 1.checksum_sha256anyOf<string | null>facoltativo——
output_file · variant 1.checksum_sha256 · variant 1stringfacoltativo——
output_file · variant 1.checksum_sha256 · variant 2nullfacoltativo——
output_file · variant 1.source_typestringobbligatorio——
output_file · variant 1.created_atstringobbligatorio—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>facoltativo——
output_file · variant 1.ready_at · variant 1stringfacoltativo—
format: date-time
output_file · variant 1.ready_at · variant 2nullfacoltativo——
output_file · variant 1.expires_atanyOf<string | null>facoltativo——
output_file · variant 1.expires_at · variant 1stringfacoltativo—
format: date-time
output_file · variant 1.expires_at · variant 2nullfacoltativo——
output_file · variant 1.metadataobjectfacoltativo——
output_file · variant 1.uploadanyOf<object | null>facoltativo——
output_file · variant 1.upload · variant 1objectfacoltativo——
output_file · variant 1.upload · variant 1.methodstringfacoltativo—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringobbligatorio——
output_file · variant 1.upload · variant 1.expires_atstringobbligatorio—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectfacoltativo——
output_file · variant 1.upload · variant 2nullfacoltativo——
output_file · variant 1.download_urlanyOf<string | null>facoltativo——
output_file · variant 1.download_url · variant 1stringfacoltativo——
output_file · variant 1.download_url · variant 2nullfacoltativo——
output_file · variant 1.download_expires_atanyOf<string | null>facoltativo——
output_file · variant 1.download_expires_at · variant 1stringfacoltativo—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullfacoltativo——
output_file · variant 2nullfacoltativo——
created_atstringobbligatorio—
format: date-time
202Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
job_idstringobbligatorio——
statusstringobbligatorio——
progressintegerobbligatorio——
input_formatanyOf<string | null>facoltativo——
input_format · variant 1stringfacoltativo——
input_format · variant 2nullfacoltativo——
output_formatstringobbligatorio——
output_fileanyOf<object | null>facoltativo——
output_file · variant 1objectfacoltativo——
output_file · variant 1.idstringobbligatorio——
output_file · variant 1.statusstringobbligatorio——
output_file · variant 1.rolestringobbligatorio——
output_file · variant 1.filenamestringobbligatorio——
output_file · variant 1.content_typeanyOf<string | null>facoltativo——
output_file · variant 1.content_type · variant 1stringfacoltativo——
output_file · variant 1.content_type · variant 2nullfacoltativo——
output_file · variant 1.detected_content_typeanyOf<string | null>facoltativo——
output_file · variant 1.detected_content_type · variant 1stringfacoltativo——
output_file · variant 1.detected_content_type · variant 2nullfacoltativo——
output_file · variant 1.detected_formatanyOf<string | null>facoltativo——
output_file · variant 1.detected_format · variant 1stringfacoltativo——
output_file · variant 1.detected_format · variant 2nullfacoltativo——
output_file · variant 1.size_bytesanyOf<integer | null>facoltativo——
output_file · variant 1.size_bytes · variant 1integerfacoltativo——
output_file · variant 1.size_bytes · variant 2nullfacoltativo——
output_file · variant 1.checksum_sha256anyOf<string | null>facoltativo——
output_file · variant 1.checksum_sha256 · variant 1stringfacoltativo——
output_file · variant 1.checksum_sha256 · variant 2nullfacoltativo——
output_file · variant 1.source_typestringobbligatorio——
output_file · variant 1.created_atstringobbligatorio—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>facoltativo——
output_file · variant 1.ready_at · variant 1stringfacoltativo—
format: date-time
output_file · variant 1.ready_at · variant 2nullfacoltativo——
output_file · variant 1.expires_atanyOf<string | null>facoltativo——
output_file · variant 1.expires_at · variant 1stringfacoltativo—
format: date-time
output_file · variant 1.expires_at · variant 2nullfacoltativo——
output_file · variant 1.metadataobjectfacoltativo——
output_file · variant 1.uploadanyOf<object | null>facoltativo——
output_file · variant 1.upload · variant 1objectfacoltativo——
output_file · variant 1.upload · variant 1.methodstringfacoltativo—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringobbligatorio——
output_file · variant 1.upload · variant 1.expires_atstringobbligatorio—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectfacoltativo——
output_file · variant 1.upload · variant 2nullfacoltativo——
output_file · variant 1.download_urlanyOf<string | null>facoltativo——
output_file · variant 1.download_url · variant 1stringfacoltativo——
output_file · variant 1.download_url · variant 2nullfacoltativo——
output_file · variant 1.download_expires_atanyOf<string | null>facoltativo——
output_file · variant 1.download_expires_at · variant 1stringfacoltativo—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullfacoltativo——
output_file · variant 2nullfacoltativo——
created_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
from_formatpathstringobbligatorio—
to_formatpathstringobbligatorio—
PreferheaderanyOf<string | null>facoltativo—
Idempotency-KeyheaderanyOf<string | null>facoltativo—

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
inputobjectobbligatorio——
input.file_idanyOf<string | null>facoltativo—
default: null
input.file_id · variant 1stringfacoltativo——
input.file_id · variant 2nullfacoltativo——
input.urlanyOf<string | null>facoltativo—
default: null
input.url · variant 1stringfacoltativo——
input.url · variant 2nullfacoltativo——
input_formatanyOf<string | null>facoltativo—
default: null
input_format · variant 1stringfacoltativo——
input_format · variant 2nullfacoltativo——
output_formatstringobbligatorio—
min length: 1max length: 64
optionsobjectfacoltativo——
filenameanyOf<string | null>facoltativo—
default: null
filename · variant 1stringfacoltativo—
max length: 512
filename · variant 2nullfacoltativo——
metadataobjectfacoltativo——
client_reference_idanyOf<string | null>facoltativo—
default: null
client_reference_id · variant 1stringfacoltativo—
max length: 255
client_reference_id · variant 2nullfacoltativo——
retention_secondsanyOf<integer | null>facoltativo—
default: null
retention_seconds · variant 1integerfacoltativo—
min: 0max: 86400
retention_seconds · variant 2nullfacoltativo——
multipart/form-data
CampoTipoObbligatorioDescrizioneVincoli
filestringobbligatorioInput file, up to 4 MiB.
format: binary
input_formatstringfacoltativoOptional source format when it cannot be detected.—
output_formatstringfacoltativoRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringfacoltativoJSON object containing pair-specific conversion options.—
metadatastringfacoltativoJSON object copied to the created Job.—
filenamestringfacoltativoOptional output filename hint.—
client_reference_idstringfacoltativoOptional caller-defined reference.—
retention_secondsintegerfacoltativo—
min: 0max: 86400

Risposte

200Conversion completed within the requested wait window.
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
job_idstringobbligatorio——
statusstringobbligatorio——
progressintegerobbligatorio——
input_formatanyOf<string | null>facoltativo——
input_format · variant 1stringfacoltativo——
input_format · variant 2nullfacoltativo——
output_formatstringobbligatorio——
output_fileanyOf<object | null>facoltativo——
output_file · variant 1objectfacoltativo——
output_file · variant 1.idstringobbligatorio——
output_file · variant 1.statusstringobbligatorio——
output_file · variant 1.rolestringobbligatorio——
output_file · variant 1.filenamestringobbligatorio——
output_file · variant 1.content_typeanyOf<string | null>facoltativo——
output_file · variant 1.content_type · variant 1stringfacoltativo——
output_file · variant 1.content_type · variant 2nullfacoltativo——
output_file · variant 1.detected_content_typeanyOf<string | null>facoltativo——
output_file · variant 1.detected_content_type · variant 1stringfacoltativo——
output_file · variant 1.detected_content_type · variant 2nullfacoltativo——
output_file · variant 1.detected_formatanyOf<string | null>facoltativo——
output_file · variant 1.detected_format · variant 1stringfacoltativo——
output_file · variant 1.detected_format · variant 2nullfacoltativo——
output_file · variant 1.size_bytesanyOf<integer | null>facoltativo——
output_file · variant 1.size_bytes · variant 1integerfacoltativo——
output_file · variant 1.size_bytes · variant 2nullfacoltativo——
output_file · variant 1.checksum_sha256anyOf<string | null>facoltativo——
output_file · variant 1.checksum_sha256 · variant 1stringfacoltativo——
output_file · variant 1.checksum_sha256 · variant 2nullfacoltativo——
output_file · variant 1.source_typestringobbligatorio——
output_file · variant 1.created_atstringobbligatorio—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>facoltativo——
output_file · variant 1.ready_at · variant 1stringfacoltativo—
format: date-time
output_file · variant 1.ready_at · variant 2nullfacoltativo——
output_file · variant 1.expires_atanyOf<string | null>facoltativo——
output_file · variant 1.expires_at · variant 1stringfacoltativo—
format: date-time
output_file · variant 1.expires_at · variant 2nullfacoltativo——
output_file · variant 1.metadataobjectfacoltativo——
output_file · variant 1.uploadanyOf<object | null>facoltativo——
output_file · variant 1.upload · variant 1objectfacoltativo——
output_file · variant 1.upload · variant 1.methodstringfacoltativo—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringobbligatorio——
output_file · variant 1.upload · variant 1.expires_atstringobbligatorio—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectfacoltativo——
output_file · variant 1.upload · variant 2nullfacoltativo——
output_file · variant 1.download_urlanyOf<string | null>facoltativo——
output_file · variant 1.download_url · variant 1stringfacoltativo——
output_file · variant 1.download_url · variant 2nullfacoltativo——
output_file · variant 1.download_expires_atanyOf<string | null>facoltativo——
output_file · variant 1.download_expires_at · variant 1stringfacoltativo—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullfacoltativo——
output_file · variant 2nullfacoltativo——
created_atstringobbligatorio—
format: date-time
202Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
job_idstringobbligatorio——
statusstringobbligatorio——
progressintegerobbligatorio——
input_formatanyOf<string | null>facoltativo——
input_format · variant 1stringfacoltativo——
input_format · variant 2nullfacoltativo——
output_formatstringobbligatorio——
output_fileanyOf<object | null>facoltativo——
output_file · variant 1objectfacoltativo——
output_file · variant 1.idstringobbligatorio——
output_file · variant 1.statusstringobbligatorio——
output_file · variant 1.rolestringobbligatorio——
output_file · variant 1.filenamestringobbligatorio——
output_file · variant 1.content_typeanyOf<string | null>facoltativo——
output_file · variant 1.content_type · variant 1stringfacoltativo——
output_file · variant 1.content_type · variant 2nullfacoltativo——
output_file · variant 1.detected_content_typeanyOf<string | null>facoltativo——
output_file · variant 1.detected_content_type · variant 1stringfacoltativo——
output_file · variant 1.detected_content_type · variant 2nullfacoltativo——
output_file · variant 1.detected_formatanyOf<string | null>facoltativo——
output_file · variant 1.detected_format · variant 1stringfacoltativo——
output_file · variant 1.detected_format · variant 2nullfacoltativo——
output_file · variant 1.size_bytesanyOf<integer | null>facoltativo——
output_file · variant 1.size_bytes · variant 1integerfacoltativo——
output_file · variant 1.size_bytes · variant 2nullfacoltativo——
output_file · variant 1.checksum_sha256anyOf<string | null>facoltativo——
output_file · variant 1.checksum_sha256 · variant 1stringfacoltativo——
output_file · variant 1.checksum_sha256 · variant 2nullfacoltativo——
output_file · variant 1.source_typestringobbligatorio——
output_file · variant 1.created_atstringobbligatorio—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>facoltativo——
output_file · variant 1.ready_at · variant 1stringfacoltativo—
format: date-time
output_file · variant 1.ready_at · variant 2nullfacoltativo——
output_file · variant 1.expires_atanyOf<string | null>facoltativo——
output_file · variant 1.expires_at · variant 1stringfacoltativo—
format: date-time
output_file · variant 1.expires_at · variant 2nullfacoltativo——
output_file · variant 1.metadataobjectfacoltativo——
output_file · variant 1.uploadanyOf<object | null>facoltativo——
output_file · variant 1.upload · variant 1objectfacoltativo——
output_file · variant 1.upload · variant 1.methodstringfacoltativo—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringobbligatorio——
output_file · variant 1.upload · variant 1.expires_atstringobbligatorio—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectfacoltativo——
output_file · variant 1.upload · variant 2nullfacoltativo——
output_file · variant 1.download_urlanyOf<string | null>facoltativo——
output_file · variant 1.download_url · variant 1stringfacoltativo——
output_file · variant 1.download_url · variant 2nullfacoltativo——
output_file · variant 1.download_expires_atanyOf<string | null>facoltativo——
output_file · variant 1.download_expires_at · variant 1stringfacoltativo—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullfacoltativo——
output_file · variant 2nullfacoltativo——
created_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
input_formatstringobbligatorio——
output_formatstringobbligatorio——
size_bytesanyOf<integer | null>facoltativo——
size_bytes · variant 1integerfacoltativo—
min: 0
size_bytes · variant 2nullfacoltativo——
page_countanyOf<integer | null>facoltativo——
page_count · variant 1integerfacoltativo—
min: 0
page_count · variant 2nullfacoltativo——
duration_secondsanyOf<number | null>facoltativo——
duration_seconds · variant 1numberfacoltativo—
min: 0
duration_seconds · variant 2nullfacoltativo——
optionsobjectfacoltativo——

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
supportedbooleanobbligatorio——
recommended_modestringobbligatorio—
enum: "sync", "async"
creditsobjectobbligatorio——
warningsstring[]facoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
GET/v1/event-typesEvent TypesDiscovery#

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

AutenticazionePubblico / nessuna autenticazione specifica dell’operazione

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
dataobject[]obbligatorio——
data[]objectfacoltativo——
data[].typestringobbligatorio——
data[].descriptionstringobbligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
limitqueryintegerfacoltativo
default: 50min: 1max: 200
afterqueryanyOf<string | null>facoltativo—
statusqueryanyOf<string | null>facoltativo—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
dataobject[]obbligatorio——
data[]objectfacoltativo——
data[].idstringobbligatorio——
data[].statusstringobbligatorio——
data[].rolestringobbligatorio——
data[].filenamestringobbligatorio——
data[].content_typeanyOf<string | null>facoltativo——
data[].content_type · variant 1stringfacoltativo——
data[].content_type · variant 2nullfacoltativo——
data[].detected_content_typeanyOf<string | null>facoltativo——
data[].detected_content_type · variant 1stringfacoltativo——
data[].detected_content_type · variant 2nullfacoltativo——
data[].detected_formatanyOf<string | null>facoltativo——
data[].detected_format · variant 1stringfacoltativo——
data[].detected_format · variant 2nullfacoltativo——
data[].size_bytesanyOf<integer | null>facoltativo——
data[].size_bytes · variant 1integerfacoltativo——
data[].size_bytes · variant 2nullfacoltativo——
data[].checksum_sha256anyOf<string | null>facoltativo——
data[].checksum_sha256 · variant 1stringfacoltativo——
data[].checksum_sha256 · variant 2nullfacoltativo——
data[].source_typestringobbligatorio——
data[].created_atstringobbligatorio—
format: date-time
data[].ready_atanyOf<string | null>facoltativo——
data[].ready_at · variant 1stringfacoltativo—
format: date-time
data[].ready_at · variant 2nullfacoltativo——
data[].expires_atanyOf<string | null>facoltativo——
data[].expires_at · variant 1stringfacoltativo—
format: date-time
data[].expires_at · variant 2nullfacoltativo——
data[].metadataobjectfacoltativo——
data[].uploadanyOf<object | null>facoltativo——
data[].upload · variant 1objectfacoltativo——
data[].upload · variant 1.methodstringfacoltativo—
default: "PUT"
data[].upload · variant 1.urlstringobbligatorio——
data[].upload · variant 1.expires_atstringobbligatorio—
format: date-time
data[].upload · variant 1.headersobjectfacoltativo——
data[].upload · variant 2nullfacoltativo——
data[].download_urlanyOf<string | null>facoltativo——
data[].download_url · variant 1stringfacoltativo——
data[].download_url · variant 2nullfacoltativo——
data[].download_expires_atanyOf<string | null>facoltativo——
data[].download_expires_at · variant 1stringfacoltativo—
format: date-time
data[].download_expires_at · variant 2nullfacoltativo——
paginationobjectobbligatorio——
pagination.nextanyOf<string | null>facoltativo——
pagination.next · variant 1stringfacoltativo——
pagination.next · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
filenamestringobbligatorio—
min length: 1max length: 512
size_bytesanyOf<integer | null>facoltativo——
size_bytes · variant 1integerfacoltativo—
min: 0
size_bytes · variant 2nullfacoltativo——
content_typeanyOf<string | null>facoltativo——
content_type · variant 1stringfacoltativo—
max length: 255
content_type · variant 2nullfacoltativo——
checksum_sha256anyOf<string | null>facoltativo——
checksum_sha256 · variant 1stringfacoltativo—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullfacoltativo——
retention_secondsanyOf<integer | null>facoltativo——
retention_seconds · variant 1integerfacoltativo—
min: 0max: 86400
retention_seconds · variant 2nullfacoltativo——
metadataobjectfacoltativo——

Risposte

201Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
statusstringobbligatorio——
rolestringobbligatorio——
filenamestringobbligatorio——
content_typeanyOf<string | null>facoltativo——
content_type · variant 1stringfacoltativo——
content_type · variant 2nullfacoltativo——
detected_content_typeanyOf<string | null>facoltativo——
detected_content_type · variant 1stringfacoltativo——
detected_content_type · variant 2nullfacoltativo——
detected_formatanyOf<string | null>facoltativo——
detected_format · variant 1stringfacoltativo——
detected_format · variant 2nullfacoltativo——
size_bytesanyOf<integer | null>facoltativo——
size_bytes · variant 1integerfacoltativo——
size_bytes · variant 2nullfacoltativo——
checksum_sha256anyOf<string | null>facoltativo——
checksum_sha256 · variant 1stringfacoltativo——
checksum_sha256 · variant 2nullfacoltativo——
source_typestringobbligatorio——
created_atstringobbligatorio—
format: date-time
ready_atanyOf<string | null>facoltativo——
ready_at · variant 1stringfacoltativo—
format: date-time
ready_at · variant 2nullfacoltativo——
expires_atanyOf<string | null>facoltativo——
expires_at · variant 1stringfacoltativo—
format: date-time
expires_at · variant 2nullfacoltativo——
metadataobjectfacoltativo——
uploadanyOf<object | null>facoltativo——
upload · variant 1objectfacoltativo——
upload · variant 1.methodstringfacoltativo—
default: "PUT"
upload · variant 1.urlstringobbligatorio——
upload · variant 1.expires_atstringobbligatorio—
format: date-time
upload · variant 1.headersobjectfacoltativo——
upload · variant 2nullfacoltativo——
download_urlanyOf<string | null>facoltativo——
download_url · variant 1stringfacoltativo——
download_url · variant 2nullfacoltativo——
download_expires_atanyOf<string | null>facoltativo——
download_expires_at · variant 1stringfacoltativo—
format: date-time
download_expires_at · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
file_idpathstringobbligatorio—

Risposte

204Successful Response

Nessun corpo della risposta.

400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
file_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
statusstringobbligatorio——
rolestringobbligatorio——
filenamestringobbligatorio——
content_typeanyOf<string | null>facoltativo——
content_type · variant 1stringfacoltativo——
content_type · variant 2nullfacoltativo——
detected_content_typeanyOf<string | null>facoltativo——
detected_content_type · variant 1stringfacoltativo——
detected_content_type · variant 2nullfacoltativo——
detected_formatanyOf<string | null>facoltativo——
detected_format · variant 1stringfacoltativo——
detected_format · variant 2nullfacoltativo——
size_bytesanyOf<integer | null>facoltativo——
size_bytes · variant 1integerfacoltativo——
size_bytes · variant 2nullfacoltativo——
checksum_sha256anyOf<string | null>facoltativo——
checksum_sha256 · variant 1stringfacoltativo——
checksum_sha256 · variant 2nullfacoltativo——
source_typestringobbligatorio——
created_atstringobbligatorio—
format: date-time
ready_atanyOf<string | null>facoltativo——
ready_at · variant 1stringfacoltativo—
format: date-time
ready_at · variant 2nullfacoltativo——
expires_atanyOf<string | null>facoltativo——
expires_at · variant 1stringfacoltativo—
format: date-time
expires_at · variant 2nullfacoltativo——
metadataobjectfacoltativo——
uploadanyOf<object | null>facoltativo——
upload · variant 1objectfacoltativo——
upload · variant 1.methodstringfacoltativo—
default: "PUT"
upload · variant 1.urlstringobbligatorio——
upload · variant 1.expires_atstringobbligatorio—
format: date-time
upload · variant 1.headersobjectfacoltativo——
upload · variant 2nullfacoltativo——
download_urlanyOf<string | null>facoltativo——
download_url · variant 1stringfacoltativo——
download_url · variant 2nullfacoltativo——
download_expires_atanyOf<string | null>facoltativo——
download_expires_at · variant 1stringfacoltativo—
format: date-time
download_expires_at · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
file_idpathstringobbligatorio—

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
checksum_sha256anyOf<string | null>facoltativo——
checksum_sha256 · variant 1stringfacoltativo—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullfacoltativo——

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
statusstringobbligatorio——
rolestringobbligatorio——
filenamestringobbligatorio——
content_typeanyOf<string | null>facoltativo——
content_type · variant 1stringfacoltativo——
content_type · variant 2nullfacoltativo——
detected_content_typeanyOf<string | null>facoltativo——
detected_content_type · variant 1stringfacoltativo——
detected_content_type · variant 2nullfacoltativo——
detected_formatanyOf<string | null>facoltativo——
detected_format · variant 1stringfacoltativo——
detected_format · variant 2nullfacoltativo——
size_bytesanyOf<integer | null>facoltativo——
size_bytes · variant 1integerfacoltativo——
size_bytes · variant 2nullfacoltativo——
checksum_sha256anyOf<string | null>facoltativo——
checksum_sha256 · variant 1stringfacoltativo——
checksum_sha256 · variant 2nullfacoltativo——
source_typestringobbligatorio——
created_atstringobbligatorio—
format: date-time
ready_atanyOf<string | null>facoltativo——
ready_at · variant 1stringfacoltativo—
format: date-time
ready_at · variant 2nullfacoltativo——
expires_atanyOf<string | null>facoltativo——
expires_at · variant 1stringfacoltativo—
format: date-time
expires_at · variant 2nullfacoltativo——
metadataobjectfacoltativo——
uploadanyOf<object | null>facoltativo——
upload · variant 1objectfacoltativo——
upload · variant 1.methodstringfacoltativo—
default: "PUT"
upload · variant 1.urlstringobbligatorio——
upload · variant 1.expires_atstringobbligatorio—
format: date-time
upload · variant 1.headersobjectfacoltativo——
upload · variant 2nullfacoltativo——
download_urlanyOf<string | null>facoltativo——
download_url · variant 1stringfacoltativo——
download_url · variant 2nullfacoltativo——
download_expires_atanyOf<string | null>facoltativo——
download_expires_at · variant 1stringfacoltativo—
format: date-time
download_expires_at · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
file_idpathstringobbligatorio—

Risposte

204Successful Response

Nessun corpo della risposta.

400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
file_idpathstringobbligatorio—

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
part_sizeanyOf<integer | null>facoltativo——
part_size · variant 1integerfacoltativo—
min: 5242880max: 5368709120
part_size · variant 2nullfacoltativo——

Risposte

201Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
file_idstringobbligatorio——
upload_idstringobbligatorio——
part_sizeintegerobbligatorio——
max_partsintegerfacoltativo—
default: 10000
expires_atstringobbligatorio—
format: date-time
partsobject[]facoltativo——
parts[]objectfacoltativo——
parts[].part_numberintegerobbligatorio——
parts[].urlstringobbligatorio——
parts[].expires_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
file_idpathstringobbligatorio—

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
partsobject[]obbligatorio—
min items: 1max items: 10000
parts[]objectfacoltativo——
parts[].part_numberintegerobbligatorio—
min: 1max: 10000
parts[].etagstringobbligatorio—
min length: 1max length: 512
checksum_sha256anyOf<string | null>facoltativo——
checksum_sha256 · variant 1stringfacoltativo—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullfacoltativo——

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
statusstringobbligatorio——
rolestringobbligatorio——
filenamestringobbligatorio——
content_typeanyOf<string | null>facoltativo——
content_type · variant 1stringfacoltativo——
content_type · variant 2nullfacoltativo——
detected_content_typeanyOf<string | null>facoltativo——
detected_content_type · variant 1stringfacoltativo——
detected_content_type · variant 2nullfacoltativo——
detected_formatanyOf<string | null>facoltativo——
detected_format · variant 1stringfacoltativo——
detected_format · variant 2nullfacoltativo——
size_bytesanyOf<integer | null>facoltativo——
size_bytes · variant 1integerfacoltativo——
size_bytes · variant 2nullfacoltativo——
checksum_sha256anyOf<string | null>facoltativo——
checksum_sha256 · variant 1stringfacoltativo——
checksum_sha256 · variant 2nullfacoltativo——
source_typestringobbligatorio——
created_atstringobbligatorio—
format: date-time
ready_atanyOf<string | null>facoltativo——
ready_at · variant 1stringfacoltativo—
format: date-time
ready_at · variant 2nullfacoltativo——
expires_atanyOf<string | null>facoltativo——
expires_at · variant 1stringfacoltativo—
format: date-time
expires_at · variant 2nullfacoltativo——
metadataobjectfacoltativo——
uploadanyOf<object | null>facoltativo——
upload · variant 1objectfacoltativo——
upload · variant 1.methodstringfacoltativo—
default: "PUT"
upload · variant 1.urlstringobbligatorio——
upload · variant 1.expires_atstringobbligatorio—
format: date-time
upload · variant 1.headersobjectfacoltativo——
upload · variant 2nullfacoltativo——
download_urlanyOf<string | null>facoltativo——
download_url · variant 1stringfacoltativo——
download_url · variant 2nullfacoltativo——
download_expires_atanyOf<string | null>facoltativo——
download_expires_at · variant 1stringfacoltativo—
format: date-time
download_expires_at · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
file_idpathstringobbligatorio—

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
part_numbersinteger[]obbligatorio—
min items: 1max items: 1000

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
file_idstringobbligatorio——
upload_idstringobbligatorio——
part_sizeintegerobbligatorio——
max_partsintegerfacoltativo—
default: 10000
expires_atstringobbligatorio—
format: date-time
partsobject[]facoltativo——
parts[]objectfacoltativo——
parts[].part_numberintegerobbligatorio——
parts[].urlstringobbligatorio——
parts[].expires_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

AutenticazionePubblico / nessuna autenticazione specifica dell’operazione

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
limitqueryintegerfacoltativo
default: 500min: 1max: 500

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
dataobject[]obbligatorio——
data[]objectfacoltativo——
data[].slugstringobbligatorio——
data[].labelstringobbligatorio——
data[].categorystringobbligatorio——
data[].mime_typesstring[]obbligatorio——
data[].extensionsstring[]obbligatorio——
paginationobjectobbligatorio——
pagination.nextanyOf<string | null>facoltativo——
pagination.next · variant 1stringfacoltativo——
pagination.next · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

AutenticazionePubblico / nessuna autenticazione specifica dell’operazione

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
slugpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
slugstringobbligatorio——
labelstringobbligatorio——
categorystringobbligatorio——
mime_typesstring[]obbligatorio——
extensionsstring[]obbligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

AutenticazionePubblico / nessuna autenticazione specifica dell’operazione

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
slugpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
dataobject[]obbligatorio——
data[]objectfacoltativo——
data[].slugstringobbligatorio——
data[].labelstringobbligatorio——
data[].categorystringobbligatorio——
data[].mime_typesstring[]obbligatorio——
data[].extensionsstring[]obbligatorio——
paginationobjectobbligatorio——
pagination.nextanyOf<string | null>facoltativo——
pagination.next · variant 1stringfacoltativo——
pagination.next · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

AutenticazionePubblico / nessuna autenticazione specifica dell’operazione

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
slugpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
dataobject[]obbligatorio——
data[]objectfacoltativo——
data[].slugstringobbligatorio——
data[].labelstringobbligatorio——
data[].categorystringobbligatorio——
data[].mime_typesstring[]obbligatorio——
data[].extensionsstring[]obbligatorio——
paginationobjectobbligatorio——
pagination.nextanyOf<string | null>facoltativo——
pagination.next · variant 1stringfacoltativo——
pagination.next · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
limitqueryintegerfacoltativo
default: 50min: 1max: 200
afterqueryanyOf<string | null>facoltativo—
statusqueryanyOf<string | null>facoltativo—
tagqueryanyOf<string | null>facoltativo—
originqueryanyOf<string | null>facoltativo—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
dataobject[]obbligatorio——
data[]objectfacoltativo——
data[].idstringobbligatorio——
data[].kindstringobbligatorio——
data[].statusstringobbligatorio——
data[].progressintegerobbligatorio——
data[].taganyOf<string | null>facoltativo——
data[].tag · variant 1stringfacoltativo——
data[].tag · variant 2nullfacoltativo——
data[].client_reference_idanyOf<string | null>facoltativo——
data[].client_reference_id · variant 1stringfacoltativo——
data[].client_reference_id · variant 2nullfacoltativo——
data[].metadataobjectfacoltativo——
data[].prioritystringobbligatorio——
data[].concurrency_limitintegerfacoltativo—
default: 1
data[].originstringobbligatorio——
data[].created_atstringobbligatorio—
format: date-time
data[].started_atanyOf<string | null>facoltativo——
data[].started_at · variant 1stringfacoltativo—
format: date-time
data[].started_at · variant 2nullfacoltativo——
data[].completed_atanyOf<string | null>facoltativo——
data[].completed_at · variant 1stringfacoltativo—
format: date-time
data[].completed_at · variant 2nullfacoltativo——
data[].error_codeanyOf<string | null>facoltativo——
data[].error_code · variant 1stringfacoltativo——
data[].error_code · variant 2nullfacoltativo——
data[].error_messageanyOf<string | null>facoltativo——
data[].error_message · variant 1stringfacoltativo——
data[].error_message · variant 2nullfacoltativo——
data[].tasksobject[]facoltativo——
data[].tasks[]objectfacoltativo——
data[].tasks[].idstringobbligatorio——
data[].tasks[].job_idstringobbligatorio——
data[].tasks[].namestringobbligatorio——
data[].tasks[].operationstringobbligatorio——
data[].tasks[].statusstringobbligatorio——
data[].tasks[].progressintegerobbligatorio——
data[].tasks[].inputobjectobbligatorio——
data[].tasks[].optionsobjectobbligatorio——
data[].tasks[].resultobjectobbligatorio——
data[].tasks[].requiredbooleanobbligatorio——
data[].tasks[].runtime_classstringobbligatorio——
data[].tasks[].prioritystringobbligatorio——
data[].tasks[].attempt_countintegerobbligatorio——
data[].tasks[].max_attemptsintegerobbligatorio——
data[].tasks[].error_codeanyOf<string | null>facoltativo——
data[].tasks[].error_code · variant 1stringfacoltativo——
data[].tasks[].error_code · variant 2nullfacoltativo——
data[].tasks[].error_messageanyOf<string | null>facoltativo——
data[].tasks[].error_message · variant 1stringfacoltativo——
data[].tasks[].error_message · variant 2nullfacoltativo——
data[].tasks[].created_atstringobbligatorio—
format: date-time
data[].tasks[].queued_atanyOf<string | null>facoltativo——
data[].tasks[].queued_at · variant 1stringfacoltativo—
format: date-time
data[].tasks[].queued_at · variant 2nullfacoltativo——
data[].tasks[].started_atanyOf<string | null>facoltativo——
data[].tasks[].started_at · variant 1stringfacoltativo—
format: date-time
data[].tasks[].started_at · variant 2nullfacoltativo——
data[].tasks[].completed_atanyOf<string | null>facoltativo——
data[].tasks[].completed_at · variant 1stringfacoltativo—
format: date-time
data[].tasks[].completed_at · variant 2nullfacoltativo——
data[].tasks[].attemptsobject[]facoltativo——
data[].tasks[].attempts[]objectfacoltativo——
data[].tasks[].attempts[].idstringobbligatorio——
data[].tasks[].attempts[].attempt_numberintegerobbligatorio——
data[].tasks[].attempts[].statusstringobbligatorio——
data[].tasks[].attempts[].worker_idanyOf<string | null>facoltativo——
data[].tasks[].attempts[].worker_id · variant 1stringfacoltativo——
data[].tasks[].attempts[].worker_id · variant 2nullfacoltativo——
data[].tasks[].attempts[].runtime_classanyOf<string | null>facoltativo——
data[].tasks[].attempts[].runtime_class · variant 1stringfacoltativo——
data[].tasks[].attempts[].runtime_class · variant 2nullfacoltativo——
data[].tasks[].attempts[].regionanyOf<string | null>facoltativo——
data[].tasks[].attempts[].region · variant 1stringfacoltativo——
data[].tasks[].attempts[].region · variant 2nullfacoltativo——
data[].tasks[].attempts[].engineanyOf<string | null>facoltativo——
data[].tasks[].attempts[].engine · variant 1stringfacoltativo——
data[].tasks[].attempts[].engine · variant 2nullfacoltativo——
data[].tasks[].attempts[].engine_versionanyOf<string | null>facoltativo——
data[].tasks[].attempts[].engine_version · variant 1stringfacoltativo——
data[].tasks[].attempts[].engine_version · variant 2nullfacoltativo——
data[].tasks[].attempts[].input_bytesanyOf<integer | null>facoltativo——
data[].tasks[].attempts[].input_bytes · variant 1integerfacoltativo——
data[].tasks[].attempts[].input_bytes · variant 2nullfacoltativo——
data[].tasks[].attempts[].output_bytesanyOf<integer | null>facoltativo——
data[].tasks[].attempts[].output_bytes · variant 1integerfacoltativo——
data[].tasks[].attempts[].output_bytes · variant 2nullfacoltativo——
data[].tasks[].attempts[].wall_msanyOf<integer | null>facoltativo——
data[].tasks[].attempts[].wall_ms · variant 1integerfacoltativo——
data[].tasks[].attempts[].wall_ms · variant 2nullfacoltativo——
data[].tasks[].attempts[].cpu_msanyOf<integer | null>facoltativo——
data[].tasks[].attempts[].cpu_ms · variant 1integerfacoltativo——
data[].tasks[].attempts[].cpu_ms · variant 2nullfacoltativo——
data[].tasks[].attempts[].peak_memory_mbanyOf<integer | null>facoltativo——
data[].tasks[].attempts[].peak_memory_mb · variant 1integerfacoltativo——
data[].tasks[].attempts[].peak_memory_mb · variant 2nullfacoltativo——
data[].tasks[].attempts[].temp_bytesanyOf<integer | null>facoltativo——
data[].tasks[].attempts[].temp_bytes · variant 1integerfacoltativo——
data[].tasks[].attempts[].temp_bytes · variant 2nullfacoltativo——
data[].tasks[].attempts[].error_codeanyOf<string | null>facoltativo——
data[].tasks[].attempts[].error_code · variant 1stringfacoltativo——
data[].tasks[].attempts[].error_code · variant 2nullfacoltativo——
data[].tasks[].attempts[].error_messageanyOf<string | null>facoltativo——
data[].tasks[].attempts[].error_message · variant 1stringfacoltativo——
data[].tasks[].attempts[].error_message · variant 2nullfacoltativo——
data[].tasks[].attempts[].estimated_creditsanyOf<string | null>facoltativo——
data[].tasks[].attempts[].estimated_credits · variant 1stringfacoltativo——
data[].tasks[].attempts[].estimated_credits · variant 2nullfacoltativo——
data[].tasks[].attempts[].settled_creditsanyOf<string | null>facoltativo——
data[].tasks[].attempts[].settled_credits · variant 1stringfacoltativo——
data[].tasks[].attempts[].settled_credits · variant 2nullfacoltativo——
data[].tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facoltativo——
data[].tasks[].attempts[].external_side_effect_started_at · variant 1stringfacoltativo—
format: date-time
data[].tasks[].attempts[].external_side_effect_started_at · variant 2nullfacoltativo——
data[].tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facoltativo——
data[].tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacoltativo—
format: date-time
data[].tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacoltativo——
data[].tasks[].attempts[].started_atstringobbligatorio—
format: date-time
data[].tasks[].attempts[].completed_atanyOf<string | null>facoltativo——
data[].tasks[].attempts[].completed_at · variant 1stringfacoltativo—
format: date-time
data[].tasks[].attempts[].completed_at · variant 2nullfacoltativo——
paginationobjectobbligatorio——
pagination.nextanyOf<string | null>facoltativo——
pagination.next · variant 1stringfacoltativo——
pagination.next · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
Idempotency-KeyheaderanyOf<string | null>facoltativo—

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
tasksobjectobbligatorio——
taganyOf<string | null>facoltativo——
tag · variant 1stringfacoltativo—
max length: 255
tag · variant 2nullfacoltativo——
client_reference_idanyOf<string | null>facoltativo——
client_reference_id · variant 1stringfacoltativo—
max length: 255
client_reference_id · variant 2nullfacoltativo——
metadataobjectfacoltativo——
prioritystringfacoltativo—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>facoltativo——
retention_seconds · variant 1integerfacoltativo—
min: 0max: 86400
retention_seconds · variant 2nullfacoltativo——

Risposte

201Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
kindstringobbligatorio——
statusstringobbligatorio——
progressintegerobbligatorio——
taganyOf<string | null>facoltativo——
tag · variant 1stringfacoltativo——
tag · variant 2nullfacoltativo——
client_reference_idanyOf<string | null>facoltativo——
client_reference_id · variant 1stringfacoltativo——
client_reference_id · variant 2nullfacoltativo——
metadataobjectfacoltativo——
prioritystringobbligatorio——
concurrency_limitintegerfacoltativo—
default: 1
originstringobbligatorio——
created_atstringobbligatorio—
format: date-time
started_atanyOf<string | null>facoltativo——
started_at · variant 1stringfacoltativo—
format: date-time
started_at · variant 2nullfacoltativo——
completed_atanyOf<string | null>facoltativo——
completed_at · variant 1stringfacoltativo—
format: date-time
completed_at · variant 2nullfacoltativo——
error_codeanyOf<string | null>facoltativo——
error_code · variant 1stringfacoltativo——
error_code · variant 2nullfacoltativo——
error_messageanyOf<string | null>facoltativo——
error_message · variant 1stringfacoltativo——
error_message · variant 2nullfacoltativo——
tasksobject[]facoltativo——
tasks[]objectfacoltativo——
tasks[].idstringobbligatorio——
tasks[].job_idstringobbligatorio——
tasks[].namestringobbligatorio——
tasks[].operationstringobbligatorio——
tasks[].statusstringobbligatorio——
tasks[].progressintegerobbligatorio——
tasks[].inputobjectobbligatorio——
tasks[].optionsobjectobbligatorio——
tasks[].resultobjectobbligatorio——
tasks[].requiredbooleanobbligatorio——
tasks[].runtime_classstringobbligatorio——
tasks[].prioritystringobbligatorio——
tasks[].attempt_countintegerobbligatorio——
tasks[].max_attemptsintegerobbligatorio——
tasks[].error_codeanyOf<string | null>facoltativo——
tasks[].error_code · variant 1stringfacoltativo——
tasks[].error_code · variant 2nullfacoltativo——
tasks[].error_messageanyOf<string | null>facoltativo——
tasks[].error_message · variant 1stringfacoltativo——
tasks[].error_message · variant 2nullfacoltativo——
tasks[].created_atstringobbligatorio—
format: date-time
tasks[].queued_atanyOf<string | null>facoltativo——
tasks[].queued_at · variant 1stringfacoltativo—
format: date-time
tasks[].queued_at · variant 2nullfacoltativo——
tasks[].started_atanyOf<string | null>facoltativo——
tasks[].started_at · variant 1stringfacoltativo—
format: date-time
tasks[].started_at · variant 2nullfacoltativo——
tasks[].completed_atanyOf<string | null>facoltativo——
tasks[].completed_at · variant 1stringfacoltativo—
format: date-time
tasks[].completed_at · variant 2nullfacoltativo——
tasks[].attemptsobject[]facoltativo——
tasks[].attempts[]objectfacoltativo——
tasks[].attempts[].idstringobbligatorio——
tasks[].attempts[].attempt_numberintegerobbligatorio——
tasks[].attempts[].statusstringobbligatorio——
tasks[].attempts[].worker_idanyOf<string | null>facoltativo——
tasks[].attempts[].worker_id · variant 1stringfacoltativo——
tasks[].attempts[].worker_id · variant 2nullfacoltativo——
tasks[].attempts[].runtime_classanyOf<string | null>facoltativo——
tasks[].attempts[].runtime_class · variant 1stringfacoltativo——
tasks[].attempts[].runtime_class · variant 2nullfacoltativo——
tasks[].attempts[].regionanyOf<string | null>facoltativo——
tasks[].attempts[].region · variant 1stringfacoltativo——
tasks[].attempts[].region · variant 2nullfacoltativo——
tasks[].attempts[].engineanyOf<string | null>facoltativo——
tasks[].attempts[].engine · variant 1stringfacoltativo——
tasks[].attempts[].engine · variant 2nullfacoltativo——
tasks[].attempts[].engine_versionanyOf<string | null>facoltativo——
tasks[].attempts[].engine_version · variant 1stringfacoltativo——
tasks[].attempts[].engine_version · variant 2nullfacoltativo——
tasks[].attempts[].input_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].input_bytes · variant 1integerfacoltativo——
tasks[].attempts[].input_bytes · variant 2nullfacoltativo——
tasks[].attempts[].output_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].output_bytes · variant 1integerfacoltativo——
tasks[].attempts[].output_bytes · variant 2nullfacoltativo——
tasks[].attempts[].wall_msanyOf<integer | null>facoltativo——
tasks[].attempts[].wall_ms · variant 1integerfacoltativo——
tasks[].attempts[].wall_ms · variant 2nullfacoltativo——
tasks[].attempts[].cpu_msanyOf<integer | null>facoltativo——
tasks[].attempts[].cpu_ms · variant 1integerfacoltativo——
tasks[].attempts[].cpu_ms · variant 2nullfacoltativo——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>facoltativo——
tasks[].attempts[].peak_memory_mb · variant 1integerfacoltativo——
tasks[].attempts[].peak_memory_mb · variant 2nullfacoltativo——
tasks[].attempts[].temp_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].temp_bytes · variant 1integerfacoltativo——
tasks[].attempts[].temp_bytes · variant 2nullfacoltativo——
tasks[].attempts[].error_codeanyOf<string | null>facoltativo——
tasks[].attempts[].error_code · variant 1stringfacoltativo——
tasks[].attempts[].error_code · variant 2nullfacoltativo——
tasks[].attempts[].error_messageanyOf<string | null>facoltativo——
tasks[].attempts[].error_message · variant 1stringfacoltativo——
tasks[].attempts[].error_message · variant 2nullfacoltativo——
tasks[].attempts[].estimated_creditsanyOf<string | null>facoltativo——
tasks[].attempts[].estimated_credits · variant 1stringfacoltativo——
tasks[].attempts[].estimated_credits · variant 2nullfacoltativo——
tasks[].attempts[].settled_creditsanyOf<string | null>facoltativo——
tasks[].attempts[].settled_credits · variant 1stringfacoltativo——
tasks[].attempts[].settled_credits · variant 2nullfacoltativo——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facoltativo——
tasks[].attempts[].external_side_effect_started_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullfacoltativo——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facoltativo——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacoltativo——
tasks[].attempts[].started_atstringobbligatorio—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>facoltativo——
tasks[].attempts[].completed_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].completed_at · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
job_idpathstringobbligatorio—
include_attemptsquerybooleanfacoltativo
default: false

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
kindstringobbligatorio——
statusstringobbligatorio——
progressintegerobbligatorio——
taganyOf<string | null>facoltativo——
tag · variant 1stringfacoltativo——
tag · variant 2nullfacoltativo——
client_reference_idanyOf<string | null>facoltativo——
client_reference_id · variant 1stringfacoltativo——
client_reference_id · variant 2nullfacoltativo——
metadataobjectfacoltativo——
prioritystringobbligatorio——
concurrency_limitintegerfacoltativo—
default: 1
originstringobbligatorio——
created_atstringobbligatorio—
format: date-time
started_atanyOf<string | null>facoltativo——
started_at · variant 1stringfacoltativo—
format: date-time
started_at · variant 2nullfacoltativo——
completed_atanyOf<string | null>facoltativo——
completed_at · variant 1stringfacoltativo—
format: date-time
completed_at · variant 2nullfacoltativo——
error_codeanyOf<string | null>facoltativo——
error_code · variant 1stringfacoltativo——
error_code · variant 2nullfacoltativo——
error_messageanyOf<string | null>facoltativo——
error_message · variant 1stringfacoltativo——
error_message · variant 2nullfacoltativo——
tasksobject[]facoltativo——
tasks[]objectfacoltativo——
tasks[].idstringobbligatorio——
tasks[].job_idstringobbligatorio——
tasks[].namestringobbligatorio——
tasks[].operationstringobbligatorio——
tasks[].statusstringobbligatorio——
tasks[].progressintegerobbligatorio——
tasks[].inputobjectobbligatorio——
tasks[].optionsobjectobbligatorio——
tasks[].resultobjectobbligatorio——
tasks[].requiredbooleanobbligatorio——
tasks[].runtime_classstringobbligatorio——
tasks[].prioritystringobbligatorio——
tasks[].attempt_countintegerobbligatorio——
tasks[].max_attemptsintegerobbligatorio——
tasks[].error_codeanyOf<string | null>facoltativo——
tasks[].error_code · variant 1stringfacoltativo——
tasks[].error_code · variant 2nullfacoltativo——
tasks[].error_messageanyOf<string | null>facoltativo——
tasks[].error_message · variant 1stringfacoltativo——
tasks[].error_message · variant 2nullfacoltativo——
tasks[].created_atstringobbligatorio—
format: date-time
tasks[].queued_atanyOf<string | null>facoltativo——
tasks[].queued_at · variant 1stringfacoltativo—
format: date-time
tasks[].queued_at · variant 2nullfacoltativo——
tasks[].started_atanyOf<string | null>facoltativo——
tasks[].started_at · variant 1stringfacoltativo—
format: date-time
tasks[].started_at · variant 2nullfacoltativo——
tasks[].completed_atanyOf<string | null>facoltativo——
tasks[].completed_at · variant 1stringfacoltativo—
format: date-time
tasks[].completed_at · variant 2nullfacoltativo——
tasks[].attemptsobject[]facoltativo——
tasks[].attempts[]objectfacoltativo——
tasks[].attempts[].idstringobbligatorio——
tasks[].attempts[].attempt_numberintegerobbligatorio——
tasks[].attempts[].statusstringobbligatorio——
tasks[].attempts[].worker_idanyOf<string | null>facoltativo——
tasks[].attempts[].worker_id · variant 1stringfacoltativo——
tasks[].attempts[].worker_id · variant 2nullfacoltativo——
tasks[].attempts[].runtime_classanyOf<string | null>facoltativo——
tasks[].attempts[].runtime_class · variant 1stringfacoltativo——
tasks[].attempts[].runtime_class · variant 2nullfacoltativo——
tasks[].attempts[].regionanyOf<string | null>facoltativo——
tasks[].attempts[].region · variant 1stringfacoltativo——
tasks[].attempts[].region · variant 2nullfacoltativo——
tasks[].attempts[].engineanyOf<string | null>facoltativo——
tasks[].attempts[].engine · variant 1stringfacoltativo——
tasks[].attempts[].engine · variant 2nullfacoltativo——
tasks[].attempts[].engine_versionanyOf<string | null>facoltativo——
tasks[].attempts[].engine_version · variant 1stringfacoltativo——
tasks[].attempts[].engine_version · variant 2nullfacoltativo——
tasks[].attempts[].input_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].input_bytes · variant 1integerfacoltativo——
tasks[].attempts[].input_bytes · variant 2nullfacoltativo——
tasks[].attempts[].output_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].output_bytes · variant 1integerfacoltativo——
tasks[].attempts[].output_bytes · variant 2nullfacoltativo——
tasks[].attempts[].wall_msanyOf<integer | null>facoltativo——
tasks[].attempts[].wall_ms · variant 1integerfacoltativo——
tasks[].attempts[].wall_ms · variant 2nullfacoltativo——
tasks[].attempts[].cpu_msanyOf<integer | null>facoltativo——
tasks[].attempts[].cpu_ms · variant 1integerfacoltativo——
tasks[].attempts[].cpu_ms · variant 2nullfacoltativo——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>facoltativo——
tasks[].attempts[].peak_memory_mb · variant 1integerfacoltativo——
tasks[].attempts[].peak_memory_mb · variant 2nullfacoltativo——
tasks[].attempts[].temp_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].temp_bytes · variant 1integerfacoltativo——
tasks[].attempts[].temp_bytes · variant 2nullfacoltativo——
tasks[].attempts[].error_codeanyOf<string | null>facoltativo——
tasks[].attempts[].error_code · variant 1stringfacoltativo——
tasks[].attempts[].error_code · variant 2nullfacoltativo——
tasks[].attempts[].error_messageanyOf<string | null>facoltativo——
tasks[].attempts[].error_message · variant 1stringfacoltativo——
tasks[].attempts[].error_message · variant 2nullfacoltativo——
tasks[].attempts[].estimated_creditsanyOf<string | null>facoltativo——
tasks[].attempts[].estimated_credits · variant 1stringfacoltativo——
tasks[].attempts[].estimated_credits · variant 2nullfacoltativo——
tasks[].attempts[].settled_creditsanyOf<string | null>facoltativo——
tasks[].attempts[].settled_credits · variant 1stringfacoltativo——
tasks[].attempts[].settled_credits · variant 2nullfacoltativo——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facoltativo——
tasks[].attempts[].external_side_effect_started_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullfacoltativo——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facoltativo——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacoltativo——
tasks[].attempts[].started_atstringobbligatorio—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>facoltativo——
tasks[].attempts[].completed_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].completed_at · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
job_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
kindstringobbligatorio——
statusstringobbligatorio——
progressintegerobbligatorio——
taganyOf<string | null>facoltativo——
tag · variant 1stringfacoltativo——
tag · variant 2nullfacoltativo——
client_reference_idanyOf<string | null>facoltativo——
client_reference_id · variant 1stringfacoltativo——
client_reference_id · variant 2nullfacoltativo——
metadataobjectfacoltativo——
prioritystringobbligatorio——
concurrency_limitintegerfacoltativo—
default: 1
originstringobbligatorio——
created_atstringobbligatorio—
format: date-time
started_atanyOf<string | null>facoltativo——
started_at · variant 1stringfacoltativo—
format: date-time
started_at · variant 2nullfacoltativo——
completed_atanyOf<string | null>facoltativo——
completed_at · variant 1stringfacoltativo—
format: date-time
completed_at · variant 2nullfacoltativo——
error_codeanyOf<string | null>facoltativo——
error_code · variant 1stringfacoltativo——
error_code · variant 2nullfacoltativo——
error_messageanyOf<string | null>facoltativo——
error_message · variant 1stringfacoltativo——
error_message · variant 2nullfacoltativo——
tasksobject[]facoltativo——
tasks[]objectfacoltativo——
tasks[].idstringobbligatorio——
tasks[].job_idstringobbligatorio——
tasks[].namestringobbligatorio——
tasks[].operationstringobbligatorio——
tasks[].statusstringobbligatorio——
tasks[].progressintegerobbligatorio——
tasks[].inputobjectobbligatorio——
tasks[].optionsobjectobbligatorio——
tasks[].resultobjectobbligatorio——
tasks[].requiredbooleanobbligatorio——
tasks[].runtime_classstringobbligatorio——
tasks[].prioritystringobbligatorio——
tasks[].attempt_countintegerobbligatorio——
tasks[].max_attemptsintegerobbligatorio——
tasks[].error_codeanyOf<string | null>facoltativo——
tasks[].error_code · variant 1stringfacoltativo——
tasks[].error_code · variant 2nullfacoltativo——
tasks[].error_messageanyOf<string | null>facoltativo——
tasks[].error_message · variant 1stringfacoltativo——
tasks[].error_message · variant 2nullfacoltativo——
tasks[].created_atstringobbligatorio—
format: date-time
tasks[].queued_atanyOf<string | null>facoltativo——
tasks[].queued_at · variant 1stringfacoltativo—
format: date-time
tasks[].queued_at · variant 2nullfacoltativo——
tasks[].started_atanyOf<string | null>facoltativo——
tasks[].started_at · variant 1stringfacoltativo—
format: date-time
tasks[].started_at · variant 2nullfacoltativo——
tasks[].completed_atanyOf<string | null>facoltativo——
tasks[].completed_at · variant 1stringfacoltativo—
format: date-time
tasks[].completed_at · variant 2nullfacoltativo——
tasks[].attemptsobject[]facoltativo——
tasks[].attempts[]objectfacoltativo——
tasks[].attempts[].idstringobbligatorio——
tasks[].attempts[].attempt_numberintegerobbligatorio——
tasks[].attempts[].statusstringobbligatorio——
tasks[].attempts[].worker_idanyOf<string | null>facoltativo——
tasks[].attempts[].worker_id · variant 1stringfacoltativo——
tasks[].attempts[].worker_id · variant 2nullfacoltativo——
tasks[].attempts[].runtime_classanyOf<string | null>facoltativo——
tasks[].attempts[].runtime_class · variant 1stringfacoltativo——
tasks[].attempts[].runtime_class · variant 2nullfacoltativo——
tasks[].attempts[].regionanyOf<string | null>facoltativo——
tasks[].attempts[].region · variant 1stringfacoltativo——
tasks[].attempts[].region · variant 2nullfacoltativo——
tasks[].attempts[].engineanyOf<string | null>facoltativo——
tasks[].attempts[].engine · variant 1stringfacoltativo——
tasks[].attempts[].engine · variant 2nullfacoltativo——
tasks[].attempts[].engine_versionanyOf<string | null>facoltativo——
tasks[].attempts[].engine_version · variant 1stringfacoltativo——
tasks[].attempts[].engine_version · variant 2nullfacoltativo——
tasks[].attempts[].input_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].input_bytes · variant 1integerfacoltativo——
tasks[].attempts[].input_bytes · variant 2nullfacoltativo——
tasks[].attempts[].output_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].output_bytes · variant 1integerfacoltativo——
tasks[].attempts[].output_bytes · variant 2nullfacoltativo——
tasks[].attempts[].wall_msanyOf<integer | null>facoltativo——
tasks[].attempts[].wall_ms · variant 1integerfacoltativo——
tasks[].attempts[].wall_ms · variant 2nullfacoltativo——
tasks[].attempts[].cpu_msanyOf<integer | null>facoltativo——
tasks[].attempts[].cpu_ms · variant 1integerfacoltativo——
tasks[].attempts[].cpu_ms · variant 2nullfacoltativo——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>facoltativo——
tasks[].attempts[].peak_memory_mb · variant 1integerfacoltativo——
tasks[].attempts[].peak_memory_mb · variant 2nullfacoltativo——
tasks[].attempts[].temp_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].temp_bytes · variant 1integerfacoltativo——
tasks[].attempts[].temp_bytes · variant 2nullfacoltativo——
tasks[].attempts[].error_codeanyOf<string | null>facoltativo——
tasks[].attempts[].error_code · variant 1stringfacoltativo——
tasks[].attempts[].error_code · variant 2nullfacoltativo——
tasks[].attempts[].error_messageanyOf<string | null>facoltativo——
tasks[].attempts[].error_message · variant 1stringfacoltativo——
tasks[].attempts[].error_message · variant 2nullfacoltativo——
tasks[].attempts[].estimated_creditsanyOf<string | null>facoltativo——
tasks[].attempts[].estimated_credits · variant 1stringfacoltativo——
tasks[].attempts[].estimated_credits · variant 2nullfacoltativo——
tasks[].attempts[].settled_creditsanyOf<string | null>facoltativo——
tasks[].attempts[].settled_credits · variant 1stringfacoltativo——
tasks[].attempts[].settled_credits · variant 2nullfacoltativo——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facoltativo——
tasks[].attempts[].external_side_effect_started_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullfacoltativo——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facoltativo——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacoltativo——
tasks[].attempts[].started_atstringobbligatorio—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>facoltativo——
tasks[].attempts[].completed_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].completed_at · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
job_idpathstringobbligatorio—
timeoutqueryintegerfacoltativo
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>facoltativo—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
bodyunknownobbligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
job_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
kindstringobbligatorio——
statusstringobbligatorio——
progressintegerobbligatorio——
taganyOf<string | null>facoltativo——
tag · variant 1stringfacoltativo——
tag · variant 2nullfacoltativo——
client_reference_idanyOf<string | null>facoltativo——
client_reference_id · variant 1stringfacoltativo——
client_reference_id · variant 2nullfacoltativo——
metadataobjectfacoltativo——
prioritystringobbligatorio——
concurrency_limitintegerfacoltativo—
default: 1
originstringobbligatorio——
created_atstringobbligatorio—
format: date-time
started_atanyOf<string | null>facoltativo——
started_at · variant 1stringfacoltativo—
format: date-time
started_at · variant 2nullfacoltativo——
completed_atanyOf<string | null>facoltativo——
completed_at · variant 1stringfacoltativo—
format: date-time
completed_at · variant 2nullfacoltativo——
error_codeanyOf<string | null>facoltativo——
error_code · variant 1stringfacoltativo——
error_code · variant 2nullfacoltativo——
error_messageanyOf<string | null>facoltativo——
error_message · variant 1stringfacoltativo——
error_message · variant 2nullfacoltativo——
tasksobject[]facoltativo——
tasks[]objectfacoltativo——
tasks[].idstringobbligatorio——
tasks[].job_idstringobbligatorio——
tasks[].namestringobbligatorio——
tasks[].operationstringobbligatorio——
tasks[].statusstringobbligatorio——
tasks[].progressintegerobbligatorio——
tasks[].inputobjectobbligatorio——
tasks[].optionsobjectobbligatorio——
tasks[].resultobjectobbligatorio——
tasks[].requiredbooleanobbligatorio——
tasks[].runtime_classstringobbligatorio——
tasks[].prioritystringobbligatorio——
tasks[].attempt_countintegerobbligatorio——
tasks[].max_attemptsintegerobbligatorio——
tasks[].error_codeanyOf<string | null>facoltativo——
tasks[].error_code · variant 1stringfacoltativo——
tasks[].error_code · variant 2nullfacoltativo——
tasks[].error_messageanyOf<string | null>facoltativo——
tasks[].error_message · variant 1stringfacoltativo——
tasks[].error_message · variant 2nullfacoltativo——
tasks[].created_atstringobbligatorio—
format: date-time
tasks[].queued_atanyOf<string | null>facoltativo——
tasks[].queued_at · variant 1stringfacoltativo—
format: date-time
tasks[].queued_at · variant 2nullfacoltativo——
tasks[].started_atanyOf<string | null>facoltativo——
tasks[].started_at · variant 1stringfacoltativo—
format: date-time
tasks[].started_at · variant 2nullfacoltativo——
tasks[].completed_atanyOf<string | null>facoltativo——
tasks[].completed_at · variant 1stringfacoltativo—
format: date-time
tasks[].completed_at · variant 2nullfacoltativo——
tasks[].attemptsobject[]facoltativo——
tasks[].attempts[]objectfacoltativo——
tasks[].attempts[].idstringobbligatorio——
tasks[].attempts[].attempt_numberintegerobbligatorio——
tasks[].attempts[].statusstringobbligatorio——
tasks[].attempts[].worker_idanyOf<string | null>facoltativo——
tasks[].attempts[].worker_id · variant 1stringfacoltativo——
tasks[].attempts[].worker_id · variant 2nullfacoltativo——
tasks[].attempts[].runtime_classanyOf<string | null>facoltativo——
tasks[].attempts[].runtime_class · variant 1stringfacoltativo——
tasks[].attempts[].runtime_class · variant 2nullfacoltativo——
tasks[].attempts[].regionanyOf<string | null>facoltativo——
tasks[].attempts[].region · variant 1stringfacoltativo——
tasks[].attempts[].region · variant 2nullfacoltativo——
tasks[].attempts[].engineanyOf<string | null>facoltativo——
tasks[].attempts[].engine · variant 1stringfacoltativo——
tasks[].attempts[].engine · variant 2nullfacoltativo——
tasks[].attempts[].engine_versionanyOf<string | null>facoltativo——
tasks[].attempts[].engine_version · variant 1stringfacoltativo——
tasks[].attempts[].engine_version · variant 2nullfacoltativo——
tasks[].attempts[].input_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].input_bytes · variant 1integerfacoltativo——
tasks[].attempts[].input_bytes · variant 2nullfacoltativo——
tasks[].attempts[].output_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].output_bytes · variant 1integerfacoltativo——
tasks[].attempts[].output_bytes · variant 2nullfacoltativo——
tasks[].attempts[].wall_msanyOf<integer | null>facoltativo——
tasks[].attempts[].wall_ms · variant 1integerfacoltativo——
tasks[].attempts[].wall_ms · variant 2nullfacoltativo——
tasks[].attempts[].cpu_msanyOf<integer | null>facoltativo——
tasks[].attempts[].cpu_ms · variant 1integerfacoltativo——
tasks[].attempts[].cpu_ms · variant 2nullfacoltativo——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>facoltativo——
tasks[].attempts[].peak_memory_mb · variant 1integerfacoltativo——
tasks[].attempts[].peak_memory_mb · variant 2nullfacoltativo——
tasks[].attempts[].temp_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].temp_bytes · variant 1integerfacoltativo——
tasks[].attempts[].temp_bytes · variant 2nullfacoltativo——
tasks[].attempts[].error_codeanyOf<string | null>facoltativo——
tasks[].attempts[].error_code · variant 1stringfacoltativo——
tasks[].attempts[].error_code · variant 2nullfacoltativo——
tasks[].attempts[].error_messageanyOf<string | null>facoltativo——
tasks[].attempts[].error_message · variant 1stringfacoltativo——
tasks[].attempts[].error_message · variant 2nullfacoltativo——
tasks[].attempts[].estimated_creditsanyOf<string | null>facoltativo——
tasks[].attempts[].estimated_credits · variant 1stringfacoltativo——
tasks[].attempts[].estimated_credits · variant 2nullfacoltativo——
tasks[].attempts[].settled_creditsanyOf<string | null>facoltativo——
tasks[].attempts[].settled_credits · variant 1stringfacoltativo——
tasks[].attempts[].settled_credits · variant 2nullfacoltativo——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facoltativo——
tasks[].attempts[].external_side_effect_started_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullfacoltativo——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facoltativo——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacoltativo——
tasks[].attempts[].started_atstringobbligatorio—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>facoltativo——
tasks[].attempts[].completed_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].completed_at · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
job_idpathstringobbligatorio—
timeoutqueryintegerfacoltativo
default: 20min: 0max: 30

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
kindstringobbligatorio——
statusstringobbligatorio——
progressintegerobbligatorio——
taganyOf<string | null>facoltativo——
tag · variant 1stringfacoltativo——
tag · variant 2nullfacoltativo——
client_reference_idanyOf<string | null>facoltativo——
client_reference_id · variant 1stringfacoltativo——
client_reference_id · variant 2nullfacoltativo——
metadataobjectfacoltativo——
prioritystringobbligatorio——
concurrency_limitintegerfacoltativo—
default: 1
originstringobbligatorio——
created_atstringobbligatorio—
format: date-time
started_atanyOf<string | null>facoltativo——
started_at · variant 1stringfacoltativo—
format: date-time
started_at · variant 2nullfacoltativo——
completed_atanyOf<string | null>facoltativo——
completed_at · variant 1stringfacoltativo—
format: date-time
completed_at · variant 2nullfacoltativo——
error_codeanyOf<string | null>facoltativo——
error_code · variant 1stringfacoltativo——
error_code · variant 2nullfacoltativo——
error_messageanyOf<string | null>facoltativo——
error_message · variant 1stringfacoltativo——
error_message · variant 2nullfacoltativo——
tasksobject[]facoltativo——
tasks[]objectfacoltativo——
tasks[].idstringobbligatorio——
tasks[].job_idstringobbligatorio——
tasks[].namestringobbligatorio——
tasks[].operationstringobbligatorio——
tasks[].statusstringobbligatorio——
tasks[].progressintegerobbligatorio——
tasks[].inputobjectobbligatorio——
tasks[].optionsobjectobbligatorio——
tasks[].resultobjectobbligatorio——
tasks[].requiredbooleanobbligatorio——
tasks[].runtime_classstringobbligatorio——
tasks[].prioritystringobbligatorio——
tasks[].attempt_countintegerobbligatorio——
tasks[].max_attemptsintegerobbligatorio——
tasks[].error_codeanyOf<string | null>facoltativo——
tasks[].error_code · variant 1stringfacoltativo——
tasks[].error_code · variant 2nullfacoltativo——
tasks[].error_messageanyOf<string | null>facoltativo——
tasks[].error_message · variant 1stringfacoltativo——
tasks[].error_message · variant 2nullfacoltativo——
tasks[].created_atstringobbligatorio—
format: date-time
tasks[].queued_atanyOf<string | null>facoltativo——
tasks[].queued_at · variant 1stringfacoltativo—
format: date-time
tasks[].queued_at · variant 2nullfacoltativo——
tasks[].started_atanyOf<string | null>facoltativo——
tasks[].started_at · variant 1stringfacoltativo—
format: date-time
tasks[].started_at · variant 2nullfacoltativo——
tasks[].completed_atanyOf<string | null>facoltativo——
tasks[].completed_at · variant 1stringfacoltativo—
format: date-time
tasks[].completed_at · variant 2nullfacoltativo——
tasks[].attemptsobject[]facoltativo——
tasks[].attempts[]objectfacoltativo——
tasks[].attempts[].idstringobbligatorio——
tasks[].attempts[].attempt_numberintegerobbligatorio——
tasks[].attempts[].statusstringobbligatorio——
tasks[].attempts[].worker_idanyOf<string | null>facoltativo——
tasks[].attempts[].worker_id · variant 1stringfacoltativo——
tasks[].attempts[].worker_id · variant 2nullfacoltativo——
tasks[].attempts[].runtime_classanyOf<string | null>facoltativo——
tasks[].attempts[].runtime_class · variant 1stringfacoltativo——
tasks[].attempts[].runtime_class · variant 2nullfacoltativo——
tasks[].attempts[].regionanyOf<string | null>facoltativo——
tasks[].attempts[].region · variant 1stringfacoltativo——
tasks[].attempts[].region · variant 2nullfacoltativo——
tasks[].attempts[].engineanyOf<string | null>facoltativo——
tasks[].attempts[].engine · variant 1stringfacoltativo——
tasks[].attempts[].engine · variant 2nullfacoltativo——
tasks[].attempts[].engine_versionanyOf<string | null>facoltativo——
tasks[].attempts[].engine_version · variant 1stringfacoltativo——
tasks[].attempts[].engine_version · variant 2nullfacoltativo——
tasks[].attempts[].input_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].input_bytes · variant 1integerfacoltativo——
tasks[].attempts[].input_bytes · variant 2nullfacoltativo——
tasks[].attempts[].output_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].output_bytes · variant 1integerfacoltativo——
tasks[].attempts[].output_bytes · variant 2nullfacoltativo——
tasks[].attempts[].wall_msanyOf<integer | null>facoltativo——
tasks[].attempts[].wall_ms · variant 1integerfacoltativo——
tasks[].attempts[].wall_ms · variant 2nullfacoltativo——
tasks[].attempts[].cpu_msanyOf<integer | null>facoltativo——
tasks[].attempts[].cpu_ms · variant 1integerfacoltativo——
tasks[].attempts[].cpu_ms · variant 2nullfacoltativo——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>facoltativo——
tasks[].attempts[].peak_memory_mb · variant 1integerfacoltativo——
tasks[].attempts[].peak_memory_mb · variant 2nullfacoltativo——
tasks[].attempts[].temp_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].temp_bytes · variant 1integerfacoltativo——
tasks[].attempts[].temp_bytes · variant 2nullfacoltativo——
tasks[].attempts[].error_codeanyOf<string | null>facoltativo——
tasks[].attempts[].error_code · variant 1stringfacoltativo——
tasks[].attempts[].error_code · variant 2nullfacoltativo——
tasks[].attempts[].error_messageanyOf<string | null>facoltativo——
tasks[].attempts[].error_message · variant 1stringfacoltativo——
tasks[].attempts[].error_message · variant 2nullfacoltativo——
tasks[].attempts[].estimated_creditsanyOf<string | null>facoltativo——
tasks[].attempts[].estimated_credits · variant 1stringfacoltativo——
tasks[].attempts[].estimated_credits · variant 2nullfacoltativo——
tasks[].attempts[].settled_creditsanyOf<string | null>facoltativo——
tasks[].attempts[].settled_credits · variant 1stringfacoltativo——
tasks[].attempts[].settled_credits · variant 2nullfacoltativo——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facoltativo——
tasks[].attempts[].external_side_effect_started_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullfacoltativo——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facoltativo——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacoltativo——
tasks[].attempts[].started_atstringobbligatorio—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>facoltativo——
tasks[].attempts[].completed_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].completed_at · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
tasksobjectobbligatorio——
taganyOf<string | null>facoltativo——
tag · variant 1stringfacoltativo—
max length: 255
tag · variant 2nullfacoltativo——
client_reference_idanyOf<string | null>facoltativo——
client_reference_id · variant 1stringfacoltativo—
max length: 255
client_reference_id · variant 2nullfacoltativo——
metadataobjectfacoltativo——
prioritystringfacoltativo—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>facoltativo——
retention_seconds · variant 1integerfacoltativo—
min: 0max: 86400
retention_seconds · variant 2nullfacoltativo——

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
validbooleanobbligatorio——
task_countintegerobbligatorio——
execution_orderstring[]obbligatorio——
root_tasksstring[]obbligatorio——
warningsstring[]facoltativo——
estimated_creditsanyOf<object | null>facoltativo——
estimated_credits · variant 1objectfacoltativo——
estimated_credits · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
limitqueryintegerfacoltativo
default: 50min: 1max: 200
afterqueryanyOf<string | null>facoltativo—
status_codequeryanyOf<integer | null>facoltativo—
path_prefixqueryanyOf<string | null>facoltativo—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
dataobject[]obbligatorio——
data[]objectfacoltativo——
data[].request_idstringobbligatorio——
data[].methodstringobbligatorio——
data[].pathstringobbligatorio——
data[].status_codeintegerobbligatorio——
data[].latency_msintegerobbligatorio——
data[].api_key_idanyOf<string | null>facoltativo——
data[].api_key_id · variant 1stringfacoltativo——
data[].api_key_id · variant 2nullfacoltativo——
data[].auth_typestringobbligatorio——
data[].user_agentanyOf<string | null>facoltativo——
data[].user_agent · variant 1stringfacoltativo——
data[].user_agent · variant 2nullfacoltativo——
data[].created_atstringobbligatorio——
paginationobjectobbligatorio——
pagination.nextanyOf<string | null>facoltativo——
pagination.next · variant 1stringfacoltativo——
pagination.next · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
request_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
request_idstringobbligatorio——
methodstringobbligatorio——
pathstringobbligatorio——
status_codeintegerobbligatorio——
latency_msintegerobbligatorio——
api_key_idanyOf<string | null>facoltativo——
api_key_id · variant 1stringfacoltativo——
api_key_id · variant 2nullfacoltativo——
auth_typestringobbligatorio——
user_agentanyOf<string | null>facoltativo——
user_agent · variant 1stringfacoltativo——
user_agent · variant 2nullfacoltativo——
created_atstringobbligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
account_idstringobbligatorio——
actor_idstringobbligatorio——
auth_typestringobbligatorio——
environmentstringobbligatorio——
access_tierstringfacoltativo—
enum: "sandbox", "paid"default: "paid"
scopesstring[]obbligatorio——
roleanyOf<string | null>facoltativo——
role · variant 1stringfacoltativo——
role · variant 2nullfacoltativo——
authorized_partyanyOf<string | null>facoltativo——
authorized_party · variant 1stringfacoltativo——
authorized_party · variant 2nullfacoltativo——
limitsanyOf<object | null>facoltativo——
limits · variant 1objectfacoltativo——
limits · variant 1.monthly_callsanyOf<integer | null>facoltativo——
limits · variant 1.monthly_calls · variant 1integerfacoltativo——
limits · variant 1.monthly_calls · variant 2nullfacoltativo——
limits · variant 1.rate_limit_per_minuteanyOf<integer | null>facoltativo——
limits · variant 1.rate_limit_per_minute · variant 1integerfacoltativo——
limits · variant 1.rate_limit_per_minute · variant 2nullfacoltativo——
limits · variant 1.daily_requestsanyOf<integer | null>facoltativo——
limits · variant 1.daily_requests · variant 1integerfacoltativo——
limits · variant 1.daily_requests · variant 2nullfacoltativo——
limits · variant 1.concurrencyanyOf<integer | null>facoltativo——
limits · variant 1.concurrency · variant 1integerfacoltativo——
limits · variant 1.concurrency · variant 2nullfacoltativo——
limits · variant 1.max_file_mbanyOf<integer | null>facoltativo——
limits · variant 1.max_file_mb · variant 1integerfacoltativo——
limits · variant 1.max_file_mb · variant 2nullfacoltativo——
limits · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
GET/v1/operationsOperationsDiscovery#

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

AutenticazionePubblico / nessuna autenticazione specifica dell’operazione

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
dataobject[]obbligatorio——
data[]objectfacoltativo——
data[].operationstringobbligatorio——
data[].categorystringobbligatorio—
enum: "import", "processing", "export"
data[].descriptionstringobbligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
account_idstringobbligatorio——
environmentstringobbligatorio——
scopedbooleanobbligatorio——
project_idanyOf<string | null>facoltativo——
project_id · variant 1stringfacoltativo——
project_id · variant 2nullfacoltativo——
project_nameanyOf<string | null>facoltativo——
project_name · variant 1stringfacoltativo——
project_name · variant 2nullfacoltativo——
project_sluganyOf<string | null>facoltativo——
project_slug · variant 1stringfacoltativo——
project_slug · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
GET/v1/project/legacy-migrationPreview Legacy MigrationAuthentication · Projects#

Preview account/environment resources still in the legacy namespace.

Autenticazione
ConverterHQBearerhttp / bearer

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
bodyobjectobbligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
POST/v1/project/legacy-migrationMigrate Legacy Project ResourcesAuthentication · Projects#

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

Autenticazione
ConverterHQBearerhttp / bearer

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
confirm_project_idstringobbligatorio—
min length: 1max length: 64

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
bodyobjectobbligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
tokenstringobbligatorio——
expires_atstringobbligatorio—
format: date-time
websocket_urlstringobbligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
bodyobjectobbligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
fixture_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
bodyobjectobbligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
bodyobject[]obbligatorio——
items[]objectfacoltativo——
items[].idstringobbligatorio——
items[].namestringobbligatorio——
items[].workflow_idanyOf<string | null>facoltativo——
items[].workflow_id · variant 1stringfacoltativo——
items[].workflow_id · variant 2nullfacoltativo——
items[].workflow_versionanyOf<integer | null>facoltativo——
items[].workflow_version · variant 1integerfacoltativo——
items[].workflow_version · variant 2nullfacoltativo——
items[].inline_definitionanyOf<object | null>facoltativo——
items[].inline_definition · variant 1objectfacoltativo——
items[].inline_definition · variant 2nullfacoltativo——
items[].variables_schemaobjectobbligatorio——
items[].allowed_source_hostsstring[]obbligatorio——
items[].max_file_size_bytesanyOf<integer | null>facoltativo——
items[].max_file_size_bytes · variant 1integerfacoltativo——
items[].max_file_size_bytes · variant 2nullfacoltativo——
items[].max_credits_per_requestanyOf<string | null>facoltativo——
items[].max_credits_per_request · variant 1stringfacoltativo——
items[].max_credits_per_request · variant 2nullfacoltativo——
items[].max_usesanyOf<integer | null>facoltativo——
items[].max_uses · variant 1integerfacoltativo——
items[].max_uses · variant 2nullfacoltativo——
items[].use_countintegerobbligatorio——
items[].cache_ttl_secondsintegerobbligatorio——
items[].enabledbooleanobbligatorio——
items[].created_atstringobbligatorio—
format: date-time
items[].updated_atstringobbligatorio—
format: date-time
items[].signing_secretanyOf<string | null>facoltativo——
items[].signing_secret · variant 1stringfacoltativo——
items[].signing_secret · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
namestringobbligatorio—
min length: 1max length: 255
workflow_idanyOf<string | null>facoltativo——
workflow_id · variant 1stringfacoltativo——
workflow_id · variant 2nullfacoltativo——
inline_definitionanyOf<object | null>facoltativo——
inline_definition · variant 1objectfacoltativo——
inline_definition · variant 1.tasksobjectobbligatorio——
inline_definition · variant 1.taganyOf<string | null>facoltativo——
inline_definition · variant 1.tag · variant 1stringfacoltativo—
max length: 255
inline_definition · variant 1.tag · variant 2nullfacoltativo——
inline_definition · variant 1.client_reference_idanyOf<string | null>facoltativo——
inline_definition · variant 1.client_reference_id · variant 1stringfacoltativo—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nullfacoltativo——
inline_definition · variant 1.metadataobjectfacoltativo——
inline_definition · variant 1.prioritystringfacoltativo—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>facoltativo——
inline_definition · variant 1.retention_seconds · variant 1integerfacoltativo—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nullfacoltativo——
inline_definition · variant 2nullfacoltativo——
variables_schemaobjectfacoltativo——
allowed_source_hostsstring[]facoltativo——
max_file_size_bytesanyOf<integer | null>facoltativo——
max_file_size_bytes · variant 1integerfacoltativo——
max_file_size_bytes · variant 2nullfacoltativo——
max_credits_per_requestanyOf<string | null>facoltativo——
max_credits_per_request · variant 1stringfacoltativo—
max length: 64
max_credits_per_request · variant 2nullfacoltativo——
max_usesanyOf<integer | null>facoltativo——
max_uses · variant 1integerfacoltativo——
max_uses · variant 2nullfacoltativo——
cache_ttl_secondsintegerfacoltativo—
default: 0min: 0max: 86400

Risposte

201Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
namestringobbligatorio——
workflow_idanyOf<string | null>facoltativo——
workflow_id · variant 1stringfacoltativo——
workflow_id · variant 2nullfacoltativo——
workflow_versionanyOf<integer | null>facoltativo——
workflow_version · variant 1integerfacoltativo——
workflow_version · variant 2nullfacoltativo——
inline_definitionanyOf<object | null>facoltativo——
inline_definition · variant 1objectfacoltativo——
inline_definition · variant 2nullfacoltativo——
variables_schemaobjectobbligatorio——
allowed_source_hostsstring[]obbligatorio——
max_file_size_bytesanyOf<integer | null>facoltativo——
max_file_size_bytes · variant 1integerfacoltativo——
max_file_size_bytes · variant 2nullfacoltativo——
max_credits_per_requestanyOf<string | null>facoltativo——
max_credits_per_request · variant 1stringfacoltativo——
max_credits_per_request · variant 2nullfacoltativo——
max_usesanyOf<integer | null>facoltativo——
max_uses · variant 1integerfacoltativo——
max_uses · variant 2nullfacoltativo——
use_countintegerobbligatorio——
cache_ttl_secondsintegerobbligatorio——
enabledbooleanobbligatorio——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
signing_secretanyOf<string | null>facoltativo——
signing_secret · variant 1stringfacoltativo——
signing_secret · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
base_idpathstringobbligatorio—

Risposte

204Successful Response

Nessun corpo della risposta.

400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
base_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
namestringobbligatorio——
workflow_idanyOf<string | null>facoltativo——
workflow_id · variant 1stringfacoltativo——
workflow_id · variant 2nullfacoltativo——
workflow_versionanyOf<integer | null>facoltativo——
workflow_version · variant 1integerfacoltativo——
workflow_version · variant 2nullfacoltativo——
inline_definitionanyOf<object | null>facoltativo——
inline_definition · variant 1objectfacoltativo——
inline_definition · variant 2nullfacoltativo——
variables_schemaobjectobbligatorio——
allowed_source_hostsstring[]obbligatorio——
max_file_size_bytesanyOf<integer | null>facoltativo——
max_file_size_bytes · variant 1integerfacoltativo——
max_file_size_bytes · variant 2nullfacoltativo——
max_credits_per_requestanyOf<string | null>facoltativo——
max_credits_per_request · variant 1stringfacoltativo——
max_credits_per_request · variant 2nullfacoltativo——
max_usesanyOf<integer | null>facoltativo——
max_uses · variant 1integerfacoltativo——
max_uses · variant 2nullfacoltativo——
use_countintegerobbligatorio——
cache_ttl_secondsintegerobbligatorio——
enabledbooleanobbligatorio——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
signing_secretanyOf<string | null>facoltativo——
signing_secret · variant 1stringfacoltativo——
signing_secret · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
base_idpathstringobbligatorio—

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
nameanyOf<string | null>facoltativo——
name · variant 1stringfacoltativo—
min length: 1max length: 255
name · variant 2nullfacoltativo——
workflow_idanyOf<string | null>facoltativo——
workflow_id · variant 1stringfacoltativo——
workflow_id · variant 2nullfacoltativo——
inline_definitionanyOf<object | null>facoltativo——
inline_definition · variant 1objectfacoltativo——
inline_definition · variant 1.tasksobjectobbligatorio——
inline_definition · variant 1.taganyOf<string | null>facoltativo——
inline_definition · variant 1.tag · variant 1stringfacoltativo—
max length: 255
inline_definition · variant 1.tag · variant 2nullfacoltativo——
inline_definition · variant 1.client_reference_idanyOf<string | null>facoltativo——
inline_definition · variant 1.client_reference_id · variant 1stringfacoltativo—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nullfacoltativo——
inline_definition · variant 1.metadataobjectfacoltativo——
inline_definition · variant 1.prioritystringfacoltativo—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>facoltativo——
inline_definition · variant 1.retention_seconds · variant 1integerfacoltativo—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nullfacoltativo——
inline_definition · variant 2nullfacoltativo——
variables_schemaanyOf<object | null>facoltativo——
variables_schema · variant 1objectfacoltativo——
variables_schema · variant 2nullfacoltativo——
allowed_source_hostsanyOf<string[] | null>facoltativo——
allowed_source_hosts · variant 1string[]facoltativo——
allowed_source_hosts · variant 2nullfacoltativo——
max_file_size_bytesanyOf<integer | null>facoltativo——
max_file_size_bytes · variant 1integerfacoltativo——
max_file_size_bytes · variant 2nullfacoltativo——
max_credits_per_requestanyOf<string | null>facoltativo——
max_credits_per_request · variant 1stringfacoltativo—
max length: 64
max_credits_per_request · variant 2nullfacoltativo——
max_usesanyOf<integer | null>facoltativo——
max_uses · variant 1integerfacoltativo——
max_uses · variant 2nullfacoltativo——
cache_ttl_secondsanyOf<integer | null>facoltativo——
cache_ttl_seconds · variant 1integerfacoltativo—
min: 0max: 86400
cache_ttl_seconds · variant 2nullfacoltativo——
enabledanyOf<boolean | null>facoltativo——
enabled · variant 1booleanfacoltativo——
enabled · variant 2nullfacoltativo——

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
namestringobbligatorio——
workflow_idanyOf<string | null>facoltativo——
workflow_id · variant 1stringfacoltativo——
workflow_id · variant 2nullfacoltativo——
workflow_versionanyOf<integer | null>facoltativo——
workflow_version · variant 1integerfacoltativo——
workflow_version · variant 2nullfacoltativo——
inline_definitionanyOf<object | null>facoltativo——
inline_definition · variant 1objectfacoltativo——
inline_definition · variant 2nullfacoltativo——
variables_schemaobjectobbligatorio——
allowed_source_hostsstring[]obbligatorio——
max_file_size_bytesanyOf<integer | null>facoltativo——
max_file_size_bytes · variant 1integerfacoltativo——
max_file_size_bytes · variant 2nullfacoltativo——
max_credits_per_requestanyOf<string | null>facoltativo——
max_credits_per_request · variant 1stringfacoltativo——
max_credits_per_request · variant 2nullfacoltativo——
max_usesanyOf<integer | null>facoltativo——
max_uses · variant 1integerfacoltativo——
max_uses · variant 2nullfacoltativo——
use_countintegerobbligatorio——
cache_ttl_secondsintegerobbligatorio——
enabledbooleanobbligatorio——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
signing_secretanyOf<string | null>facoltativo——
signing_secret · variant 1stringfacoltativo——
signing_secret · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
base_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
namestringobbligatorio——
workflow_idanyOf<string | null>facoltativo——
workflow_id · variant 1stringfacoltativo——
workflow_id · variant 2nullfacoltativo——
workflow_versionanyOf<integer | null>facoltativo——
workflow_version · variant 1integerfacoltativo——
workflow_version · variant 2nullfacoltativo——
inline_definitionanyOf<object | null>facoltativo——
inline_definition · variant 1objectfacoltativo——
inline_definition · variant 2nullfacoltativo——
variables_schemaobjectobbligatorio——
allowed_source_hostsstring[]obbligatorio——
max_file_size_bytesanyOf<integer | null>facoltativo——
max_file_size_bytes · variant 1integerfacoltativo——
max_file_size_bytes · variant 2nullfacoltativo——
max_credits_per_requestanyOf<string | null>facoltativo——
max_credits_per_request · variant 1stringfacoltativo——
max_credits_per_request · variant 2nullfacoltativo——
max_usesanyOf<integer | null>facoltativo——
max_uses · variant 1integerfacoltativo——
max_uses · variant 2nullfacoltativo——
use_countintegerobbligatorio——
cache_ttl_secondsintegerobbligatorio——
enabledbooleanobbligatorio——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
signing_secretanyOf<string | null>facoltativo——
signing_secret · variant 1stringfacoltativo——
signing_secret · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
base_idpathstringobbligatorio—

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
variablesobjectfacoltativo——
expires_inintegerfacoltativo—
default: 3600min: 60max: 86400
cache_keyanyOf<string | null>facoltativo——
cache_key · variant 1stringfacoltativo—
max length: 255
cache_key · variant 2nullfacoltativo——

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
urlstringobbligatorio——
expires_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

AutenticazionePubblico / nessuna autenticazione specifica dell’operazione

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
statusstringobbligatorio—
enum: "ok", "degraded"
servicestringfacoltativo—
default: "converterhq-api"
api_versionstringfacoltativo—
default: "v1"
timestampstringobbligatorio—
format: date-time
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

AutenticazionePubblico / nessuna autenticazione specifica dell’operazione

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
successful_conversionsintegerobbligatorio——
input_bytes_processedintegerobbligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
task_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
job_idstringobbligatorio——
namestringobbligatorio——
operationstringobbligatorio——
statusstringobbligatorio——
progressintegerobbligatorio——
inputobjectobbligatorio——
optionsobjectobbligatorio——
resultobjectobbligatorio——
requiredbooleanobbligatorio——
runtime_classstringobbligatorio——
prioritystringobbligatorio——
attempt_countintegerobbligatorio——
max_attemptsintegerobbligatorio——
error_codeanyOf<string | null>facoltativo——
error_code · variant 1stringfacoltativo——
error_code · variant 2nullfacoltativo——
error_messageanyOf<string | null>facoltativo——
error_message · variant 1stringfacoltativo——
error_message · variant 2nullfacoltativo——
created_atstringobbligatorio—
format: date-time
queued_atanyOf<string | null>facoltativo——
queued_at · variant 1stringfacoltativo—
format: date-time
queued_at · variant 2nullfacoltativo——
started_atanyOf<string | null>facoltativo——
started_at · variant 1stringfacoltativo—
format: date-time
started_at · variant 2nullfacoltativo——
completed_atanyOf<string | null>facoltativo——
completed_at · variant 1stringfacoltativo—
format: date-time
completed_at · variant 2nullfacoltativo——
attemptsobject[]facoltativo——
attempts[]objectfacoltativo——
attempts[].idstringobbligatorio——
attempts[].attempt_numberintegerobbligatorio——
attempts[].statusstringobbligatorio——
attempts[].worker_idanyOf<string | null>facoltativo——
attempts[].worker_id · variant 1stringfacoltativo——
attempts[].worker_id · variant 2nullfacoltativo——
attempts[].runtime_classanyOf<string | null>facoltativo——
attempts[].runtime_class · variant 1stringfacoltativo——
attempts[].runtime_class · variant 2nullfacoltativo——
attempts[].regionanyOf<string | null>facoltativo——
attempts[].region · variant 1stringfacoltativo——
attempts[].region · variant 2nullfacoltativo——
attempts[].engineanyOf<string | null>facoltativo——
attempts[].engine · variant 1stringfacoltativo——
attempts[].engine · variant 2nullfacoltativo——
attempts[].engine_versionanyOf<string | null>facoltativo——
attempts[].engine_version · variant 1stringfacoltativo——
attempts[].engine_version · variant 2nullfacoltativo——
attempts[].input_bytesanyOf<integer | null>facoltativo——
attempts[].input_bytes · variant 1integerfacoltativo——
attempts[].input_bytes · variant 2nullfacoltativo——
attempts[].output_bytesanyOf<integer | null>facoltativo——
attempts[].output_bytes · variant 1integerfacoltativo——
attempts[].output_bytes · variant 2nullfacoltativo——
attempts[].wall_msanyOf<integer | null>facoltativo——
attempts[].wall_ms · variant 1integerfacoltativo——
attempts[].wall_ms · variant 2nullfacoltativo——
attempts[].cpu_msanyOf<integer | null>facoltativo——
attempts[].cpu_ms · variant 1integerfacoltativo——
attempts[].cpu_ms · variant 2nullfacoltativo——
attempts[].peak_memory_mbanyOf<integer | null>facoltativo——
attempts[].peak_memory_mb · variant 1integerfacoltativo——
attempts[].peak_memory_mb · variant 2nullfacoltativo——
attempts[].temp_bytesanyOf<integer | null>facoltativo——
attempts[].temp_bytes · variant 1integerfacoltativo——
attempts[].temp_bytes · variant 2nullfacoltativo——
attempts[].error_codeanyOf<string | null>facoltativo——
attempts[].error_code · variant 1stringfacoltativo——
attempts[].error_code · variant 2nullfacoltativo——
attempts[].error_messageanyOf<string | null>facoltativo——
attempts[].error_message · variant 1stringfacoltativo——
attempts[].error_message · variant 2nullfacoltativo——
attempts[].estimated_creditsanyOf<string | null>facoltativo——
attempts[].estimated_credits · variant 1stringfacoltativo——
attempts[].estimated_credits · variant 2nullfacoltativo——
attempts[].settled_creditsanyOf<string | null>facoltativo——
attempts[].settled_credits · variant 1stringfacoltativo——
attempts[].settled_credits · variant 2nullfacoltativo——
attempts[].external_side_effect_started_atanyOf<string | null>facoltativo——
attempts[].external_side_effect_started_at · variant 1stringfacoltativo—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullfacoltativo——
attempts[].external_side_effect_committed_atanyOf<string | null>facoltativo——
attempts[].external_side_effect_committed_at · variant 1stringfacoltativo—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullfacoltativo——
attempts[].started_atstringobbligatorio—
format: date-time
attempts[].completed_atanyOf<string | null>facoltativo——
attempts[].completed_at · variant 1stringfacoltativo—
format: date-time
attempts[].completed_at · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
task_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
job_idstringobbligatorio——
namestringobbligatorio——
operationstringobbligatorio——
statusstringobbligatorio——
progressintegerobbligatorio——
inputobjectobbligatorio——
optionsobjectobbligatorio——
resultobjectobbligatorio——
requiredbooleanobbligatorio——
runtime_classstringobbligatorio——
prioritystringobbligatorio——
attempt_countintegerobbligatorio——
max_attemptsintegerobbligatorio——
error_codeanyOf<string | null>facoltativo——
error_code · variant 1stringfacoltativo——
error_code · variant 2nullfacoltativo——
error_messageanyOf<string | null>facoltativo——
error_message · variant 1stringfacoltativo——
error_message · variant 2nullfacoltativo——
created_atstringobbligatorio—
format: date-time
queued_atanyOf<string | null>facoltativo——
queued_at · variant 1stringfacoltativo—
format: date-time
queued_at · variant 2nullfacoltativo——
started_atanyOf<string | null>facoltativo——
started_at · variant 1stringfacoltativo—
format: date-time
started_at · variant 2nullfacoltativo——
completed_atanyOf<string | null>facoltativo——
completed_at · variant 1stringfacoltativo—
format: date-time
completed_at · variant 2nullfacoltativo——
attemptsobject[]facoltativo——
attempts[]objectfacoltativo——
attempts[].idstringobbligatorio——
attempts[].attempt_numberintegerobbligatorio——
attempts[].statusstringobbligatorio——
attempts[].worker_idanyOf<string | null>facoltativo——
attempts[].worker_id · variant 1stringfacoltativo——
attempts[].worker_id · variant 2nullfacoltativo——
attempts[].runtime_classanyOf<string | null>facoltativo——
attempts[].runtime_class · variant 1stringfacoltativo——
attempts[].runtime_class · variant 2nullfacoltativo——
attempts[].regionanyOf<string | null>facoltativo——
attempts[].region · variant 1stringfacoltativo——
attempts[].region · variant 2nullfacoltativo——
attempts[].engineanyOf<string | null>facoltativo——
attempts[].engine · variant 1stringfacoltativo——
attempts[].engine · variant 2nullfacoltativo——
attempts[].engine_versionanyOf<string | null>facoltativo——
attempts[].engine_version · variant 1stringfacoltativo——
attempts[].engine_version · variant 2nullfacoltativo——
attempts[].input_bytesanyOf<integer | null>facoltativo——
attempts[].input_bytes · variant 1integerfacoltativo——
attempts[].input_bytes · variant 2nullfacoltativo——
attempts[].output_bytesanyOf<integer | null>facoltativo——
attempts[].output_bytes · variant 1integerfacoltativo——
attempts[].output_bytes · variant 2nullfacoltativo——
attempts[].wall_msanyOf<integer | null>facoltativo——
attempts[].wall_ms · variant 1integerfacoltativo——
attempts[].wall_ms · variant 2nullfacoltativo——
attempts[].cpu_msanyOf<integer | null>facoltativo——
attempts[].cpu_ms · variant 1integerfacoltativo——
attempts[].cpu_ms · variant 2nullfacoltativo——
attempts[].peak_memory_mbanyOf<integer | null>facoltativo——
attempts[].peak_memory_mb · variant 1integerfacoltativo——
attempts[].peak_memory_mb · variant 2nullfacoltativo——
attempts[].temp_bytesanyOf<integer | null>facoltativo——
attempts[].temp_bytes · variant 1integerfacoltativo——
attempts[].temp_bytes · variant 2nullfacoltativo——
attempts[].error_codeanyOf<string | null>facoltativo——
attempts[].error_code · variant 1stringfacoltativo——
attempts[].error_code · variant 2nullfacoltativo——
attempts[].error_messageanyOf<string | null>facoltativo——
attempts[].error_message · variant 1stringfacoltativo——
attempts[].error_message · variant 2nullfacoltativo——
attempts[].estimated_creditsanyOf<string | null>facoltativo——
attempts[].estimated_credits · variant 1stringfacoltativo——
attempts[].estimated_credits · variant 2nullfacoltativo——
attempts[].settled_creditsanyOf<string | null>facoltativo——
attempts[].settled_credits · variant 1stringfacoltativo——
attempts[].settled_credits · variant 2nullfacoltativo——
attempts[].external_side_effect_started_atanyOf<string | null>facoltativo——
attempts[].external_side_effect_started_at · variant 1stringfacoltativo—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullfacoltativo——
attempts[].external_side_effect_committed_atanyOf<string | null>facoltativo——
attempts[].external_side_effect_committed_at · variant 1stringfacoltativo—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullfacoltativo——
attempts[].started_atstringobbligatorio—
format: date-time
attempts[].completed_atanyOf<string | null>facoltativo——
attempts[].completed_at · variant 1stringfacoltativo—
format: date-time
attempts[].completed_at · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
task_idpathstringobbligatorio—
timeoutqueryintegerfacoltativo
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>facoltativo—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
bodyunknownobbligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
task_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
job_idstringobbligatorio——
namestringobbligatorio——
operationstringobbligatorio——
statusstringobbligatorio——
progressintegerobbligatorio——
inputobjectobbligatorio——
optionsobjectobbligatorio——
resultobjectobbligatorio——
requiredbooleanobbligatorio——
runtime_classstringobbligatorio——
prioritystringobbligatorio——
attempt_countintegerobbligatorio——
max_attemptsintegerobbligatorio——
error_codeanyOf<string | null>facoltativo——
error_code · variant 1stringfacoltativo——
error_code · variant 2nullfacoltativo——
error_messageanyOf<string | null>facoltativo——
error_message · variant 1stringfacoltativo——
error_message · variant 2nullfacoltativo——
created_atstringobbligatorio—
format: date-time
queued_atanyOf<string | null>facoltativo——
queued_at · variant 1stringfacoltativo—
format: date-time
queued_at · variant 2nullfacoltativo——
started_atanyOf<string | null>facoltativo——
started_at · variant 1stringfacoltativo—
format: date-time
started_at · variant 2nullfacoltativo——
completed_atanyOf<string | null>facoltativo——
completed_at · variant 1stringfacoltativo—
format: date-time
completed_at · variant 2nullfacoltativo——
attemptsobject[]facoltativo——
attempts[]objectfacoltativo——
attempts[].idstringobbligatorio——
attempts[].attempt_numberintegerobbligatorio——
attempts[].statusstringobbligatorio——
attempts[].worker_idanyOf<string | null>facoltativo——
attempts[].worker_id · variant 1stringfacoltativo——
attempts[].worker_id · variant 2nullfacoltativo——
attempts[].runtime_classanyOf<string | null>facoltativo——
attempts[].runtime_class · variant 1stringfacoltativo——
attempts[].runtime_class · variant 2nullfacoltativo——
attempts[].regionanyOf<string | null>facoltativo——
attempts[].region · variant 1stringfacoltativo——
attempts[].region · variant 2nullfacoltativo——
attempts[].engineanyOf<string | null>facoltativo——
attempts[].engine · variant 1stringfacoltativo——
attempts[].engine · variant 2nullfacoltativo——
attempts[].engine_versionanyOf<string | null>facoltativo——
attempts[].engine_version · variant 1stringfacoltativo——
attempts[].engine_version · variant 2nullfacoltativo——
attempts[].input_bytesanyOf<integer | null>facoltativo——
attempts[].input_bytes · variant 1integerfacoltativo——
attempts[].input_bytes · variant 2nullfacoltativo——
attempts[].output_bytesanyOf<integer | null>facoltativo——
attempts[].output_bytes · variant 1integerfacoltativo——
attempts[].output_bytes · variant 2nullfacoltativo——
attempts[].wall_msanyOf<integer | null>facoltativo——
attempts[].wall_ms · variant 1integerfacoltativo——
attempts[].wall_ms · variant 2nullfacoltativo——
attempts[].cpu_msanyOf<integer | null>facoltativo——
attempts[].cpu_ms · variant 1integerfacoltativo——
attempts[].cpu_ms · variant 2nullfacoltativo——
attempts[].peak_memory_mbanyOf<integer | null>facoltativo——
attempts[].peak_memory_mb · variant 1integerfacoltativo——
attempts[].peak_memory_mb · variant 2nullfacoltativo——
attempts[].temp_bytesanyOf<integer | null>facoltativo——
attempts[].temp_bytes · variant 1integerfacoltativo——
attempts[].temp_bytes · variant 2nullfacoltativo——
attempts[].error_codeanyOf<string | null>facoltativo——
attempts[].error_code · variant 1stringfacoltativo——
attempts[].error_code · variant 2nullfacoltativo——
attempts[].error_messageanyOf<string | null>facoltativo——
attempts[].error_message · variant 1stringfacoltativo——
attempts[].error_message · variant 2nullfacoltativo——
attempts[].estimated_creditsanyOf<string | null>facoltativo——
attempts[].estimated_credits · variant 1stringfacoltativo——
attempts[].estimated_credits · variant 2nullfacoltativo——
attempts[].settled_creditsanyOf<string | null>facoltativo——
attempts[].settled_credits · variant 1stringfacoltativo——
attempts[].settled_credits · variant 2nullfacoltativo——
attempts[].external_side_effect_started_atanyOf<string | null>facoltativo——
attempts[].external_side_effect_started_at · variant 1stringfacoltativo—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullfacoltativo——
attempts[].external_side_effect_committed_atanyOf<string | null>facoltativo——
attempts[].external_side_effect_committed_at · variant 1stringfacoltativo—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullfacoltativo——
attempts[].started_atstringobbligatorio—
format: date-time
attempts[].completed_atanyOf<string | null>facoltativo——
attempts[].completed_at · variant 1stringfacoltativo—
format: date-time
attempts[].completed_at · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
limitqueryintegerfacoltativo
default: 50min: 1max: 200
afterqueryanyOf<string | null>facoltativo—
input_formatqueryanyOf<string | null>facoltativo—
output_formatqueryanyOf<string | null>facoltativo—
originqueryanyOf<string | null>facoltativo—
outcomequeryanyOf<string | null>facoltativo—
job_idqueryanyOf<string | null>facoltativo—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
dataobject[]obbligatorio——
data[]objectfacoltativo——
data[].idstringobbligatorio——
data[].api_key_idanyOf<string | null>facoltativo——
data[].api_key_id · variant 1stringfacoltativo——
data[].api_key_id · variant 2nullfacoltativo——
data[].originstringobbligatorio——
data[].outcomestringfacoltativo—
default: "succeeded"
data[].job_idanyOf<string | null>facoltativo——
data[].job_id · variant 1stringfacoltativo——
data[].job_id · variant 2nullfacoltativo——
data[].task_idanyOf<string | null>facoltativo——
data[].task_id · variant 1stringfacoltativo——
data[].task_id · variant 2nullfacoltativo——
data[].input_formatanyOf<string | null>facoltativo——
data[].input_format · variant 1stringfacoltativo——
data[].input_format · variant 2nullfacoltativo——
data[].output_formatanyOf<string | null>facoltativo——
data[].output_format · variant 1stringfacoltativo——
data[].output_format · variant 2nullfacoltativo——
data[].engineanyOf<string | null>facoltativo——
data[].engine · variant 1stringfacoltativo——
data[].engine · variant 2nullfacoltativo——
data[].engine_versionanyOf<string | null>facoltativo——
data[].engine_version · variant 1stringfacoltativo——
data[].engine_version · variant 2nullfacoltativo——
data[].runtime_classanyOf<string | null>facoltativo——
data[].runtime_class · variant 1stringfacoltativo——
data[].runtime_class · variant 2nullfacoltativo——
data[].input_bytesanyOf<integer | null>facoltativo——
data[].input_bytes · variant 1integerfacoltativo——
data[].input_bytes · variant 2nullfacoltativo——
data[].output_bytesanyOf<integer | null>facoltativo——
data[].output_bytes · variant 1integerfacoltativo——
data[].output_bytes · variant 2nullfacoltativo——
data[].wall_msanyOf<integer | null>facoltativo——
data[].wall_ms · variant 1integerfacoltativo——
data[].wall_ms · variant 2nullfacoltativo——
data[].creditsanyOf<string | null>facoltativo——
data[].credits · variant 1stringfacoltativo——
data[].credits · variant 2nullfacoltativo——
data[].created_atstringobbligatorio—
format: date-time
paginationobjectobbligatorio——
pagination.nextanyOf<string | null>facoltativo——
pagination.next · variant 1stringfacoltativo——
pagination.next · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
startqueryanyOf<string | null>facoltativo—
endqueryanyOf<string | null>facoltativo—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
startstringobbligatorio—
format: date-time
endstringobbligatorio—
format: date-time
conversionsintegerobbligatorio——
creditsstringobbligatorio——
input_bytesintegerobbligatorio——
output_bytesintegerobbligatorio——
wall_msintegerobbligatorio——
by_originobject[]facoltativo——
by_origin[]objectfacoltativo——
by_origin[].keystringobbligatorio——
by_origin[].conversionsintegerobbligatorio——
by_origin[].creditsstringobbligatorio——
top_pairsobject[]facoltativo——
top_pairs[]objectfacoltativo——
top_pairs[].keystringobbligatorio——
top_pairs[].conversionsintegerobbligatorio——
top_pairs[].creditsstringobbligatorio——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
delivery_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
webhook_idstringobbligatorio——
event_idstringobbligatorio——
statusstringobbligatorio——
attemptintegerobbligatorio——
request_headersobjectobbligatorio——
request_bodyobjectobbligatorio——
response_statusanyOf<integer | null>facoltativo——
response_status · variant 1integerfacoltativo——
response_status · variant 2nullfacoltativo——
response_bodyanyOf<string | null>facoltativo——
response_body · variant 1stringfacoltativo——
response_body · variant 2nullfacoltativo——
latency_msanyOf<integer | null>facoltativo——
latency_ms · variant 1integerfacoltativo——
latency_ms · variant 2nullfacoltativo——
error_messageanyOf<string | null>facoltativo——
error_message · variant 1stringfacoltativo——
error_message · variant 2nullfacoltativo——
next_retry_atanyOf<string | null>facoltativo——
next_retry_at · variant 1stringfacoltativo—
format: date-time
next_retry_at · variant 2nullfacoltativo——
delivered_atanyOf<string | null>facoltativo——
delivered_at · variant 1stringfacoltativo—
format: date-time
delivered_at · variant 2nullfacoltativo——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
delivery_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
webhook_idstringobbligatorio——
event_idstringobbligatorio——
statusstringobbligatorio——
attemptintegerobbligatorio——
request_headersobjectobbligatorio——
request_bodyobjectobbligatorio——
response_statusanyOf<integer | null>facoltativo——
response_status · variant 1integerfacoltativo——
response_status · variant 2nullfacoltativo——
response_bodyanyOf<string | null>facoltativo——
response_body · variant 1stringfacoltativo——
response_body · variant 2nullfacoltativo——
latency_msanyOf<integer | null>facoltativo——
latency_ms · variant 1integerfacoltativo——
latency_ms · variant 2nullfacoltativo——
error_messageanyOf<string | null>facoltativo——
error_message · variant 1stringfacoltativo——
error_message · variant 2nullfacoltativo——
next_retry_atanyOf<string | null>facoltativo——
next_retry_at · variant 1stringfacoltativo—
format: date-time
next_retry_at · variant 2nullfacoltativo——
delivered_atanyOf<string | null>facoltativo——
delivered_at · variant 1stringfacoltativo—
format: date-time
delivered_at · variant 2nullfacoltativo——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
bodyobject[]obbligatorio——
items[]objectfacoltativo——
items[].idstringobbligatorio——
items[].urlstringobbligatorio——
items[].descriptionanyOf<string | null>facoltativo——
items[].description · variant 1stringfacoltativo——
items[].description · variant 2nullfacoltativo——
items[].event_typesstring[]obbligatorio——
items[].enabledbooleanobbligatorio——
items[].failure_countintegerobbligatorio——
items[].created_atstringobbligatorio—
format: date-time
items[].updated_atstringobbligatorio—
format: date-time
items[].signing_secretanyOf<string | null>facoltativo——
items[].signing_secret · variant 1stringfacoltativo——
items[].signing_secret · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
urlstringobbligatorio—
min length: 1max length: 2048
descriptionanyOf<string | null>facoltativo——
description · variant 1stringfacoltativo—
max length: 512
description · variant 2nullfacoltativo——
event_typesstring[]facoltativo——

Risposte

201Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
urlstringobbligatorio——
descriptionanyOf<string | null>facoltativo——
description · variant 1stringfacoltativo——
description · variant 2nullfacoltativo——
event_typesstring[]obbligatorio——
enabledbooleanobbligatorio——
failure_countintegerobbligatorio——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
signing_secretanyOf<string | null>facoltativo——
signing_secret · variant 1stringfacoltativo——
signing_secret · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
webhook_idpathstringobbligatorio—

Risposte

204Successful Response

Nessun corpo della risposta.

400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
webhook_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
urlstringobbligatorio——
descriptionanyOf<string | null>facoltativo——
description · variant 1stringfacoltativo——
description · variant 2nullfacoltativo——
event_typesstring[]obbligatorio——
enabledbooleanobbligatorio——
failure_countintegerobbligatorio——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
signing_secretanyOf<string | null>facoltativo——
signing_secret · variant 1stringfacoltativo——
signing_secret · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
webhook_idpathstringobbligatorio—

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
urlanyOf<string | null>facoltativo——
url · variant 1stringfacoltativo—
min length: 1max length: 2048
url · variant 2nullfacoltativo——
descriptionanyOf<string | null>facoltativo——
description · variant 1stringfacoltativo—
max length: 512
description · variant 2nullfacoltativo——
event_typesanyOf<string[] | null>facoltativo——
event_types · variant 1string[]facoltativo——
event_types · variant 2nullfacoltativo——
enabledanyOf<boolean | null>facoltativo——
enabled · variant 1booleanfacoltativo——
enabled · variant 2nullfacoltativo——

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
urlstringobbligatorio——
descriptionanyOf<string | null>facoltativo——
description · variant 1stringfacoltativo——
description · variant 2nullfacoltativo——
event_typesstring[]obbligatorio——
enabledbooleanobbligatorio——
failure_countintegerobbligatorio——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
signing_secretanyOf<string | null>facoltativo——
signing_secret · variant 1stringfacoltativo——
signing_secret · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
webhook_idpathstringobbligatorio—
limitqueryintegerfacoltativo
default: 50min: 1max: 100
afterqueryanyOf<string | null>facoltativo—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
dataobject[]obbligatorio——
data[]objectfacoltativo——
data[].idstringobbligatorio——
data[].webhook_idstringobbligatorio——
data[].event_idstringobbligatorio——
data[].statusstringobbligatorio——
data[].attemptintegerobbligatorio——
data[].request_headersobjectobbligatorio——
data[].request_bodyobjectobbligatorio——
data[].response_statusanyOf<integer | null>facoltativo——
data[].response_status · variant 1integerfacoltativo——
data[].response_status · variant 2nullfacoltativo——
data[].response_bodyanyOf<string | null>facoltativo——
data[].response_body · variant 1stringfacoltativo——
data[].response_body · variant 2nullfacoltativo——
data[].latency_msanyOf<integer | null>facoltativo——
data[].latency_ms · variant 1integerfacoltativo——
data[].latency_ms · variant 2nullfacoltativo——
data[].error_messageanyOf<string | null>facoltativo——
data[].error_message · variant 1stringfacoltativo——
data[].error_message · variant 2nullfacoltativo——
data[].next_retry_atanyOf<string | null>facoltativo——
data[].next_retry_at · variant 1stringfacoltativo—
format: date-time
data[].next_retry_at · variant 2nullfacoltativo——
data[].delivered_atanyOf<string | null>facoltativo——
data[].delivered_at · variant 1stringfacoltativo—
format: date-time
data[].delivered_at · variant 2nullfacoltativo——
data[].created_atstringobbligatorio—
format: date-time
data[].updated_atstringobbligatorio—
format: date-time
paginationobjectobbligatorio——
pagination.nextanyOf<string | null>facoltativo——
pagination.next · variant 1stringfacoltativo——
pagination.next · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
webhook_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
signing_secretstringobbligatorio——
previous_secret_valid_untilanyOf<string | null>facoltativo——
previous_secret_valid_until · variant 1stringfacoltativo—
format: date-time
previous_secret_valid_until · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
limitqueryintegerfacoltativo
default: 50min: 1max: 200
afterqueryanyOf<string | null>facoltativo—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
dataobject[]obbligatorio——
data[]objectfacoltativo——
data[].idstringobbligatorio——
data[].namestringobbligatorio——
data[].descriptionanyOf<string | null>facoltativo——
data[].description · variant 1stringfacoltativo——
data[].description · variant 2nullfacoltativo——
data[].current_versionintegerobbligatorio——
data[].definitionobjectobbligatorio——
data[].variables_schemaobjectobbligatorio——
data[].metadataobjectobbligatorio——
data[].created_atstringobbligatorio—
format: date-time
data[].updated_atstringobbligatorio—
format: date-time
paginationobjectobbligatorio——
pagination.nextanyOf<string | null>facoltativo——
pagination.next · variant 1stringfacoltativo——
pagination.next · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
namestringobbligatorio—
min length: 1max length: 255
descriptionanyOf<string | null>facoltativo——
description · variant 1stringfacoltativo—
max length: 2000
description · variant 2nullfacoltativo——
definitionobjectobbligatorio——
definition.tasksobjectobbligatorio——
definition.taganyOf<string | null>facoltativo——
definition.tag · variant 1stringfacoltativo—
max length: 255
definition.tag · variant 2nullfacoltativo——
definition.client_reference_idanyOf<string | null>facoltativo——
definition.client_reference_id · variant 1stringfacoltativo—
max length: 255
definition.client_reference_id · variant 2nullfacoltativo——
definition.metadataobjectfacoltativo——
definition.prioritystringfacoltativo—
enum: "low", "normal", "high"default: "normal"
definition.retention_secondsanyOf<integer | null>facoltativo——
definition.retention_seconds · variant 1integerfacoltativo—
min: 0max: 86400
definition.retention_seconds · variant 2nullfacoltativo——
variables_schemaobjectfacoltativo——
metadataobjectfacoltativo——

Risposte

201Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
namestringobbligatorio——
descriptionanyOf<string | null>facoltativo——
description · variant 1stringfacoltativo——
description · variant 2nullfacoltativo——
current_versionintegerobbligatorio——
definitionobjectobbligatorio——
variables_schemaobjectobbligatorio——
metadataobjectobbligatorio——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
workflow_idpathstringobbligatorio—

Risposte

204Successful Response

Nessun corpo della risposta.

400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
workflow_idpathstringobbligatorio—

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
namestringobbligatorio——
descriptionanyOf<string | null>facoltativo——
description · variant 1stringfacoltativo——
description · variant 2nullfacoltativo——
current_versionintegerobbligatorio——
definitionobjectobbligatorio——
variables_schemaobjectobbligatorio——
metadataobjectobbligatorio——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
workflow_idpathstringobbligatorio—

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
nameanyOf<string | null>facoltativo——
name · variant 1stringfacoltativo—
min length: 1max length: 255
name · variant 2nullfacoltativo——
descriptionanyOf<string | null>facoltativo——
description · variant 1stringfacoltativo—
max length: 2000
description · variant 2nullfacoltativo——
definitionanyOf<object | null>facoltativo——
definition · variant 1objectfacoltativo——
definition · variant 1.tasksobjectobbligatorio——
definition · variant 1.taganyOf<string | null>facoltativo——
definition · variant 1.tag · variant 1stringfacoltativo—
max length: 255
definition · variant 1.tag · variant 2nullfacoltativo——
definition · variant 1.client_reference_idanyOf<string | null>facoltativo——
definition · variant 1.client_reference_id · variant 1stringfacoltativo—
max length: 255
definition · variant 1.client_reference_id · variant 2nullfacoltativo——
definition · variant 1.metadataobjectfacoltativo——
definition · variant 1.prioritystringfacoltativo—
enum: "low", "normal", "high"default: "normal"
definition · variant 1.retention_secondsanyOf<integer | null>facoltativo——
definition · variant 1.retention_seconds · variant 1integerfacoltativo—
min: 0max: 86400
definition · variant 1.retention_seconds · variant 2nullfacoltativo——
definition · variant 2nullfacoltativo——
variables_schemaanyOf<object | null>facoltativo——
variables_schema · variant 1objectfacoltativo——
variables_schema · variant 2nullfacoltativo——
metadataanyOf<object | null>facoltativo——
metadata · variant 1objectfacoltativo——
metadata · variant 2nullfacoltativo——

Risposte

200Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
namestringobbligatorio——
descriptionanyOf<string | null>facoltativo——
description · variant 1stringfacoltativo——
description · variant 2nullfacoltativo——
current_versionintegerobbligatorio——
definitionobjectobbligatorio——
variables_schemaobjectobbligatorio——
metadataobjectobbligatorio——
created_atstringobbligatorio—
format: date-time
updated_atstringobbligatorio—
format: date-time
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
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.

Autenticazione
ConverterHQBearerhttp / bearer

Parametri

NomePosizioneTipoObbligatorioDescrizione / vincoli
workflow_idpathstringobbligatorio—
Idempotency-KeyheaderanyOf<string | null>facoltativo—

Corpo della richiesta obbligatorio

application/json
CampoTipoObbligatorioDescrizioneVincoli
variablesobjectfacoltativo——
client_reference_idanyOf<string | null>facoltativo——
client_reference_id · variant 1stringfacoltativo—
max length: 255
client_reference_id · variant 2nullfacoltativo——
metadataobjectfacoltativo——

Risposte

201Successful Response
application/json
CampoTipoObbligatorioDescrizioneVincoli
idstringobbligatorio——
kindstringobbligatorio——
statusstringobbligatorio——
progressintegerobbligatorio——
taganyOf<string | null>facoltativo——
tag · variant 1stringfacoltativo——
tag · variant 2nullfacoltativo——
client_reference_idanyOf<string | null>facoltativo——
client_reference_id · variant 1stringfacoltativo——
client_reference_id · variant 2nullfacoltativo——
metadataobjectfacoltativo——
prioritystringobbligatorio——
concurrency_limitintegerfacoltativo—
default: 1
originstringobbligatorio——
created_atstringobbligatorio—
format: date-time
started_atanyOf<string | null>facoltativo——
started_at · variant 1stringfacoltativo—
format: date-time
started_at · variant 2nullfacoltativo——
completed_atanyOf<string | null>facoltativo——
completed_at · variant 1stringfacoltativo—
format: date-time
completed_at · variant 2nullfacoltativo——
error_codeanyOf<string | null>facoltativo——
error_code · variant 1stringfacoltativo——
error_code · variant 2nullfacoltativo——
error_messageanyOf<string | null>facoltativo——
error_message · variant 1stringfacoltativo——
error_message · variant 2nullfacoltativo——
tasksobject[]facoltativo——
tasks[]objectfacoltativo——
tasks[].idstringobbligatorio——
tasks[].job_idstringobbligatorio——
tasks[].namestringobbligatorio——
tasks[].operationstringobbligatorio——
tasks[].statusstringobbligatorio——
tasks[].progressintegerobbligatorio——
tasks[].inputobjectobbligatorio——
tasks[].optionsobjectobbligatorio——
tasks[].resultobjectobbligatorio——
tasks[].requiredbooleanobbligatorio——
tasks[].runtime_classstringobbligatorio——
tasks[].prioritystringobbligatorio——
tasks[].attempt_countintegerobbligatorio——
tasks[].max_attemptsintegerobbligatorio——
tasks[].error_codeanyOf<string | null>facoltativo——
tasks[].error_code · variant 1stringfacoltativo——
tasks[].error_code · variant 2nullfacoltativo——
tasks[].error_messageanyOf<string | null>facoltativo——
tasks[].error_message · variant 1stringfacoltativo——
tasks[].error_message · variant 2nullfacoltativo——
tasks[].created_atstringobbligatorio—
format: date-time
tasks[].queued_atanyOf<string | null>facoltativo——
tasks[].queued_at · variant 1stringfacoltativo—
format: date-time
tasks[].queued_at · variant 2nullfacoltativo——
tasks[].started_atanyOf<string | null>facoltativo——
tasks[].started_at · variant 1stringfacoltativo—
format: date-time
tasks[].started_at · variant 2nullfacoltativo——
tasks[].completed_atanyOf<string | null>facoltativo——
tasks[].completed_at · variant 1stringfacoltativo—
format: date-time
tasks[].completed_at · variant 2nullfacoltativo——
tasks[].attemptsobject[]facoltativo——
tasks[].attempts[]objectfacoltativo——
tasks[].attempts[].idstringobbligatorio——
tasks[].attempts[].attempt_numberintegerobbligatorio——
tasks[].attempts[].statusstringobbligatorio——
tasks[].attempts[].worker_idanyOf<string | null>facoltativo——
tasks[].attempts[].worker_id · variant 1stringfacoltativo——
tasks[].attempts[].worker_id · variant 2nullfacoltativo——
tasks[].attempts[].runtime_classanyOf<string | null>facoltativo——
tasks[].attempts[].runtime_class · variant 1stringfacoltativo——
tasks[].attempts[].runtime_class · variant 2nullfacoltativo——
tasks[].attempts[].regionanyOf<string | null>facoltativo——
tasks[].attempts[].region · variant 1stringfacoltativo——
tasks[].attempts[].region · variant 2nullfacoltativo——
tasks[].attempts[].engineanyOf<string | null>facoltativo——
tasks[].attempts[].engine · variant 1stringfacoltativo——
tasks[].attempts[].engine · variant 2nullfacoltativo——
tasks[].attempts[].engine_versionanyOf<string | null>facoltativo——
tasks[].attempts[].engine_version · variant 1stringfacoltativo——
tasks[].attempts[].engine_version · variant 2nullfacoltativo——
tasks[].attempts[].input_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].input_bytes · variant 1integerfacoltativo——
tasks[].attempts[].input_bytes · variant 2nullfacoltativo——
tasks[].attempts[].output_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].output_bytes · variant 1integerfacoltativo——
tasks[].attempts[].output_bytes · variant 2nullfacoltativo——
tasks[].attempts[].wall_msanyOf<integer | null>facoltativo——
tasks[].attempts[].wall_ms · variant 1integerfacoltativo——
tasks[].attempts[].wall_ms · variant 2nullfacoltativo——
tasks[].attempts[].cpu_msanyOf<integer | null>facoltativo——
tasks[].attempts[].cpu_ms · variant 1integerfacoltativo——
tasks[].attempts[].cpu_ms · variant 2nullfacoltativo——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>facoltativo——
tasks[].attempts[].peak_memory_mb · variant 1integerfacoltativo——
tasks[].attempts[].peak_memory_mb · variant 2nullfacoltativo——
tasks[].attempts[].temp_bytesanyOf<integer | null>facoltativo——
tasks[].attempts[].temp_bytes · variant 1integerfacoltativo——
tasks[].attempts[].temp_bytes · variant 2nullfacoltativo——
tasks[].attempts[].error_codeanyOf<string | null>facoltativo——
tasks[].attempts[].error_code · variant 1stringfacoltativo——
tasks[].attempts[].error_code · variant 2nullfacoltativo——
tasks[].attempts[].error_messageanyOf<string | null>facoltativo——
tasks[].attempts[].error_message · variant 1stringfacoltativo——
tasks[].attempts[].error_message · variant 2nullfacoltativo——
tasks[].attempts[].estimated_creditsanyOf<string | null>facoltativo——
tasks[].attempts[].estimated_credits · variant 1stringfacoltativo——
tasks[].attempts[].estimated_credits · variant 2nullfacoltativo——
tasks[].attempts[].settled_creditsanyOf<string | null>facoltativo——
tasks[].attempts[].settled_credits · variant 1stringfacoltativo——
tasks[].attempts[].settled_credits · variant 2nullfacoltativo——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>facoltativo——
tasks[].attempts[].external_side_effect_started_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullfacoltativo——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>facoltativo——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullfacoltativo——
tasks[].attempts[].started_atstringobbligatorio—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>facoltativo——
tasks[].attempts[].completed_at · variant 1stringfacoltativo—
format: date-time
tasks[].attempts[].completed_at · variant 2nullfacoltativo——
400The request could not be processed.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
401Authentication is missing or invalid.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
403The principal is not allowed to perform this operation.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
409The request conflicts with the current resource or idempotency state.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
422Validation Error
application/json
CampoTipoObbligatorioDescrizioneVincoli
detailobject[]facoltativo——
detail[]objectfacoltativo——
detail[].locanyOf<string | integer>[]obbligatorio——
detail[].loc[]anyOf<string | integer>facoltativo——
detail[].loc[] · variant 1stringfacoltativo——
detail[].loc[] · variant 2integerfacoltativo——
detail[].msgstringobbligatorio——
detail[].typestringobbligatorio——
429The caller has exceeded an admission-control limit.
Intestazioni della rispostaRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
500An unexpected server error occurred.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——
503A required service is temporarily unavailable.
application/problem+json
CampoTipoObbligatorioDescrizioneVincoli
typestringobbligatorio—
default: "about:blank"
titlestringobbligatorio——
statusintegerobbligatorio—
min: 400max: 599
codestringobbligatorio——
detailstringobbligatorio——
retryablebooleanobbligatorio——
parameteranyOf<string | null>facoltativo——
parameter · variant 1stringfacoltativo——
parameter · variant 2nullfacoltativo——
request_idanyOf<string | null>facoltativo——
request_id · variant 1stringfacoltativo——
request_id · variant 2nullfacoltativo——