ConverterHQDevelopers
Gegenereerd uit het geselecteerde openbare OpenAPI-contract

REST-API-referentie

Bekijk parameters, authenticatie, geneste velden, responsschema’s, fouten en uitvoerbare voorbeelden. Consumenten-, SEO- en beheerroutes zijn uitgesloten.

74 getoonde endpoints74 bewerkingen in totaal17 tags3.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.

AuthenticatieOpenbaar / geen authenticatie voor deze bewerking vereist

Parameters

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

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
dataobject[]verplicht——
data[]objectoptioneel——
data[].supportedbooleanverplicht——
data[].input_formatstringverplicht——
data[].output_formatstringverplicht——
data[].maturitystringoptioneel—
enum: "stable", "disabled"default: "stable"
data[].settings_scopestringoptioneelSettings 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[].routeobjectoptioneel——
data[].route.multi_stepbooleanoptioneelTrue 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[]optioneelSetting 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>optioneelStable 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 1stringoptioneel——
data[].options_version · variant 2nulloptioneel——
data[].optionsobject[]optioneelSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
data[].options[]objectoptioneel——
data[].options[].namestringverplicht——
data[].options[].typestringverplicht——
data[].options[].labelstringverplicht——
data[].options[].descriptionanyOf<string | null>optioneel——
data[].options[].description · variant 1stringoptioneel——
data[].options[].description · variant 2nulloptioneel——
data[].options[].requiredbooleanoptioneel—
default: false
data[].options[].advancedbooleanoptioneel—
default: false
data[].options[].groupanyOf<string | null>optioneel——
data[].options[].group · variant 1stringoptioneel——
data[].options[].group · variant 2nulloptioneel——
data[].options[].defaultunknownoptioneel——
data[].options[].possible_valuesanyOf<unknown[] | null>optioneel——
data[].options[].possible_values · variant 1unknown[]optioneel——
data[].options[].possible_values · variant 2nulloptioneel——
data[].options[].minimumanyOf<integer | number | null>optioneel——
data[].options[].minimum · variant 1integeroptioneel——
data[].options[].minimum · variant 2numberoptioneel——
data[].options[].minimum · variant 3nulloptioneel——
data[].options[].maximumanyOf<integer | number | null>optioneel——
data[].options[].maximum · variant 1integeroptioneel——
data[].options[].maximum · variant 2numberoptioneel——
data[].options[].maximum · variant 3nulloptioneel——
data[].options[].depends_onobject[]optioneel——
data[].options[].conflicts_withstring[]optioneel——
data[].options[].schemaanyOf<object | null>optioneel——
data[].options[].schema · variant 1objectoptioneel——
data[].options[].schema · variant 2nulloptioneel——
data[].options_schemaobjectoptioneelStrict JSON Schema for the settings accepted by this pair-level conversion task.—
data[].limitsobjectoptioneel——
data[].billingobjectoptioneel——
paginationobjectverplicht——
pagination.nextanyOf<string | null>optioneel——
pagination.next · variant 1stringoptioneel——
pagination.next · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

AuthenticatieOpenbaar / geen authenticatie voor deze bewerking vereist

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
from_formatpathstringverplicht—
to_formatpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
supportedbooleanverplicht——
input_formatstringverplicht——
output_formatstringverplicht——
maturitystringoptioneel—
enum: "stable", "disabled"default: "stable"
settings_scopestringoptioneelSettings 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"
routeobjectoptioneel——
route.multi_stepbooleanoptioneelTrue 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[]optioneelSetting 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>optioneelStable 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 1stringoptioneel——
options_version · variant 2nulloptioneel——
optionsobject[]optioneelSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
options[]objectoptioneel——
options[].namestringverplicht——
options[].typestringverplicht——
options[].labelstringverplicht——
options[].descriptionanyOf<string | null>optioneel——
options[].description · variant 1stringoptioneel——
options[].description · variant 2nulloptioneel——
options[].requiredbooleanoptioneel—
default: false
options[].advancedbooleanoptioneel—
default: false
options[].groupanyOf<string | null>optioneel——
options[].group · variant 1stringoptioneel——
options[].group · variant 2nulloptioneel——
options[].defaultunknownoptioneel——
options[].possible_valuesanyOf<unknown[] | null>optioneel——
options[].possible_values · variant 1unknown[]optioneel——
options[].possible_values · variant 2nulloptioneel——
options[].minimumanyOf<integer | number | null>optioneel——
options[].minimum · variant 1integeroptioneel——
options[].minimum · variant 2numberoptioneel——
options[].minimum · variant 3nulloptioneel——
options[].maximumanyOf<integer | number | null>optioneel——
options[].maximum · variant 1integeroptioneel——
options[].maximum · variant 2numberoptioneel——
options[].maximum · variant 3nulloptioneel——
options[].depends_onobject[]optioneel——
options[].conflicts_withstring[]optioneel——
options[].schemaanyOf<object | null>optioneel——
options[].schema · variant 1objectoptioneel——
options[].schema · variant 2nulloptioneel——
options_schemaobjectoptioneelStrict JSON Schema for the settings accepted by this pair-level conversion task.—
limitsobjectoptioneel——
billingobjectoptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
account_idstringverplicht——
productstringverplicht——
api_enabledbooleanverplicht——
plansstring[]verplicht——
effective_planobjectverplicht——
effective_plan.codestringverplicht——
effective_plan.namestringverplicht——
effective_plan.familyanyOf<string | null>optioneel——
effective_plan.family · variant 1stringoptioneel——
effective_plan.family · variant 2nulloptioneel——
effective_plan.billing_intervalanyOf<string | null>optioneel——
effective_plan.billing_interval · variant 1stringoptioneel——
effective_plan.billing_interval · variant 2nulloptioneel——
creditsobjectverplicht——
credits.availablestringverplicht——
credits.reservedstringverplicht——
credits.debtstringverplicht——
quotaanyOf<object | null>optioneel——
quota · variant 1objectoptioneel——
quota · variant 1.keystringverplicht——
quota · variant 1.periodstringverplicht——
quota · variant 1.period_keystringverplicht——
quota · variant 1.limitstringverplicht——
quota · variant 1.usedstringverplicht——
quota · variant 1.remainingstringverplicht——
quota · variant 1.period_startstringverplicht—
format: date-time
quota · variant 1.period_endstringverplicht—
format: date-time
quota · variant 2nulloptioneel——
subscriptionsobject[]verplicht——
subscriptions[]objectoptioneel——
subscriptions[].idstringverplicht——
subscriptions[].planstringverplicht——
subscriptions[].statusstringverplicht——
subscriptions[].billing_intervalanyOf<string | null>optioneel——
subscriptions[].billing_interval · variant 1stringoptioneel——
subscriptions[].billing_interval · variant 2nulloptioneel——
subscriptions[].current_period_startanyOf<string | null>optioneel——
subscriptions[].current_period_start · variant 1stringoptioneel—
format: date-time
subscriptions[].current_period_start · variant 2nulloptioneel——
subscriptions[].current_period_endanyOf<string | null>optioneel——
subscriptions[].current_period_end · variant 1stringoptioneel—
format: date-time
subscriptions[].current_period_end · variant 2nulloptioneel——
subscriptions[].next_billed_atanyOf<string | null>optioneel——
subscriptions[].next_billed_at · variant 1stringoptioneel—
format: date-time
subscriptions[].next_billed_at · variant 2nulloptioneel——
passesobject[]verplicht——
passes[]objectoptioneel——
passes[].idstringverplicht——
passes[].offerstringverplicht——
passes[].planstringverplicht——
passes[].starts_atstringverplicht—
format: date-time
passes[].expires_atstringverplicht—
format: date-time
generated_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
limitqueryintegeroptioneel
default: 50min: 1max: 200
afterqueryanyOf<string | null>optioneel—
providerqueryanyOf<string | null>optioneel—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
dataobject[]verplicht——
data[]objectoptioneel——
data[].idstringverplicht——
data[].namestringverplicht——
data[].providerstringverplicht—
enum: "s3", "gcs", "azure", "sftp"
data[].config_summaryobjectverplicht——
data[].enabledbooleanverplicht——
data[].created_atstringverplicht—
format: date-time
data[].updated_atstringverplicht—
format: date-time
paginationobjectverplicht——
pagination.nextanyOf<string | null>optioneel——
pagination.next · variant 1stringoptioneel——
pagination.next · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
namestringverplicht—
min length: 1max length: 255
providerstringverplicht—
enum: "s3", "gcs", "azure", "sftp"
configobjectverplicht——

Responses

201Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
namestringverplicht——
providerstringverplicht—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectverplicht——
enabledbooleanverplicht——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
connection_idpathstringverplicht—

Responses

204Successful Response

Geen response-inhoud.

400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
connection_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
namestringverplicht——
providerstringverplicht—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectverplicht——
enabledbooleanverplicht——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
connection_idpathstringverplicht—

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
nameanyOf<string | null>optioneel——
name · variant 1stringoptioneel—
min length: 1max length: 255
name · variant 2nulloptioneel——
configanyOf<object | null>optioneel——
config · variant 1objectoptioneel——
config · variant 2nulloptioneel——
enabledanyOf<boolean | null>optioneel——
enabled · variant 1booleanoptioneel——
enabled · variant 2nulloptioneel——

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
namestringverplicht——
providerstringverplicht—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectverplicht——
enabledbooleanverplicht——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
connection_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
okbooleanverplicht——
providerstringverplicht——
detailsobjectoptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
PreferheaderanyOf<string | null>optioneel—
Idempotency-KeyheaderanyOf<string | null>optioneel—

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
inputobjectverplicht——
input.file_idanyOf<string | null>optioneel—
default: null
input.file_id · variant 1stringoptioneel——
input.file_id · variant 2nulloptioneel——
input.urlanyOf<string | null>optioneel—
default: null
input.url · variant 1stringoptioneel——
input.url · variant 2nulloptioneel——
input_formatanyOf<string | null>optioneel—
default: null
input_format · variant 1stringoptioneel——
input_format · variant 2nulloptioneel——
output_formatstringverplicht—
min length: 1max length: 64
optionsobjectoptioneel——
filenameanyOf<string | null>optioneel—
default: null
filename · variant 1stringoptioneel—
max length: 512
filename · variant 2nulloptioneel——
metadataobjectoptioneel——
client_reference_idanyOf<string | null>optioneel—
default: null
client_reference_id · variant 1stringoptioneel—
max length: 255
client_reference_id · variant 2nulloptioneel——
retention_secondsanyOf<integer | null>optioneel—
default: null
retention_seconds · variant 1integeroptioneel—
min: 0max: 86400
retention_seconds · variant 2nulloptioneel——
multipart/form-data
VeldTypeVerplichtBeschrijvingBeperkingen
filestringverplichtInput file, up to 4 MiB.
format: binary
input_formatstringoptioneelOptional source format when it cannot be detected.—
output_formatstringverplichtRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringoptioneelJSON object containing pair-specific conversion options.—
metadatastringoptioneelJSON object copied to the created Job.—
filenamestringoptioneelOptional output filename hint.—
client_reference_idstringoptioneelOptional caller-defined reference.—
retention_secondsintegeroptioneel—
min: 0max: 86400

Responses

200Conversion completed within the requested wait window.
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
job_idstringverplicht——
statusstringverplicht——
progressintegerverplicht——
input_formatanyOf<string | null>optioneel——
input_format · variant 1stringoptioneel——
input_format · variant 2nulloptioneel——
output_formatstringverplicht——
output_fileanyOf<object | null>optioneel——
output_file · variant 1objectoptioneel——
output_file · variant 1.idstringverplicht——
output_file · variant 1.statusstringverplicht——
output_file · variant 1.rolestringverplicht——
output_file · variant 1.filenamestringverplicht——
output_file · variant 1.content_typeanyOf<string | null>optioneel——
output_file · variant 1.content_type · variant 1stringoptioneel——
output_file · variant 1.content_type · variant 2nulloptioneel——
output_file · variant 1.detected_content_typeanyOf<string | null>optioneel——
output_file · variant 1.detected_content_type · variant 1stringoptioneel——
output_file · variant 1.detected_content_type · variant 2nulloptioneel——
output_file · variant 1.detected_formatanyOf<string | null>optioneel——
output_file · variant 1.detected_format · variant 1stringoptioneel——
output_file · variant 1.detected_format · variant 2nulloptioneel——
output_file · variant 1.size_bytesanyOf<integer | null>optioneel——
output_file · variant 1.size_bytes · variant 1integeroptioneel——
output_file · variant 1.size_bytes · variant 2nulloptioneel——
output_file · variant 1.checksum_sha256anyOf<string | null>optioneel——
output_file · variant 1.checksum_sha256 · variant 1stringoptioneel——
output_file · variant 1.checksum_sha256 · variant 2nulloptioneel——
output_file · variant 1.source_typestringverplicht——
output_file · variant 1.created_atstringverplicht—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>optioneel——
output_file · variant 1.ready_at · variant 1stringoptioneel—
format: date-time
output_file · variant 1.ready_at · variant 2nulloptioneel——
output_file · variant 1.expires_atanyOf<string | null>optioneel——
output_file · variant 1.expires_at · variant 1stringoptioneel—
format: date-time
output_file · variant 1.expires_at · variant 2nulloptioneel——
output_file · variant 1.metadataobjectoptioneel——
output_file · variant 1.uploadanyOf<object | null>optioneel——
output_file · variant 1.upload · variant 1objectoptioneel——
output_file · variant 1.upload · variant 1.methodstringoptioneel—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringverplicht——
output_file · variant 1.upload · variant 1.expires_atstringverplicht—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectoptioneel——
output_file · variant 1.upload · variant 2nulloptioneel——
output_file · variant 1.download_urlanyOf<string | null>optioneel——
output_file · variant 1.download_url · variant 1stringoptioneel——
output_file · variant 1.download_url · variant 2nulloptioneel——
output_file · variant 1.download_expires_atanyOf<string | null>optioneel——
output_file · variant 1.download_expires_at · variant 1stringoptioneel—
format: date-time
output_file · variant 1.download_expires_at · variant 2nulloptioneel——
output_file · variant 2nulloptioneel——
created_atstringverplicht—
format: date-time
202Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
job_idstringverplicht——
statusstringverplicht——
progressintegerverplicht——
input_formatanyOf<string | null>optioneel——
input_format · variant 1stringoptioneel——
input_format · variant 2nulloptioneel——
output_formatstringverplicht——
output_fileanyOf<object | null>optioneel——
output_file · variant 1objectoptioneel——
output_file · variant 1.idstringverplicht——
output_file · variant 1.statusstringverplicht——
output_file · variant 1.rolestringverplicht——
output_file · variant 1.filenamestringverplicht——
output_file · variant 1.content_typeanyOf<string | null>optioneel——
output_file · variant 1.content_type · variant 1stringoptioneel——
output_file · variant 1.content_type · variant 2nulloptioneel——
output_file · variant 1.detected_content_typeanyOf<string | null>optioneel——
output_file · variant 1.detected_content_type · variant 1stringoptioneel——
output_file · variant 1.detected_content_type · variant 2nulloptioneel——
output_file · variant 1.detected_formatanyOf<string | null>optioneel——
output_file · variant 1.detected_format · variant 1stringoptioneel——
output_file · variant 1.detected_format · variant 2nulloptioneel——
output_file · variant 1.size_bytesanyOf<integer | null>optioneel——
output_file · variant 1.size_bytes · variant 1integeroptioneel——
output_file · variant 1.size_bytes · variant 2nulloptioneel——
output_file · variant 1.checksum_sha256anyOf<string | null>optioneel——
output_file · variant 1.checksum_sha256 · variant 1stringoptioneel——
output_file · variant 1.checksum_sha256 · variant 2nulloptioneel——
output_file · variant 1.source_typestringverplicht——
output_file · variant 1.created_atstringverplicht—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>optioneel——
output_file · variant 1.ready_at · variant 1stringoptioneel—
format: date-time
output_file · variant 1.ready_at · variant 2nulloptioneel——
output_file · variant 1.expires_atanyOf<string | null>optioneel——
output_file · variant 1.expires_at · variant 1stringoptioneel—
format: date-time
output_file · variant 1.expires_at · variant 2nulloptioneel——
output_file · variant 1.metadataobjectoptioneel——
output_file · variant 1.uploadanyOf<object | null>optioneel——
output_file · variant 1.upload · variant 1objectoptioneel——
output_file · variant 1.upload · variant 1.methodstringoptioneel—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringverplicht——
output_file · variant 1.upload · variant 1.expires_atstringverplicht—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectoptioneel——
output_file · variant 1.upload · variant 2nulloptioneel——
output_file · variant 1.download_urlanyOf<string | null>optioneel——
output_file · variant 1.download_url · variant 1stringoptioneel——
output_file · variant 1.download_url · variant 2nulloptioneel——
output_file · variant 1.download_expires_atanyOf<string | null>optioneel——
output_file · variant 1.download_expires_at · variant 1stringoptioneel—
format: date-time
output_file · variant 1.download_expires_at · variant 2nulloptioneel——
output_file · variant 2nulloptioneel——
created_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
from_formatpathstringverplicht—
to_formatpathstringverplicht—
PreferheaderanyOf<string | null>optioneel—
Idempotency-KeyheaderanyOf<string | null>optioneel—

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
inputobjectverplicht——
input.file_idanyOf<string | null>optioneel—
default: null
input.file_id · variant 1stringoptioneel——
input.file_id · variant 2nulloptioneel——
input.urlanyOf<string | null>optioneel—
default: null
input.url · variant 1stringoptioneel——
input.url · variant 2nulloptioneel——
input_formatanyOf<string | null>optioneel—
default: null
input_format · variant 1stringoptioneel——
input_format · variant 2nulloptioneel——
output_formatstringverplicht—
min length: 1max length: 64
optionsobjectoptioneel——
filenameanyOf<string | null>optioneel—
default: null
filename · variant 1stringoptioneel—
max length: 512
filename · variant 2nulloptioneel——
metadataobjectoptioneel——
client_reference_idanyOf<string | null>optioneel—
default: null
client_reference_id · variant 1stringoptioneel—
max length: 255
client_reference_id · variant 2nulloptioneel——
retention_secondsanyOf<integer | null>optioneel—
default: null
retention_seconds · variant 1integeroptioneel—
min: 0max: 86400
retention_seconds · variant 2nulloptioneel——
multipart/form-data
VeldTypeVerplichtBeschrijvingBeperkingen
filestringverplichtInput file, up to 4 MiB.
format: binary
input_formatstringoptioneelOptional source format when it cannot be detected.—
output_formatstringoptioneelRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringoptioneelJSON object containing pair-specific conversion options.—
metadatastringoptioneelJSON object copied to the created Job.—
filenamestringoptioneelOptional output filename hint.—
client_reference_idstringoptioneelOptional caller-defined reference.—
retention_secondsintegeroptioneel—
min: 0max: 86400

Responses

200Conversion completed within the requested wait window.
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
job_idstringverplicht——
statusstringverplicht——
progressintegerverplicht——
input_formatanyOf<string | null>optioneel——
input_format · variant 1stringoptioneel——
input_format · variant 2nulloptioneel——
output_formatstringverplicht——
output_fileanyOf<object | null>optioneel——
output_file · variant 1objectoptioneel——
output_file · variant 1.idstringverplicht——
output_file · variant 1.statusstringverplicht——
output_file · variant 1.rolestringverplicht——
output_file · variant 1.filenamestringverplicht——
output_file · variant 1.content_typeanyOf<string | null>optioneel——
output_file · variant 1.content_type · variant 1stringoptioneel——
output_file · variant 1.content_type · variant 2nulloptioneel——
output_file · variant 1.detected_content_typeanyOf<string | null>optioneel——
output_file · variant 1.detected_content_type · variant 1stringoptioneel——
output_file · variant 1.detected_content_type · variant 2nulloptioneel——
output_file · variant 1.detected_formatanyOf<string | null>optioneel——
output_file · variant 1.detected_format · variant 1stringoptioneel——
output_file · variant 1.detected_format · variant 2nulloptioneel——
output_file · variant 1.size_bytesanyOf<integer | null>optioneel——
output_file · variant 1.size_bytes · variant 1integeroptioneel——
output_file · variant 1.size_bytes · variant 2nulloptioneel——
output_file · variant 1.checksum_sha256anyOf<string | null>optioneel——
output_file · variant 1.checksum_sha256 · variant 1stringoptioneel——
output_file · variant 1.checksum_sha256 · variant 2nulloptioneel——
output_file · variant 1.source_typestringverplicht——
output_file · variant 1.created_atstringverplicht—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>optioneel——
output_file · variant 1.ready_at · variant 1stringoptioneel—
format: date-time
output_file · variant 1.ready_at · variant 2nulloptioneel——
output_file · variant 1.expires_atanyOf<string | null>optioneel——
output_file · variant 1.expires_at · variant 1stringoptioneel—
format: date-time
output_file · variant 1.expires_at · variant 2nulloptioneel——
output_file · variant 1.metadataobjectoptioneel——
output_file · variant 1.uploadanyOf<object | null>optioneel——
output_file · variant 1.upload · variant 1objectoptioneel——
output_file · variant 1.upload · variant 1.methodstringoptioneel—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringverplicht——
output_file · variant 1.upload · variant 1.expires_atstringverplicht—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectoptioneel——
output_file · variant 1.upload · variant 2nulloptioneel——
output_file · variant 1.download_urlanyOf<string | null>optioneel——
output_file · variant 1.download_url · variant 1stringoptioneel——
output_file · variant 1.download_url · variant 2nulloptioneel——
output_file · variant 1.download_expires_atanyOf<string | null>optioneel——
output_file · variant 1.download_expires_at · variant 1stringoptioneel—
format: date-time
output_file · variant 1.download_expires_at · variant 2nulloptioneel——
output_file · variant 2nulloptioneel——
created_atstringverplicht—
format: date-time
202Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
job_idstringverplicht——
statusstringverplicht——
progressintegerverplicht——
input_formatanyOf<string | null>optioneel——
input_format · variant 1stringoptioneel——
input_format · variant 2nulloptioneel——
output_formatstringverplicht——
output_fileanyOf<object | null>optioneel——
output_file · variant 1objectoptioneel——
output_file · variant 1.idstringverplicht——
output_file · variant 1.statusstringverplicht——
output_file · variant 1.rolestringverplicht——
output_file · variant 1.filenamestringverplicht——
output_file · variant 1.content_typeanyOf<string | null>optioneel——
output_file · variant 1.content_type · variant 1stringoptioneel——
output_file · variant 1.content_type · variant 2nulloptioneel——
output_file · variant 1.detected_content_typeanyOf<string | null>optioneel——
output_file · variant 1.detected_content_type · variant 1stringoptioneel——
output_file · variant 1.detected_content_type · variant 2nulloptioneel——
output_file · variant 1.detected_formatanyOf<string | null>optioneel——
output_file · variant 1.detected_format · variant 1stringoptioneel——
output_file · variant 1.detected_format · variant 2nulloptioneel——
output_file · variant 1.size_bytesanyOf<integer | null>optioneel——
output_file · variant 1.size_bytes · variant 1integeroptioneel——
output_file · variant 1.size_bytes · variant 2nulloptioneel——
output_file · variant 1.checksum_sha256anyOf<string | null>optioneel——
output_file · variant 1.checksum_sha256 · variant 1stringoptioneel——
output_file · variant 1.checksum_sha256 · variant 2nulloptioneel——
output_file · variant 1.source_typestringverplicht——
output_file · variant 1.created_atstringverplicht—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>optioneel——
output_file · variant 1.ready_at · variant 1stringoptioneel—
format: date-time
output_file · variant 1.ready_at · variant 2nulloptioneel——
output_file · variant 1.expires_atanyOf<string | null>optioneel——
output_file · variant 1.expires_at · variant 1stringoptioneel—
format: date-time
output_file · variant 1.expires_at · variant 2nulloptioneel——
output_file · variant 1.metadataobjectoptioneel——
output_file · variant 1.uploadanyOf<object | null>optioneel——
output_file · variant 1.upload · variant 1objectoptioneel——
output_file · variant 1.upload · variant 1.methodstringoptioneel—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringverplicht——
output_file · variant 1.upload · variant 1.expires_atstringverplicht—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectoptioneel——
output_file · variant 1.upload · variant 2nulloptioneel——
output_file · variant 1.download_urlanyOf<string | null>optioneel——
output_file · variant 1.download_url · variant 1stringoptioneel——
output_file · variant 1.download_url · variant 2nulloptioneel——
output_file · variant 1.download_expires_atanyOf<string | null>optioneel——
output_file · variant 1.download_expires_at · variant 1stringoptioneel—
format: date-time
output_file · variant 1.download_expires_at · variant 2nulloptioneel——
output_file · variant 2nulloptioneel——
created_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
input_formatstringverplicht——
output_formatstringverplicht——
size_bytesanyOf<integer | null>optioneel——
size_bytes · variant 1integeroptioneel—
min: 0
size_bytes · variant 2nulloptioneel——
page_countanyOf<integer | null>optioneel——
page_count · variant 1integeroptioneel—
min: 0
page_count · variant 2nulloptioneel——
duration_secondsanyOf<number | null>optioneel——
duration_seconds · variant 1numberoptioneel—
min: 0
duration_seconds · variant 2nulloptioneel——
optionsobjectoptioneel——

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
supportedbooleanverplicht——
recommended_modestringverplicht—
enum: "sync", "async"
creditsobjectverplicht——
warningsstring[]optioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
GET/v1/event-typesEvent TypesDiscovery#

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

AuthenticatieOpenbaar / geen authenticatie voor deze bewerking vereist

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
dataobject[]verplicht——
data[]objectoptioneel——
data[].typestringverplicht——
data[].descriptionstringverplicht——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
limitqueryintegeroptioneel
default: 50min: 1max: 200
afterqueryanyOf<string | null>optioneel—
statusqueryanyOf<string | null>optioneel—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
dataobject[]verplicht——
data[]objectoptioneel——
data[].idstringverplicht——
data[].statusstringverplicht——
data[].rolestringverplicht——
data[].filenamestringverplicht——
data[].content_typeanyOf<string | null>optioneel——
data[].content_type · variant 1stringoptioneel——
data[].content_type · variant 2nulloptioneel——
data[].detected_content_typeanyOf<string | null>optioneel——
data[].detected_content_type · variant 1stringoptioneel——
data[].detected_content_type · variant 2nulloptioneel——
data[].detected_formatanyOf<string | null>optioneel——
data[].detected_format · variant 1stringoptioneel——
data[].detected_format · variant 2nulloptioneel——
data[].size_bytesanyOf<integer | null>optioneel——
data[].size_bytes · variant 1integeroptioneel——
data[].size_bytes · variant 2nulloptioneel——
data[].checksum_sha256anyOf<string | null>optioneel——
data[].checksum_sha256 · variant 1stringoptioneel——
data[].checksum_sha256 · variant 2nulloptioneel——
data[].source_typestringverplicht——
data[].created_atstringverplicht—
format: date-time
data[].ready_atanyOf<string | null>optioneel——
data[].ready_at · variant 1stringoptioneel—
format: date-time
data[].ready_at · variant 2nulloptioneel——
data[].expires_atanyOf<string | null>optioneel——
data[].expires_at · variant 1stringoptioneel—
format: date-time
data[].expires_at · variant 2nulloptioneel——
data[].metadataobjectoptioneel——
data[].uploadanyOf<object | null>optioneel——
data[].upload · variant 1objectoptioneel——
data[].upload · variant 1.methodstringoptioneel—
default: "PUT"
data[].upload · variant 1.urlstringverplicht——
data[].upload · variant 1.expires_atstringverplicht—
format: date-time
data[].upload · variant 1.headersobjectoptioneel——
data[].upload · variant 2nulloptioneel——
data[].download_urlanyOf<string | null>optioneel——
data[].download_url · variant 1stringoptioneel——
data[].download_url · variant 2nulloptioneel——
data[].download_expires_atanyOf<string | null>optioneel——
data[].download_expires_at · variant 1stringoptioneel—
format: date-time
data[].download_expires_at · variant 2nulloptioneel——
paginationobjectverplicht——
pagination.nextanyOf<string | null>optioneel——
pagination.next · variant 1stringoptioneel——
pagination.next · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
filenamestringverplicht—
min length: 1max length: 512
size_bytesanyOf<integer | null>optioneel——
size_bytes · variant 1integeroptioneel—
min: 0
size_bytes · variant 2nulloptioneel——
content_typeanyOf<string | null>optioneel——
content_type · variant 1stringoptioneel—
max length: 255
content_type · variant 2nulloptioneel——
checksum_sha256anyOf<string | null>optioneel——
checksum_sha256 · variant 1stringoptioneel—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nulloptioneel——
retention_secondsanyOf<integer | null>optioneel——
retention_seconds · variant 1integeroptioneel—
min: 0max: 86400
retention_seconds · variant 2nulloptioneel——
metadataobjectoptioneel——

Responses

201Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
statusstringverplicht——
rolestringverplicht——
filenamestringverplicht——
content_typeanyOf<string | null>optioneel——
content_type · variant 1stringoptioneel——
content_type · variant 2nulloptioneel——
detected_content_typeanyOf<string | null>optioneel——
detected_content_type · variant 1stringoptioneel——
detected_content_type · variant 2nulloptioneel——
detected_formatanyOf<string | null>optioneel——
detected_format · variant 1stringoptioneel——
detected_format · variant 2nulloptioneel——
size_bytesanyOf<integer | null>optioneel——
size_bytes · variant 1integeroptioneel——
size_bytes · variant 2nulloptioneel——
checksum_sha256anyOf<string | null>optioneel——
checksum_sha256 · variant 1stringoptioneel——
checksum_sha256 · variant 2nulloptioneel——
source_typestringverplicht——
created_atstringverplicht—
format: date-time
ready_atanyOf<string | null>optioneel——
ready_at · variant 1stringoptioneel—
format: date-time
ready_at · variant 2nulloptioneel——
expires_atanyOf<string | null>optioneel——
expires_at · variant 1stringoptioneel—
format: date-time
expires_at · variant 2nulloptioneel——
metadataobjectoptioneel——
uploadanyOf<object | null>optioneel——
upload · variant 1objectoptioneel——
upload · variant 1.methodstringoptioneel—
default: "PUT"
upload · variant 1.urlstringverplicht——
upload · variant 1.expires_atstringverplicht—
format: date-time
upload · variant 1.headersobjectoptioneel——
upload · variant 2nulloptioneel——
download_urlanyOf<string | null>optioneel——
download_url · variant 1stringoptioneel——
download_url · variant 2nulloptioneel——
download_expires_atanyOf<string | null>optioneel——
download_expires_at · variant 1stringoptioneel—
format: date-time
download_expires_at · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
file_idpathstringverplicht—

Responses

204Successful Response

Geen response-inhoud.

400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
file_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
statusstringverplicht——
rolestringverplicht——
filenamestringverplicht——
content_typeanyOf<string | null>optioneel——
content_type · variant 1stringoptioneel——
content_type · variant 2nulloptioneel——
detected_content_typeanyOf<string | null>optioneel——
detected_content_type · variant 1stringoptioneel——
detected_content_type · variant 2nulloptioneel——
detected_formatanyOf<string | null>optioneel——
detected_format · variant 1stringoptioneel——
detected_format · variant 2nulloptioneel——
size_bytesanyOf<integer | null>optioneel——
size_bytes · variant 1integeroptioneel——
size_bytes · variant 2nulloptioneel——
checksum_sha256anyOf<string | null>optioneel——
checksum_sha256 · variant 1stringoptioneel——
checksum_sha256 · variant 2nulloptioneel——
source_typestringverplicht——
created_atstringverplicht—
format: date-time
ready_atanyOf<string | null>optioneel——
ready_at · variant 1stringoptioneel—
format: date-time
ready_at · variant 2nulloptioneel——
expires_atanyOf<string | null>optioneel——
expires_at · variant 1stringoptioneel—
format: date-time
expires_at · variant 2nulloptioneel——
metadataobjectoptioneel——
uploadanyOf<object | null>optioneel——
upload · variant 1objectoptioneel——
upload · variant 1.methodstringoptioneel—
default: "PUT"
upload · variant 1.urlstringverplicht——
upload · variant 1.expires_atstringverplicht—
format: date-time
upload · variant 1.headersobjectoptioneel——
upload · variant 2nulloptioneel——
download_urlanyOf<string | null>optioneel——
download_url · variant 1stringoptioneel——
download_url · variant 2nulloptioneel——
download_expires_atanyOf<string | null>optioneel——
download_expires_at · variant 1stringoptioneel—
format: date-time
download_expires_at · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
file_idpathstringverplicht—

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
checksum_sha256anyOf<string | null>optioneel——
checksum_sha256 · variant 1stringoptioneel—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nulloptioneel——

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
statusstringverplicht——
rolestringverplicht——
filenamestringverplicht——
content_typeanyOf<string | null>optioneel——
content_type · variant 1stringoptioneel——
content_type · variant 2nulloptioneel——
detected_content_typeanyOf<string | null>optioneel——
detected_content_type · variant 1stringoptioneel——
detected_content_type · variant 2nulloptioneel——
detected_formatanyOf<string | null>optioneel——
detected_format · variant 1stringoptioneel——
detected_format · variant 2nulloptioneel——
size_bytesanyOf<integer | null>optioneel——
size_bytes · variant 1integeroptioneel——
size_bytes · variant 2nulloptioneel——
checksum_sha256anyOf<string | null>optioneel——
checksum_sha256 · variant 1stringoptioneel——
checksum_sha256 · variant 2nulloptioneel——
source_typestringverplicht——
created_atstringverplicht—
format: date-time
ready_atanyOf<string | null>optioneel——
ready_at · variant 1stringoptioneel—
format: date-time
ready_at · variant 2nulloptioneel——
expires_atanyOf<string | null>optioneel——
expires_at · variant 1stringoptioneel—
format: date-time
expires_at · variant 2nulloptioneel——
metadataobjectoptioneel——
uploadanyOf<object | null>optioneel——
upload · variant 1objectoptioneel——
upload · variant 1.methodstringoptioneel—
default: "PUT"
upload · variant 1.urlstringverplicht——
upload · variant 1.expires_atstringverplicht—
format: date-time
upload · variant 1.headersobjectoptioneel——
upload · variant 2nulloptioneel——
download_urlanyOf<string | null>optioneel——
download_url · variant 1stringoptioneel——
download_url · variant 2nulloptioneel——
download_expires_atanyOf<string | null>optioneel——
download_expires_at · variant 1stringoptioneel—
format: date-time
download_expires_at · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
file_idpathstringverplicht—

Responses

204Successful Response

Geen response-inhoud.

400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
file_idpathstringverplicht—

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
part_sizeanyOf<integer | null>optioneel——
part_size · variant 1integeroptioneel—
min: 5242880max: 5368709120
part_size · variant 2nulloptioneel——

Responses

201Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
file_idstringverplicht——
upload_idstringverplicht——
part_sizeintegerverplicht——
max_partsintegeroptioneel—
default: 10000
expires_atstringverplicht—
format: date-time
partsobject[]optioneel——
parts[]objectoptioneel——
parts[].part_numberintegerverplicht——
parts[].urlstringverplicht——
parts[].expires_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
file_idpathstringverplicht—

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
partsobject[]verplicht—
min items: 1max items: 10000
parts[]objectoptioneel——
parts[].part_numberintegerverplicht—
min: 1max: 10000
parts[].etagstringverplicht—
min length: 1max length: 512
checksum_sha256anyOf<string | null>optioneel——
checksum_sha256 · variant 1stringoptioneel—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nulloptioneel——

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
statusstringverplicht——
rolestringverplicht——
filenamestringverplicht——
content_typeanyOf<string | null>optioneel——
content_type · variant 1stringoptioneel——
content_type · variant 2nulloptioneel——
detected_content_typeanyOf<string | null>optioneel——
detected_content_type · variant 1stringoptioneel——
detected_content_type · variant 2nulloptioneel——
detected_formatanyOf<string | null>optioneel——
detected_format · variant 1stringoptioneel——
detected_format · variant 2nulloptioneel——
size_bytesanyOf<integer | null>optioneel——
size_bytes · variant 1integeroptioneel——
size_bytes · variant 2nulloptioneel——
checksum_sha256anyOf<string | null>optioneel——
checksum_sha256 · variant 1stringoptioneel——
checksum_sha256 · variant 2nulloptioneel——
source_typestringverplicht——
created_atstringverplicht—
format: date-time
ready_atanyOf<string | null>optioneel——
ready_at · variant 1stringoptioneel—
format: date-time
ready_at · variant 2nulloptioneel——
expires_atanyOf<string | null>optioneel——
expires_at · variant 1stringoptioneel—
format: date-time
expires_at · variant 2nulloptioneel——
metadataobjectoptioneel——
uploadanyOf<object | null>optioneel——
upload · variant 1objectoptioneel——
upload · variant 1.methodstringoptioneel—
default: "PUT"
upload · variant 1.urlstringverplicht——
upload · variant 1.expires_atstringverplicht—
format: date-time
upload · variant 1.headersobjectoptioneel——
upload · variant 2nulloptioneel——
download_urlanyOf<string | null>optioneel——
download_url · variant 1stringoptioneel——
download_url · variant 2nulloptioneel——
download_expires_atanyOf<string | null>optioneel——
download_expires_at · variant 1stringoptioneel—
format: date-time
download_expires_at · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
file_idpathstringverplicht—

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
part_numbersinteger[]verplicht—
min items: 1max items: 1000

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
file_idstringverplicht——
upload_idstringverplicht——
part_sizeintegerverplicht——
max_partsintegeroptioneel—
default: 10000
expires_atstringverplicht—
format: date-time
partsobject[]optioneel——
parts[]objectoptioneel——
parts[].part_numberintegerverplicht——
parts[].urlstringverplicht——
parts[].expires_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

AuthenticatieOpenbaar / geen authenticatie voor deze bewerking vereist

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
limitqueryintegeroptioneel
default: 500min: 1max: 500

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
dataobject[]verplicht——
data[]objectoptioneel——
data[].slugstringverplicht——
data[].labelstringverplicht——
data[].categorystringverplicht——
data[].mime_typesstring[]verplicht——
data[].extensionsstring[]verplicht——
paginationobjectverplicht——
pagination.nextanyOf<string | null>optioneel——
pagination.next · variant 1stringoptioneel——
pagination.next · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

AuthenticatieOpenbaar / geen authenticatie voor deze bewerking vereist

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
slugpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
slugstringverplicht——
labelstringverplicht——
categorystringverplicht——
mime_typesstring[]verplicht——
extensionsstring[]verplicht——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

AuthenticatieOpenbaar / geen authenticatie voor deze bewerking vereist

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
slugpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
dataobject[]verplicht——
data[]objectoptioneel——
data[].slugstringverplicht——
data[].labelstringverplicht——
data[].categorystringverplicht——
data[].mime_typesstring[]verplicht——
data[].extensionsstring[]verplicht——
paginationobjectverplicht——
pagination.nextanyOf<string | null>optioneel——
pagination.next · variant 1stringoptioneel——
pagination.next · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

AuthenticatieOpenbaar / geen authenticatie voor deze bewerking vereist

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
slugpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
dataobject[]verplicht——
data[]objectoptioneel——
data[].slugstringverplicht——
data[].labelstringverplicht——
data[].categorystringverplicht——
data[].mime_typesstring[]verplicht——
data[].extensionsstring[]verplicht——
paginationobjectverplicht——
pagination.nextanyOf<string | null>optioneel——
pagination.next · variant 1stringoptioneel——
pagination.next · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
limitqueryintegeroptioneel
default: 50min: 1max: 200
afterqueryanyOf<string | null>optioneel—
statusqueryanyOf<string | null>optioneel—
tagqueryanyOf<string | null>optioneel—
originqueryanyOf<string | null>optioneel—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
dataobject[]verplicht——
data[]objectoptioneel——
data[].idstringverplicht——
data[].kindstringverplicht——
data[].statusstringverplicht——
data[].progressintegerverplicht——
data[].taganyOf<string | null>optioneel——
data[].tag · variant 1stringoptioneel——
data[].tag · variant 2nulloptioneel——
data[].client_reference_idanyOf<string | null>optioneel——
data[].client_reference_id · variant 1stringoptioneel——
data[].client_reference_id · variant 2nulloptioneel——
data[].metadataobjectoptioneel——
data[].prioritystringverplicht——
data[].concurrency_limitintegeroptioneel—
default: 1
data[].originstringverplicht——
data[].created_atstringverplicht—
format: date-time
data[].started_atanyOf<string | null>optioneel——
data[].started_at · variant 1stringoptioneel—
format: date-time
data[].started_at · variant 2nulloptioneel——
data[].completed_atanyOf<string | null>optioneel——
data[].completed_at · variant 1stringoptioneel—
format: date-time
data[].completed_at · variant 2nulloptioneel——
data[].error_codeanyOf<string | null>optioneel——
data[].error_code · variant 1stringoptioneel——
data[].error_code · variant 2nulloptioneel——
data[].error_messageanyOf<string | null>optioneel——
data[].error_message · variant 1stringoptioneel——
data[].error_message · variant 2nulloptioneel——
data[].tasksobject[]optioneel——
data[].tasks[]objectoptioneel——
data[].tasks[].idstringverplicht——
data[].tasks[].job_idstringverplicht——
data[].tasks[].namestringverplicht——
data[].tasks[].operationstringverplicht——
data[].tasks[].statusstringverplicht——
data[].tasks[].progressintegerverplicht——
data[].tasks[].inputobjectverplicht——
data[].tasks[].optionsobjectverplicht——
data[].tasks[].resultobjectverplicht——
data[].tasks[].requiredbooleanverplicht——
data[].tasks[].runtime_classstringverplicht——
data[].tasks[].prioritystringverplicht——
data[].tasks[].attempt_countintegerverplicht——
data[].tasks[].max_attemptsintegerverplicht——
data[].tasks[].error_codeanyOf<string | null>optioneel——
data[].tasks[].error_code · variant 1stringoptioneel——
data[].tasks[].error_code · variant 2nulloptioneel——
data[].tasks[].error_messageanyOf<string | null>optioneel——
data[].tasks[].error_message · variant 1stringoptioneel——
data[].tasks[].error_message · variant 2nulloptioneel——
data[].tasks[].created_atstringverplicht—
format: date-time
data[].tasks[].queued_atanyOf<string | null>optioneel——
data[].tasks[].queued_at · variant 1stringoptioneel—
format: date-time
data[].tasks[].queued_at · variant 2nulloptioneel——
data[].tasks[].started_atanyOf<string | null>optioneel——
data[].tasks[].started_at · variant 1stringoptioneel—
format: date-time
data[].tasks[].started_at · variant 2nulloptioneel——
data[].tasks[].completed_atanyOf<string | null>optioneel——
data[].tasks[].completed_at · variant 1stringoptioneel—
format: date-time
data[].tasks[].completed_at · variant 2nulloptioneel——
data[].tasks[].attemptsobject[]optioneel——
data[].tasks[].attempts[]objectoptioneel——
data[].tasks[].attempts[].idstringverplicht——
data[].tasks[].attempts[].attempt_numberintegerverplicht——
data[].tasks[].attempts[].statusstringverplicht——
data[].tasks[].attempts[].worker_idanyOf<string | null>optioneel——
data[].tasks[].attempts[].worker_id · variant 1stringoptioneel——
data[].tasks[].attempts[].worker_id · variant 2nulloptioneel——
data[].tasks[].attempts[].runtime_classanyOf<string | null>optioneel——
data[].tasks[].attempts[].runtime_class · variant 1stringoptioneel——
data[].tasks[].attempts[].runtime_class · variant 2nulloptioneel——
data[].tasks[].attempts[].regionanyOf<string | null>optioneel——
data[].tasks[].attempts[].region · variant 1stringoptioneel——
data[].tasks[].attempts[].region · variant 2nulloptioneel——
data[].tasks[].attempts[].engineanyOf<string | null>optioneel——
data[].tasks[].attempts[].engine · variant 1stringoptioneel——
data[].tasks[].attempts[].engine · variant 2nulloptioneel——
data[].tasks[].attempts[].engine_versionanyOf<string | null>optioneel——
data[].tasks[].attempts[].engine_version · variant 1stringoptioneel——
data[].tasks[].attempts[].engine_version · variant 2nulloptioneel——
data[].tasks[].attempts[].input_bytesanyOf<integer | null>optioneel——
data[].tasks[].attempts[].input_bytes · variant 1integeroptioneel——
data[].tasks[].attempts[].input_bytes · variant 2nulloptioneel——
data[].tasks[].attempts[].output_bytesanyOf<integer | null>optioneel——
data[].tasks[].attempts[].output_bytes · variant 1integeroptioneel——
data[].tasks[].attempts[].output_bytes · variant 2nulloptioneel——
data[].tasks[].attempts[].wall_msanyOf<integer | null>optioneel——
data[].tasks[].attempts[].wall_ms · variant 1integeroptioneel——
data[].tasks[].attempts[].wall_ms · variant 2nulloptioneel——
data[].tasks[].attempts[].cpu_msanyOf<integer | null>optioneel——
data[].tasks[].attempts[].cpu_ms · variant 1integeroptioneel——
data[].tasks[].attempts[].cpu_ms · variant 2nulloptioneel——
data[].tasks[].attempts[].peak_memory_mbanyOf<integer | null>optioneel——
data[].tasks[].attempts[].peak_memory_mb · variant 1integeroptioneel——
data[].tasks[].attempts[].peak_memory_mb · variant 2nulloptioneel——
data[].tasks[].attempts[].temp_bytesanyOf<integer | null>optioneel——
data[].tasks[].attempts[].temp_bytes · variant 1integeroptioneel——
data[].tasks[].attempts[].temp_bytes · variant 2nulloptioneel——
data[].tasks[].attempts[].error_codeanyOf<string | null>optioneel——
data[].tasks[].attempts[].error_code · variant 1stringoptioneel——
data[].tasks[].attempts[].error_code · variant 2nulloptioneel——
data[].tasks[].attempts[].error_messageanyOf<string | null>optioneel——
data[].tasks[].attempts[].error_message · variant 1stringoptioneel——
data[].tasks[].attempts[].error_message · variant 2nulloptioneel——
data[].tasks[].attempts[].estimated_creditsanyOf<string | null>optioneel——
data[].tasks[].attempts[].estimated_credits · variant 1stringoptioneel——
data[].tasks[].attempts[].estimated_credits · variant 2nulloptioneel——
data[].tasks[].attempts[].settled_creditsanyOf<string | null>optioneel——
data[].tasks[].attempts[].settled_credits · variant 1stringoptioneel——
data[].tasks[].attempts[].settled_credits · variant 2nulloptioneel——
data[].tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optioneel——
data[].tasks[].attempts[].external_side_effect_started_at · variant 1stringoptioneel—
format: date-time
data[].tasks[].attempts[].external_side_effect_started_at · variant 2nulloptioneel——
data[].tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optioneel——
data[].tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptioneel—
format: date-time
data[].tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptioneel——
data[].tasks[].attempts[].started_atstringverplicht—
format: date-time
data[].tasks[].attempts[].completed_atanyOf<string | null>optioneel——
data[].tasks[].attempts[].completed_at · variant 1stringoptioneel—
format: date-time
data[].tasks[].attempts[].completed_at · variant 2nulloptioneel——
paginationobjectverplicht——
pagination.nextanyOf<string | null>optioneel——
pagination.next · variant 1stringoptioneel——
pagination.next · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
Idempotency-KeyheaderanyOf<string | null>optioneel—

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
tasksobjectverplicht——
taganyOf<string | null>optioneel——
tag · variant 1stringoptioneel—
max length: 255
tag · variant 2nulloptioneel——
client_reference_idanyOf<string | null>optioneel——
client_reference_id · variant 1stringoptioneel—
max length: 255
client_reference_id · variant 2nulloptioneel——
metadataobjectoptioneel——
prioritystringoptioneel—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>optioneel——
retention_seconds · variant 1integeroptioneel—
min: 0max: 86400
retention_seconds · variant 2nulloptioneel——

Responses

201Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
kindstringverplicht——
statusstringverplicht——
progressintegerverplicht——
taganyOf<string | null>optioneel——
tag · variant 1stringoptioneel——
tag · variant 2nulloptioneel——
client_reference_idanyOf<string | null>optioneel——
client_reference_id · variant 1stringoptioneel——
client_reference_id · variant 2nulloptioneel——
metadataobjectoptioneel——
prioritystringverplicht——
concurrency_limitintegeroptioneel—
default: 1
originstringverplicht——
created_atstringverplicht—
format: date-time
started_atanyOf<string | null>optioneel——
started_at · variant 1stringoptioneel—
format: date-time
started_at · variant 2nulloptioneel——
completed_atanyOf<string | null>optioneel——
completed_at · variant 1stringoptioneel—
format: date-time
completed_at · variant 2nulloptioneel——
error_codeanyOf<string | null>optioneel——
error_code · variant 1stringoptioneel——
error_code · variant 2nulloptioneel——
error_messageanyOf<string | null>optioneel——
error_message · variant 1stringoptioneel——
error_message · variant 2nulloptioneel——
tasksobject[]optioneel——
tasks[]objectoptioneel——
tasks[].idstringverplicht——
tasks[].job_idstringverplicht——
tasks[].namestringverplicht——
tasks[].operationstringverplicht——
tasks[].statusstringverplicht——
tasks[].progressintegerverplicht——
tasks[].inputobjectverplicht——
tasks[].optionsobjectverplicht——
tasks[].resultobjectverplicht——
tasks[].requiredbooleanverplicht——
tasks[].runtime_classstringverplicht——
tasks[].prioritystringverplicht——
tasks[].attempt_countintegerverplicht——
tasks[].max_attemptsintegerverplicht——
tasks[].error_codeanyOf<string | null>optioneel——
tasks[].error_code · variant 1stringoptioneel——
tasks[].error_code · variant 2nulloptioneel——
tasks[].error_messageanyOf<string | null>optioneel——
tasks[].error_message · variant 1stringoptioneel——
tasks[].error_message · variant 2nulloptioneel——
tasks[].created_atstringverplicht—
format: date-time
tasks[].queued_atanyOf<string | null>optioneel——
tasks[].queued_at · variant 1stringoptioneel—
format: date-time
tasks[].queued_at · variant 2nulloptioneel——
tasks[].started_atanyOf<string | null>optioneel——
tasks[].started_at · variant 1stringoptioneel—
format: date-time
tasks[].started_at · variant 2nulloptioneel——
tasks[].completed_atanyOf<string | null>optioneel——
tasks[].completed_at · variant 1stringoptioneel—
format: date-time
tasks[].completed_at · variant 2nulloptioneel——
tasks[].attemptsobject[]optioneel——
tasks[].attempts[]objectoptioneel——
tasks[].attempts[].idstringverplicht——
tasks[].attempts[].attempt_numberintegerverplicht——
tasks[].attempts[].statusstringverplicht——
tasks[].attempts[].worker_idanyOf<string | null>optioneel——
tasks[].attempts[].worker_id · variant 1stringoptioneel——
tasks[].attempts[].worker_id · variant 2nulloptioneel——
tasks[].attempts[].runtime_classanyOf<string | null>optioneel——
tasks[].attempts[].runtime_class · variant 1stringoptioneel——
tasks[].attempts[].runtime_class · variant 2nulloptioneel——
tasks[].attempts[].regionanyOf<string | null>optioneel——
tasks[].attempts[].region · variant 1stringoptioneel——
tasks[].attempts[].region · variant 2nulloptioneel——
tasks[].attempts[].engineanyOf<string | null>optioneel——
tasks[].attempts[].engine · variant 1stringoptioneel——
tasks[].attempts[].engine · variant 2nulloptioneel——
tasks[].attempts[].engine_versionanyOf<string | null>optioneel——
tasks[].attempts[].engine_version · variant 1stringoptioneel——
tasks[].attempts[].engine_version · variant 2nulloptioneel——
tasks[].attempts[].input_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].input_bytes · variant 1integeroptioneel——
tasks[].attempts[].input_bytes · variant 2nulloptioneel——
tasks[].attempts[].output_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].output_bytes · variant 1integeroptioneel——
tasks[].attempts[].output_bytes · variant 2nulloptioneel——
tasks[].attempts[].wall_msanyOf<integer | null>optioneel——
tasks[].attempts[].wall_ms · variant 1integeroptioneel——
tasks[].attempts[].wall_ms · variant 2nulloptioneel——
tasks[].attempts[].cpu_msanyOf<integer | null>optioneel——
tasks[].attempts[].cpu_ms · variant 1integeroptioneel——
tasks[].attempts[].cpu_ms · variant 2nulloptioneel——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>optioneel——
tasks[].attempts[].peak_memory_mb · variant 1integeroptioneel——
tasks[].attempts[].peak_memory_mb · variant 2nulloptioneel——
tasks[].attempts[].temp_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].temp_bytes · variant 1integeroptioneel——
tasks[].attempts[].temp_bytes · variant 2nulloptioneel——
tasks[].attempts[].error_codeanyOf<string | null>optioneel——
tasks[].attempts[].error_code · variant 1stringoptioneel——
tasks[].attempts[].error_code · variant 2nulloptioneel——
tasks[].attempts[].error_messageanyOf<string | null>optioneel——
tasks[].attempts[].error_message · variant 1stringoptioneel——
tasks[].attempts[].error_message · variant 2nulloptioneel——
tasks[].attempts[].estimated_creditsanyOf<string | null>optioneel——
tasks[].attempts[].estimated_credits · variant 1stringoptioneel——
tasks[].attempts[].estimated_credits · variant 2nulloptioneel——
tasks[].attempts[].settled_creditsanyOf<string | null>optioneel——
tasks[].attempts[].settled_credits · variant 1stringoptioneel——
tasks[].attempts[].settled_credits · variant 2nulloptioneel——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optioneel——
tasks[].attempts[].external_side_effect_started_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nulloptioneel——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optioneel——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptioneel——
tasks[].attempts[].started_atstringverplicht—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>optioneel——
tasks[].attempts[].completed_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].completed_at · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
job_idpathstringverplicht—
include_attemptsquerybooleanoptioneel
default: false

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
kindstringverplicht——
statusstringverplicht——
progressintegerverplicht——
taganyOf<string | null>optioneel——
tag · variant 1stringoptioneel——
tag · variant 2nulloptioneel——
client_reference_idanyOf<string | null>optioneel——
client_reference_id · variant 1stringoptioneel——
client_reference_id · variant 2nulloptioneel——
metadataobjectoptioneel——
prioritystringverplicht——
concurrency_limitintegeroptioneel—
default: 1
originstringverplicht——
created_atstringverplicht—
format: date-time
started_atanyOf<string | null>optioneel——
started_at · variant 1stringoptioneel—
format: date-time
started_at · variant 2nulloptioneel——
completed_atanyOf<string | null>optioneel——
completed_at · variant 1stringoptioneel—
format: date-time
completed_at · variant 2nulloptioneel——
error_codeanyOf<string | null>optioneel——
error_code · variant 1stringoptioneel——
error_code · variant 2nulloptioneel——
error_messageanyOf<string | null>optioneel——
error_message · variant 1stringoptioneel——
error_message · variant 2nulloptioneel——
tasksobject[]optioneel——
tasks[]objectoptioneel——
tasks[].idstringverplicht——
tasks[].job_idstringverplicht——
tasks[].namestringverplicht——
tasks[].operationstringverplicht——
tasks[].statusstringverplicht——
tasks[].progressintegerverplicht——
tasks[].inputobjectverplicht——
tasks[].optionsobjectverplicht——
tasks[].resultobjectverplicht——
tasks[].requiredbooleanverplicht——
tasks[].runtime_classstringverplicht——
tasks[].prioritystringverplicht——
tasks[].attempt_countintegerverplicht——
tasks[].max_attemptsintegerverplicht——
tasks[].error_codeanyOf<string | null>optioneel——
tasks[].error_code · variant 1stringoptioneel——
tasks[].error_code · variant 2nulloptioneel——
tasks[].error_messageanyOf<string | null>optioneel——
tasks[].error_message · variant 1stringoptioneel——
tasks[].error_message · variant 2nulloptioneel——
tasks[].created_atstringverplicht—
format: date-time
tasks[].queued_atanyOf<string | null>optioneel——
tasks[].queued_at · variant 1stringoptioneel—
format: date-time
tasks[].queued_at · variant 2nulloptioneel——
tasks[].started_atanyOf<string | null>optioneel——
tasks[].started_at · variant 1stringoptioneel—
format: date-time
tasks[].started_at · variant 2nulloptioneel——
tasks[].completed_atanyOf<string | null>optioneel——
tasks[].completed_at · variant 1stringoptioneel—
format: date-time
tasks[].completed_at · variant 2nulloptioneel——
tasks[].attemptsobject[]optioneel——
tasks[].attempts[]objectoptioneel——
tasks[].attempts[].idstringverplicht——
tasks[].attempts[].attempt_numberintegerverplicht——
tasks[].attempts[].statusstringverplicht——
tasks[].attempts[].worker_idanyOf<string | null>optioneel——
tasks[].attempts[].worker_id · variant 1stringoptioneel——
tasks[].attempts[].worker_id · variant 2nulloptioneel——
tasks[].attempts[].runtime_classanyOf<string | null>optioneel——
tasks[].attempts[].runtime_class · variant 1stringoptioneel——
tasks[].attempts[].runtime_class · variant 2nulloptioneel——
tasks[].attempts[].regionanyOf<string | null>optioneel——
tasks[].attempts[].region · variant 1stringoptioneel——
tasks[].attempts[].region · variant 2nulloptioneel——
tasks[].attempts[].engineanyOf<string | null>optioneel——
tasks[].attempts[].engine · variant 1stringoptioneel——
tasks[].attempts[].engine · variant 2nulloptioneel——
tasks[].attempts[].engine_versionanyOf<string | null>optioneel——
tasks[].attempts[].engine_version · variant 1stringoptioneel——
tasks[].attempts[].engine_version · variant 2nulloptioneel——
tasks[].attempts[].input_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].input_bytes · variant 1integeroptioneel——
tasks[].attempts[].input_bytes · variant 2nulloptioneel——
tasks[].attempts[].output_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].output_bytes · variant 1integeroptioneel——
tasks[].attempts[].output_bytes · variant 2nulloptioneel——
tasks[].attempts[].wall_msanyOf<integer | null>optioneel——
tasks[].attempts[].wall_ms · variant 1integeroptioneel——
tasks[].attempts[].wall_ms · variant 2nulloptioneel——
tasks[].attempts[].cpu_msanyOf<integer | null>optioneel——
tasks[].attempts[].cpu_ms · variant 1integeroptioneel——
tasks[].attempts[].cpu_ms · variant 2nulloptioneel——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>optioneel——
tasks[].attempts[].peak_memory_mb · variant 1integeroptioneel——
tasks[].attempts[].peak_memory_mb · variant 2nulloptioneel——
tasks[].attempts[].temp_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].temp_bytes · variant 1integeroptioneel——
tasks[].attempts[].temp_bytes · variant 2nulloptioneel——
tasks[].attempts[].error_codeanyOf<string | null>optioneel——
tasks[].attempts[].error_code · variant 1stringoptioneel——
tasks[].attempts[].error_code · variant 2nulloptioneel——
tasks[].attempts[].error_messageanyOf<string | null>optioneel——
tasks[].attempts[].error_message · variant 1stringoptioneel——
tasks[].attempts[].error_message · variant 2nulloptioneel——
tasks[].attempts[].estimated_creditsanyOf<string | null>optioneel——
tasks[].attempts[].estimated_credits · variant 1stringoptioneel——
tasks[].attempts[].estimated_credits · variant 2nulloptioneel——
tasks[].attempts[].settled_creditsanyOf<string | null>optioneel——
tasks[].attempts[].settled_credits · variant 1stringoptioneel——
tasks[].attempts[].settled_credits · variant 2nulloptioneel——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optioneel——
tasks[].attempts[].external_side_effect_started_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nulloptioneel——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optioneel——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptioneel——
tasks[].attempts[].started_atstringverplicht—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>optioneel——
tasks[].attempts[].completed_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].completed_at · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
job_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
kindstringverplicht——
statusstringverplicht——
progressintegerverplicht——
taganyOf<string | null>optioneel——
tag · variant 1stringoptioneel——
tag · variant 2nulloptioneel——
client_reference_idanyOf<string | null>optioneel——
client_reference_id · variant 1stringoptioneel——
client_reference_id · variant 2nulloptioneel——
metadataobjectoptioneel——
prioritystringverplicht——
concurrency_limitintegeroptioneel—
default: 1
originstringverplicht——
created_atstringverplicht—
format: date-time
started_atanyOf<string | null>optioneel——
started_at · variant 1stringoptioneel—
format: date-time
started_at · variant 2nulloptioneel——
completed_atanyOf<string | null>optioneel——
completed_at · variant 1stringoptioneel—
format: date-time
completed_at · variant 2nulloptioneel——
error_codeanyOf<string | null>optioneel——
error_code · variant 1stringoptioneel——
error_code · variant 2nulloptioneel——
error_messageanyOf<string | null>optioneel——
error_message · variant 1stringoptioneel——
error_message · variant 2nulloptioneel——
tasksobject[]optioneel——
tasks[]objectoptioneel——
tasks[].idstringverplicht——
tasks[].job_idstringverplicht——
tasks[].namestringverplicht——
tasks[].operationstringverplicht——
tasks[].statusstringverplicht——
tasks[].progressintegerverplicht——
tasks[].inputobjectverplicht——
tasks[].optionsobjectverplicht——
tasks[].resultobjectverplicht——
tasks[].requiredbooleanverplicht——
tasks[].runtime_classstringverplicht——
tasks[].prioritystringverplicht——
tasks[].attempt_countintegerverplicht——
tasks[].max_attemptsintegerverplicht——
tasks[].error_codeanyOf<string | null>optioneel——
tasks[].error_code · variant 1stringoptioneel——
tasks[].error_code · variant 2nulloptioneel——
tasks[].error_messageanyOf<string | null>optioneel——
tasks[].error_message · variant 1stringoptioneel——
tasks[].error_message · variant 2nulloptioneel——
tasks[].created_atstringverplicht—
format: date-time
tasks[].queued_atanyOf<string | null>optioneel——
tasks[].queued_at · variant 1stringoptioneel—
format: date-time
tasks[].queued_at · variant 2nulloptioneel——
tasks[].started_atanyOf<string | null>optioneel——
tasks[].started_at · variant 1stringoptioneel—
format: date-time
tasks[].started_at · variant 2nulloptioneel——
tasks[].completed_atanyOf<string | null>optioneel——
tasks[].completed_at · variant 1stringoptioneel—
format: date-time
tasks[].completed_at · variant 2nulloptioneel——
tasks[].attemptsobject[]optioneel——
tasks[].attempts[]objectoptioneel——
tasks[].attempts[].idstringverplicht——
tasks[].attempts[].attempt_numberintegerverplicht——
tasks[].attempts[].statusstringverplicht——
tasks[].attempts[].worker_idanyOf<string | null>optioneel——
tasks[].attempts[].worker_id · variant 1stringoptioneel——
tasks[].attempts[].worker_id · variant 2nulloptioneel——
tasks[].attempts[].runtime_classanyOf<string | null>optioneel——
tasks[].attempts[].runtime_class · variant 1stringoptioneel——
tasks[].attempts[].runtime_class · variant 2nulloptioneel——
tasks[].attempts[].regionanyOf<string | null>optioneel——
tasks[].attempts[].region · variant 1stringoptioneel——
tasks[].attempts[].region · variant 2nulloptioneel——
tasks[].attempts[].engineanyOf<string | null>optioneel——
tasks[].attempts[].engine · variant 1stringoptioneel——
tasks[].attempts[].engine · variant 2nulloptioneel——
tasks[].attempts[].engine_versionanyOf<string | null>optioneel——
tasks[].attempts[].engine_version · variant 1stringoptioneel——
tasks[].attempts[].engine_version · variant 2nulloptioneel——
tasks[].attempts[].input_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].input_bytes · variant 1integeroptioneel——
tasks[].attempts[].input_bytes · variant 2nulloptioneel——
tasks[].attempts[].output_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].output_bytes · variant 1integeroptioneel——
tasks[].attempts[].output_bytes · variant 2nulloptioneel——
tasks[].attempts[].wall_msanyOf<integer | null>optioneel——
tasks[].attempts[].wall_ms · variant 1integeroptioneel——
tasks[].attempts[].wall_ms · variant 2nulloptioneel——
tasks[].attempts[].cpu_msanyOf<integer | null>optioneel——
tasks[].attempts[].cpu_ms · variant 1integeroptioneel——
tasks[].attempts[].cpu_ms · variant 2nulloptioneel——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>optioneel——
tasks[].attempts[].peak_memory_mb · variant 1integeroptioneel——
tasks[].attempts[].peak_memory_mb · variant 2nulloptioneel——
tasks[].attempts[].temp_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].temp_bytes · variant 1integeroptioneel——
tasks[].attempts[].temp_bytes · variant 2nulloptioneel——
tasks[].attempts[].error_codeanyOf<string | null>optioneel——
tasks[].attempts[].error_code · variant 1stringoptioneel——
tasks[].attempts[].error_code · variant 2nulloptioneel——
tasks[].attempts[].error_messageanyOf<string | null>optioneel——
tasks[].attempts[].error_message · variant 1stringoptioneel——
tasks[].attempts[].error_message · variant 2nulloptioneel——
tasks[].attempts[].estimated_creditsanyOf<string | null>optioneel——
tasks[].attempts[].estimated_credits · variant 1stringoptioneel——
tasks[].attempts[].estimated_credits · variant 2nulloptioneel——
tasks[].attempts[].settled_creditsanyOf<string | null>optioneel——
tasks[].attempts[].settled_credits · variant 1stringoptioneel——
tasks[].attempts[].settled_credits · variant 2nulloptioneel——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optioneel——
tasks[].attempts[].external_side_effect_started_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nulloptioneel——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optioneel——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptioneel——
tasks[].attempts[].started_atstringverplicht—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>optioneel——
tasks[].attempts[].completed_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].completed_at · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
job_idpathstringverplicht—
timeoutqueryintegeroptioneel
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>optioneel—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
bodyunknownverplicht——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
job_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
kindstringverplicht——
statusstringverplicht——
progressintegerverplicht——
taganyOf<string | null>optioneel——
tag · variant 1stringoptioneel——
tag · variant 2nulloptioneel——
client_reference_idanyOf<string | null>optioneel——
client_reference_id · variant 1stringoptioneel——
client_reference_id · variant 2nulloptioneel——
metadataobjectoptioneel——
prioritystringverplicht——
concurrency_limitintegeroptioneel—
default: 1
originstringverplicht——
created_atstringverplicht—
format: date-time
started_atanyOf<string | null>optioneel——
started_at · variant 1stringoptioneel—
format: date-time
started_at · variant 2nulloptioneel——
completed_atanyOf<string | null>optioneel——
completed_at · variant 1stringoptioneel—
format: date-time
completed_at · variant 2nulloptioneel——
error_codeanyOf<string | null>optioneel——
error_code · variant 1stringoptioneel——
error_code · variant 2nulloptioneel——
error_messageanyOf<string | null>optioneel——
error_message · variant 1stringoptioneel——
error_message · variant 2nulloptioneel——
tasksobject[]optioneel——
tasks[]objectoptioneel——
tasks[].idstringverplicht——
tasks[].job_idstringverplicht——
tasks[].namestringverplicht——
tasks[].operationstringverplicht——
tasks[].statusstringverplicht——
tasks[].progressintegerverplicht——
tasks[].inputobjectverplicht——
tasks[].optionsobjectverplicht——
tasks[].resultobjectverplicht——
tasks[].requiredbooleanverplicht——
tasks[].runtime_classstringverplicht——
tasks[].prioritystringverplicht——
tasks[].attempt_countintegerverplicht——
tasks[].max_attemptsintegerverplicht——
tasks[].error_codeanyOf<string | null>optioneel——
tasks[].error_code · variant 1stringoptioneel——
tasks[].error_code · variant 2nulloptioneel——
tasks[].error_messageanyOf<string | null>optioneel——
tasks[].error_message · variant 1stringoptioneel——
tasks[].error_message · variant 2nulloptioneel——
tasks[].created_atstringverplicht—
format: date-time
tasks[].queued_atanyOf<string | null>optioneel——
tasks[].queued_at · variant 1stringoptioneel—
format: date-time
tasks[].queued_at · variant 2nulloptioneel——
tasks[].started_atanyOf<string | null>optioneel——
tasks[].started_at · variant 1stringoptioneel—
format: date-time
tasks[].started_at · variant 2nulloptioneel——
tasks[].completed_atanyOf<string | null>optioneel——
tasks[].completed_at · variant 1stringoptioneel—
format: date-time
tasks[].completed_at · variant 2nulloptioneel——
tasks[].attemptsobject[]optioneel——
tasks[].attempts[]objectoptioneel——
tasks[].attempts[].idstringverplicht——
tasks[].attempts[].attempt_numberintegerverplicht——
tasks[].attempts[].statusstringverplicht——
tasks[].attempts[].worker_idanyOf<string | null>optioneel——
tasks[].attempts[].worker_id · variant 1stringoptioneel——
tasks[].attempts[].worker_id · variant 2nulloptioneel——
tasks[].attempts[].runtime_classanyOf<string | null>optioneel——
tasks[].attempts[].runtime_class · variant 1stringoptioneel——
tasks[].attempts[].runtime_class · variant 2nulloptioneel——
tasks[].attempts[].regionanyOf<string | null>optioneel——
tasks[].attempts[].region · variant 1stringoptioneel——
tasks[].attempts[].region · variant 2nulloptioneel——
tasks[].attempts[].engineanyOf<string | null>optioneel——
tasks[].attempts[].engine · variant 1stringoptioneel——
tasks[].attempts[].engine · variant 2nulloptioneel——
tasks[].attempts[].engine_versionanyOf<string | null>optioneel——
tasks[].attempts[].engine_version · variant 1stringoptioneel——
tasks[].attempts[].engine_version · variant 2nulloptioneel——
tasks[].attempts[].input_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].input_bytes · variant 1integeroptioneel——
tasks[].attempts[].input_bytes · variant 2nulloptioneel——
tasks[].attempts[].output_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].output_bytes · variant 1integeroptioneel——
tasks[].attempts[].output_bytes · variant 2nulloptioneel——
tasks[].attempts[].wall_msanyOf<integer | null>optioneel——
tasks[].attempts[].wall_ms · variant 1integeroptioneel——
tasks[].attempts[].wall_ms · variant 2nulloptioneel——
tasks[].attempts[].cpu_msanyOf<integer | null>optioneel——
tasks[].attempts[].cpu_ms · variant 1integeroptioneel——
tasks[].attempts[].cpu_ms · variant 2nulloptioneel——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>optioneel——
tasks[].attempts[].peak_memory_mb · variant 1integeroptioneel——
tasks[].attempts[].peak_memory_mb · variant 2nulloptioneel——
tasks[].attempts[].temp_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].temp_bytes · variant 1integeroptioneel——
tasks[].attempts[].temp_bytes · variant 2nulloptioneel——
tasks[].attempts[].error_codeanyOf<string | null>optioneel——
tasks[].attempts[].error_code · variant 1stringoptioneel——
tasks[].attempts[].error_code · variant 2nulloptioneel——
tasks[].attempts[].error_messageanyOf<string | null>optioneel——
tasks[].attempts[].error_message · variant 1stringoptioneel——
tasks[].attempts[].error_message · variant 2nulloptioneel——
tasks[].attempts[].estimated_creditsanyOf<string | null>optioneel——
tasks[].attempts[].estimated_credits · variant 1stringoptioneel——
tasks[].attempts[].estimated_credits · variant 2nulloptioneel——
tasks[].attempts[].settled_creditsanyOf<string | null>optioneel——
tasks[].attempts[].settled_credits · variant 1stringoptioneel——
tasks[].attempts[].settled_credits · variant 2nulloptioneel——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optioneel——
tasks[].attempts[].external_side_effect_started_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nulloptioneel——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optioneel——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptioneel——
tasks[].attempts[].started_atstringverplicht—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>optioneel——
tasks[].attempts[].completed_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].completed_at · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
job_idpathstringverplicht—
timeoutqueryintegeroptioneel
default: 20min: 0max: 30

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
kindstringverplicht——
statusstringverplicht——
progressintegerverplicht——
taganyOf<string | null>optioneel——
tag · variant 1stringoptioneel——
tag · variant 2nulloptioneel——
client_reference_idanyOf<string | null>optioneel——
client_reference_id · variant 1stringoptioneel——
client_reference_id · variant 2nulloptioneel——
metadataobjectoptioneel——
prioritystringverplicht——
concurrency_limitintegeroptioneel—
default: 1
originstringverplicht——
created_atstringverplicht—
format: date-time
started_atanyOf<string | null>optioneel——
started_at · variant 1stringoptioneel—
format: date-time
started_at · variant 2nulloptioneel——
completed_atanyOf<string | null>optioneel——
completed_at · variant 1stringoptioneel—
format: date-time
completed_at · variant 2nulloptioneel——
error_codeanyOf<string | null>optioneel——
error_code · variant 1stringoptioneel——
error_code · variant 2nulloptioneel——
error_messageanyOf<string | null>optioneel——
error_message · variant 1stringoptioneel——
error_message · variant 2nulloptioneel——
tasksobject[]optioneel——
tasks[]objectoptioneel——
tasks[].idstringverplicht——
tasks[].job_idstringverplicht——
tasks[].namestringverplicht——
tasks[].operationstringverplicht——
tasks[].statusstringverplicht——
tasks[].progressintegerverplicht——
tasks[].inputobjectverplicht——
tasks[].optionsobjectverplicht——
tasks[].resultobjectverplicht——
tasks[].requiredbooleanverplicht——
tasks[].runtime_classstringverplicht——
tasks[].prioritystringverplicht——
tasks[].attempt_countintegerverplicht——
tasks[].max_attemptsintegerverplicht——
tasks[].error_codeanyOf<string | null>optioneel——
tasks[].error_code · variant 1stringoptioneel——
tasks[].error_code · variant 2nulloptioneel——
tasks[].error_messageanyOf<string | null>optioneel——
tasks[].error_message · variant 1stringoptioneel——
tasks[].error_message · variant 2nulloptioneel——
tasks[].created_atstringverplicht—
format: date-time
tasks[].queued_atanyOf<string | null>optioneel——
tasks[].queued_at · variant 1stringoptioneel—
format: date-time
tasks[].queued_at · variant 2nulloptioneel——
tasks[].started_atanyOf<string | null>optioneel——
tasks[].started_at · variant 1stringoptioneel—
format: date-time
tasks[].started_at · variant 2nulloptioneel——
tasks[].completed_atanyOf<string | null>optioneel——
tasks[].completed_at · variant 1stringoptioneel—
format: date-time
tasks[].completed_at · variant 2nulloptioneel——
tasks[].attemptsobject[]optioneel——
tasks[].attempts[]objectoptioneel——
tasks[].attempts[].idstringverplicht——
tasks[].attempts[].attempt_numberintegerverplicht——
tasks[].attempts[].statusstringverplicht——
tasks[].attempts[].worker_idanyOf<string | null>optioneel——
tasks[].attempts[].worker_id · variant 1stringoptioneel——
tasks[].attempts[].worker_id · variant 2nulloptioneel——
tasks[].attempts[].runtime_classanyOf<string | null>optioneel——
tasks[].attempts[].runtime_class · variant 1stringoptioneel——
tasks[].attempts[].runtime_class · variant 2nulloptioneel——
tasks[].attempts[].regionanyOf<string | null>optioneel——
tasks[].attempts[].region · variant 1stringoptioneel——
tasks[].attempts[].region · variant 2nulloptioneel——
tasks[].attempts[].engineanyOf<string | null>optioneel——
tasks[].attempts[].engine · variant 1stringoptioneel——
tasks[].attempts[].engine · variant 2nulloptioneel——
tasks[].attempts[].engine_versionanyOf<string | null>optioneel——
tasks[].attempts[].engine_version · variant 1stringoptioneel——
tasks[].attempts[].engine_version · variant 2nulloptioneel——
tasks[].attempts[].input_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].input_bytes · variant 1integeroptioneel——
tasks[].attempts[].input_bytes · variant 2nulloptioneel——
tasks[].attempts[].output_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].output_bytes · variant 1integeroptioneel——
tasks[].attempts[].output_bytes · variant 2nulloptioneel——
tasks[].attempts[].wall_msanyOf<integer | null>optioneel——
tasks[].attempts[].wall_ms · variant 1integeroptioneel——
tasks[].attempts[].wall_ms · variant 2nulloptioneel——
tasks[].attempts[].cpu_msanyOf<integer | null>optioneel——
tasks[].attempts[].cpu_ms · variant 1integeroptioneel——
tasks[].attempts[].cpu_ms · variant 2nulloptioneel——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>optioneel——
tasks[].attempts[].peak_memory_mb · variant 1integeroptioneel——
tasks[].attempts[].peak_memory_mb · variant 2nulloptioneel——
tasks[].attempts[].temp_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].temp_bytes · variant 1integeroptioneel——
tasks[].attempts[].temp_bytes · variant 2nulloptioneel——
tasks[].attempts[].error_codeanyOf<string | null>optioneel——
tasks[].attempts[].error_code · variant 1stringoptioneel——
tasks[].attempts[].error_code · variant 2nulloptioneel——
tasks[].attempts[].error_messageanyOf<string | null>optioneel——
tasks[].attempts[].error_message · variant 1stringoptioneel——
tasks[].attempts[].error_message · variant 2nulloptioneel——
tasks[].attempts[].estimated_creditsanyOf<string | null>optioneel——
tasks[].attempts[].estimated_credits · variant 1stringoptioneel——
tasks[].attempts[].estimated_credits · variant 2nulloptioneel——
tasks[].attempts[].settled_creditsanyOf<string | null>optioneel——
tasks[].attempts[].settled_credits · variant 1stringoptioneel——
tasks[].attempts[].settled_credits · variant 2nulloptioneel——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optioneel——
tasks[].attempts[].external_side_effect_started_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nulloptioneel——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optioneel——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptioneel——
tasks[].attempts[].started_atstringverplicht—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>optioneel——
tasks[].attempts[].completed_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].completed_at · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
tasksobjectverplicht——
taganyOf<string | null>optioneel——
tag · variant 1stringoptioneel—
max length: 255
tag · variant 2nulloptioneel——
client_reference_idanyOf<string | null>optioneel——
client_reference_id · variant 1stringoptioneel—
max length: 255
client_reference_id · variant 2nulloptioneel——
metadataobjectoptioneel——
prioritystringoptioneel—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>optioneel——
retention_seconds · variant 1integeroptioneel—
min: 0max: 86400
retention_seconds · variant 2nulloptioneel——

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
validbooleanverplicht——
task_countintegerverplicht——
execution_orderstring[]verplicht——
root_tasksstring[]verplicht——
warningsstring[]optioneel——
estimated_creditsanyOf<object | null>optioneel——
estimated_credits · variant 1objectoptioneel——
estimated_credits · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
limitqueryintegeroptioneel
default: 50min: 1max: 200
afterqueryanyOf<string | null>optioneel—
status_codequeryanyOf<integer | null>optioneel—
path_prefixqueryanyOf<string | null>optioneel—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
dataobject[]verplicht——
data[]objectoptioneel——
data[].request_idstringverplicht——
data[].methodstringverplicht——
data[].pathstringverplicht——
data[].status_codeintegerverplicht——
data[].latency_msintegerverplicht——
data[].api_key_idanyOf<string | null>optioneel——
data[].api_key_id · variant 1stringoptioneel——
data[].api_key_id · variant 2nulloptioneel——
data[].auth_typestringverplicht——
data[].user_agentanyOf<string | null>optioneel——
data[].user_agent · variant 1stringoptioneel——
data[].user_agent · variant 2nulloptioneel——
data[].created_atstringverplicht——
paginationobjectverplicht——
pagination.nextanyOf<string | null>optioneel——
pagination.next · variant 1stringoptioneel——
pagination.next · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
request_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
request_idstringverplicht——
methodstringverplicht——
pathstringverplicht——
status_codeintegerverplicht——
latency_msintegerverplicht——
api_key_idanyOf<string | null>optioneel——
api_key_id · variant 1stringoptioneel——
api_key_id · variant 2nulloptioneel——
auth_typestringverplicht——
user_agentanyOf<string | null>optioneel——
user_agent · variant 1stringoptioneel——
user_agent · variant 2nulloptioneel——
created_atstringverplicht——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
account_idstringverplicht——
actor_idstringverplicht——
auth_typestringverplicht——
environmentstringverplicht——
access_tierstringoptioneel—
enum: "sandbox", "paid"default: "paid"
scopesstring[]verplicht——
roleanyOf<string | null>optioneel——
role · variant 1stringoptioneel——
role · variant 2nulloptioneel——
authorized_partyanyOf<string | null>optioneel——
authorized_party · variant 1stringoptioneel——
authorized_party · variant 2nulloptioneel——
limitsanyOf<object | null>optioneel——
limits · variant 1objectoptioneel——
limits · variant 1.monthly_callsanyOf<integer | null>optioneel——
limits · variant 1.monthly_calls · variant 1integeroptioneel——
limits · variant 1.monthly_calls · variant 2nulloptioneel——
limits · variant 1.rate_limit_per_minuteanyOf<integer | null>optioneel——
limits · variant 1.rate_limit_per_minute · variant 1integeroptioneel——
limits · variant 1.rate_limit_per_minute · variant 2nulloptioneel——
limits · variant 1.daily_requestsanyOf<integer | null>optioneel——
limits · variant 1.daily_requests · variant 1integeroptioneel——
limits · variant 1.daily_requests · variant 2nulloptioneel——
limits · variant 1.concurrencyanyOf<integer | null>optioneel——
limits · variant 1.concurrency · variant 1integeroptioneel——
limits · variant 1.concurrency · variant 2nulloptioneel——
limits · variant 1.max_file_mbanyOf<integer | null>optioneel——
limits · variant 1.max_file_mb · variant 1integeroptioneel——
limits · variant 1.max_file_mb · variant 2nulloptioneel——
limits · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
GET/v1/operationsOperationsDiscovery#

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

AuthenticatieOpenbaar / geen authenticatie voor deze bewerking vereist

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
dataobject[]verplicht——
data[]objectoptioneel——
data[].operationstringverplicht——
data[].categorystringverplicht—
enum: "import", "processing", "export"
data[].descriptionstringverplicht——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
account_idstringverplicht——
environmentstringverplicht——
scopedbooleanverplicht——
project_idanyOf<string | null>optioneel——
project_id · variant 1stringoptioneel——
project_id · variant 2nulloptioneel——
project_nameanyOf<string | null>optioneel——
project_name · variant 1stringoptioneel——
project_name · variant 2nulloptioneel——
project_sluganyOf<string | null>optioneel——
project_slug · variant 1stringoptioneel——
project_slug · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
GET/v1/project/legacy-migrationPreview Legacy MigrationAuthentication · Projects#

Preview account/environment resources still in the legacy namespace.

Authenticatie
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
bodyobjectverplicht——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
POST/v1/project/legacy-migrationMigrate Legacy Project ResourcesAuthentication · Projects#

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

Authenticatie
ConverterHQBearerhttp / bearer

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
confirm_project_idstringverplicht—
min length: 1max length: 64

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
bodyobjectverplicht——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
tokenstringverplicht——
expires_atstringverplicht—
format: date-time
websocket_urlstringverplicht——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
bodyobjectverplicht——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
fixture_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
bodyobjectverplicht——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
bodyobject[]verplicht——
items[]objectoptioneel——
items[].idstringverplicht——
items[].namestringverplicht——
items[].workflow_idanyOf<string | null>optioneel——
items[].workflow_id · variant 1stringoptioneel——
items[].workflow_id · variant 2nulloptioneel——
items[].workflow_versionanyOf<integer | null>optioneel——
items[].workflow_version · variant 1integeroptioneel——
items[].workflow_version · variant 2nulloptioneel——
items[].inline_definitionanyOf<object | null>optioneel——
items[].inline_definition · variant 1objectoptioneel——
items[].inline_definition · variant 2nulloptioneel——
items[].variables_schemaobjectverplicht——
items[].allowed_source_hostsstring[]verplicht——
items[].max_file_size_bytesanyOf<integer | null>optioneel——
items[].max_file_size_bytes · variant 1integeroptioneel——
items[].max_file_size_bytes · variant 2nulloptioneel——
items[].max_credits_per_requestanyOf<string | null>optioneel——
items[].max_credits_per_request · variant 1stringoptioneel——
items[].max_credits_per_request · variant 2nulloptioneel——
items[].max_usesanyOf<integer | null>optioneel——
items[].max_uses · variant 1integeroptioneel——
items[].max_uses · variant 2nulloptioneel——
items[].use_countintegerverplicht——
items[].cache_ttl_secondsintegerverplicht——
items[].enabledbooleanverplicht——
items[].created_atstringverplicht—
format: date-time
items[].updated_atstringverplicht—
format: date-time
items[].signing_secretanyOf<string | null>optioneel——
items[].signing_secret · variant 1stringoptioneel——
items[].signing_secret · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
namestringverplicht—
min length: 1max length: 255
workflow_idanyOf<string | null>optioneel——
workflow_id · variant 1stringoptioneel——
workflow_id · variant 2nulloptioneel——
inline_definitionanyOf<object | null>optioneel——
inline_definition · variant 1objectoptioneel——
inline_definition · variant 1.tasksobjectverplicht——
inline_definition · variant 1.taganyOf<string | null>optioneel——
inline_definition · variant 1.tag · variant 1stringoptioneel—
max length: 255
inline_definition · variant 1.tag · variant 2nulloptioneel——
inline_definition · variant 1.client_reference_idanyOf<string | null>optioneel——
inline_definition · variant 1.client_reference_id · variant 1stringoptioneel—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nulloptioneel——
inline_definition · variant 1.metadataobjectoptioneel——
inline_definition · variant 1.prioritystringoptioneel—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>optioneel——
inline_definition · variant 1.retention_seconds · variant 1integeroptioneel—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nulloptioneel——
inline_definition · variant 2nulloptioneel——
variables_schemaobjectoptioneel——
allowed_source_hostsstring[]optioneel——
max_file_size_bytesanyOf<integer | null>optioneel——
max_file_size_bytes · variant 1integeroptioneel——
max_file_size_bytes · variant 2nulloptioneel——
max_credits_per_requestanyOf<string | null>optioneel——
max_credits_per_request · variant 1stringoptioneel—
max length: 64
max_credits_per_request · variant 2nulloptioneel——
max_usesanyOf<integer | null>optioneel——
max_uses · variant 1integeroptioneel——
max_uses · variant 2nulloptioneel——
cache_ttl_secondsintegeroptioneel—
default: 0min: 0max: 86400

Responses

201Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
namestringverplicht——
workflow_idanyOf<string | null>optioneel——
workflow_id · variant 1stringoptioneel——
workflow_id · variant 2nulloptioneel——
workflow_versionanyOf<integer | null>optioneel——
workflow_version · variant 1integeroptioneel——
workflow_version · variant 2nulloptioneel——
inline_definitionanyOf<object | null>optioneel——
inline_definition · variant 1objectoptioneel——
inline_definition · variant 2nulloptioneel——
variables_schemaobjectverplicht——
allowed_source_hostsstring[]verplicht——
max_file_size_bytesanyOf<integer | null>optioneel——
max_file_size_bytes · variant 1integeroptioneel——
max_file_size_bytes · variant 2nulloptioneel——
max_credits_per_requestanyOf<string | null>optioneel——
max_credits_per_request · variant 1stringoptioneel——
max_credits_per_request · variant 2nulloptioneel——
max_usesanyOf<integer | null>optioneel——
max_uses · variant 1integeroptioneel——
max_uses · variant 2nulloptioneel——
use_countintegerverplicht——
cache_ttl_secondsintegerverplicht——
enabledbooleanverplicht——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
signing_secretanyOf<string | null>optioneel——
signing_secret · variant 1stringoptioneel——
signing_secret · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
base_idpathstringverplicht—

Responses

204Successful Response

Geen response-inhoud.

400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
base_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
namestringverplicht——
workflow_idanyOf<string | null>optioneel——
workflow_id · variant 1stringoptioneel——
workflow_id · variant 2nulloptioneel——
workflow_versionanyOf<integer | null>optioneel——
workflow_version · variant 1integeroptioneel——
workflow_version · variant 2nulloptioneel——
inline_definitionanyOf<object | null>optioneel——
inline_definition · variant 1objectoptioneel——
inline_definition · variant 2nulloptioneel——
variables_schemaobjectverplicht——
allowed_source_hostsstring[]verplicht——
max_file_size_bytesanyOf<integer | null>optioneel——
max_file_size_bytes · variant 1integeroptioneel——
max_file_size_bytes · variant 2nulloptioneel——
max_credits_per_requestanyOf<string | null>optioneel——
max_credits_per_request · variant 1stringoptioneel——
max_credits_per_request · variant 2nulloptioneel——
max_usesanyOf<integer | null>optioneel——
max_uses · variant 1integeroptioneel——
max_uses · variant 2nulloptioneel——
use_countintegerverplicht——
cache_ttl_secondsintegerverplicht——
enabledbooleanverplicht——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
signing_secretanyOf<string | null>optioneel——
signing_secret · variant 1stringoptioneel——
signing_secret · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
base_idpathstringverplicht—

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
nameanyOf<string | null>optioneel——
name · variant 1stringoptioneel—
min length: 1max length: 255
name · variant 2nulloptioneel——
workflow_idanyOf<string | null>optioneel——
workflow_id · variant 1stringoptioneel——
workflow_id · variant 2nulloptioneel——
inline_definitionanyOf<object | null>optioneel——
inline_definition · variant 1objectoptioneel——
inline_definition · variant 1.tasksobjectverplicht——
inline_definition · variant 1.taganyOf<string | null>optioneel——
inline_definition · variant 1.tag · variant 1stringoptioneel—
max length: 255
inline_definition · variant 1.tag · variant 2nulloptioneel——
inline_definition · variant 1.client_reference_idanyOf<string | null>optioneel——
inline_definition · variant 1.client_reference_id · variant 1stringoptioneel—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nulloptioneel——
inline_definition · variant 1.metadataobjectoptioneel——
inline_definition · variant 1.prioritystringoptioneel—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>optioneel——
inline_definition · variant 1.retention_seconds · variant 1integeroptioneel—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nulloptioneel——
inline_definition · variant 2nulloptioneel——
variables_schemaanyOf<object | null>optioneel——
variables_schema · variant 1objectoptioneel——
variables_schema · variant 2nulloptioneel——
allowed_source_hostsanyOf<string[] | null>optioneel——
allowed_source_hosts · variant 1string[]optioneel——
allowed_source_hosts · variant 2nulloptioneel——
max_file_size_bytesanyOf<integer | null>optioneel——
max_file_size_bytes · variant 1integeroptioneel——
max_file_size_bytes · variant 2nulloptioneel——
max_credits_per_requestanyOf<string | null>optioneel——
max_credits_per_request · variant 1stringoptioneel—
max length: 64
max_credits_per_request · variant 2nulloptioneel——
max_usesanyOf<integer | null>optioneel——
max_uses · variant 1integeroptioneel——
max_uses · variant 2nulloptioneel——
cache_ttl_secondsanyOf<integer | null>optioneel——
cache_ttl_seconds · variant 1integeroptioneel—
min: 0max: 86400
cache_ttl_seconds · variant 2nulloptioneel——
enabledanyOf<boolean | null>optioneel——
enabled · variant 1booleanoptioneel——
enabled · variant 2nulloptioneel——

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
namestringverplicht——
workflow_idanyOf<string | null>optioneel——
workflow_id · variant 1stringoptioneel——
workflow_id · variant 2nulloptioneel——
workflow_versionanyOf<integer | null>optioneel——
workflow_version · variant 1integeroptioneel——
workflow_version · variant 2nulloptioneel——
inline_definitionanyOf<object | null>optioneel——
inline_definition · variant 1objectoptioneel——
inline_definition · variant 2nulloptioneel——
variables_schemaobjectverplicht——
allowed_source_hostsstring[]verplicht——
max_file_size_bytesanyOf<integer | null>optioneel——
max_file_size_bytes · variant 1integeroptioneel——
max_file_size_bytes · variant 2nulloptioneel——
max_credits_per_requestanyOf<string | null>optioneel——
max_credits_per_request · variant 1stringoptioneel——
max_credits_per_request · variant 2nulloptioneel——
max_usesanyOf<integer | null>optioneel——
max_uses · variant 1integeroptioneel——
max_uses · variant 2nulloptioneel——
use_countintegerverplicht——
cache_ttl_secondsintegerverplicht——
enabledbooleanverplicht——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
signing_secretanyOf<string | null>optioneel——
signing_secret · variant 1stringoptioneel——
signing_secret · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
base_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
namestringverplicht——
workflow_idanyOf<string | null>optioneel——
workflow_id · variant 1stringoptioneel——
workflow_id · variant 2nulloptioneel——
workflow_versionanyOf<integer | null>optioneel——
workflow_version · variant 1integeroptioneel——
workflow_version · variant 2nulloptioneel——
inline_definitionanyOf<object | null>optioneel——
inline_definition · variant 1objectoptioneel——
inline_definition · variant 2nulloptioneel——
variables_schemaobjectverplicht——
allowed_source_hostsstring[]verplicht——
max_file_size_bytesanyOf<integer | null>optioneel——
max_file_size_bytes · variant 1integeroptioneel——
max_file_size_bytes · variant 2nulloptioneel——
max_credits_per_requestanyOf<string | null>optioneel——
max_credits_per_request · variant 1stringoptioneel——
max_credits_per_request · variant 2nulloptioneel——
max_usesanyOf<integer | null>optioneel——
max_uses · variant 1integeroptioneel——
max_uses · variant 2nulloptioneel——
use_countintegerverplicht——
cache_ttl_secondsintegerverplicht——
enabledbooleanverplicht——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
signing_secretanyOf<string | null>optioneel——
signing_secret · variant 1stringoptioneel——
signing_secret · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
base_idpathstringverplicht—

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
variablesobjectoptioneel——
expires_inintegeroptioneel—
default: 3600min: 60max: 86400
cache_keyanyOf<string | null>optioneel——
cache_key · variant 1stringoptioneel—
max length: 255
cache_key · variant 2nulloptioneel——

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
urlstringverplicht——
expires_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

AuthenticatieOpenbaar / geen authenticatie voor deze bewerking vereist

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
statusstringverplicht—
enum: "ok", "degraded"
servicestringoptioneel—
default: "converterhq-api"
api_versionstringoptioneel—
default: "v1"
timestampstringverplicht—
format: date-time
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

AuthenticatieOpenbaar / geen authenticatie voor deze bewerking vereist

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
successful_conversionsintegerverplicht——
input_bytes_processedintegerverplicht——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
task_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
job_idstringverplicht——
namestringverplicht——
operationstringverplicht——
statusstringverplicht——
progressintegerverplicht——
inputobjectverplicht——
optionsobjectverplicht——
resultobjectverplicht——
requiredbooleanverplicht——
runtime_classstringverplicht——
prioritystringverplicht——
attempt_countintegerverplicht——
max_attemptsintegerverplicht——
error_codeanyOf<string | null>optioneel——
error_code · variant 1stringoptioneel——
error_code · variant 2nulloptioneel——
error_messageanyOf<string | null>optioneel——
error_message · variant 1stringoptioneel——
error_message · variant 2nulloptioneel——
created_atstringverplicht—
format: date-time
queued_atanyOf<string | null>optioneel——
queued_at · variant 1stringoptioneel—
format: date-time
queued_at · variant 2nulloptioneel——
started_atanyOf<string | null>optioneel——
started_at · variant 1stringoptioneel—
format: date-time
started_at · variant 2nulloptioneel——
completed_atanyOf<string | null>optioneel——
completed_at · variant 1stringoptioneel—
format: date-time
completed_at · variant 2nulloptioneel——
attemptsobject[]optioneel——
attempts[]objectoptioneel——
attempts[].idstringverplicht——
attempts[].attempt_numberintegerverplicht——
attempts[].statusstringverplicht——
attempts[].worker_idanyOf<string | null>optioneel——
attempts[].worker_id · variant 1stringoptioneel——
attempts[].worker_id · variant 2nulloptioneel——
attempts[].runtime_classanyOf<string | null>optioneel——
attempts[].runtime_class · variant 1stringoptioneel——
attempts[].runtime_class · variant 2nulloptioneel——
attempts[].regionanyOf<string | null>optioneel——
attempts[].region · variant 1stringoptioneel——
attempts[].region · variant 2nulloptioneel——
attempts[].engineanyOf<string | null>optioneel——
attempts[].engine · variant 1stringoptioneel——
attempts[].engine · variant 2nulloptioneel——
attempts[].engine_versionanyOf<string | null>optioneel——
attempts[].engine_version · variant 1stringoptioneel——
attempts[].engine_version · variant 2nulloptioneel——
attempts[].input_bytesanyOf<integer | null>optioneel——
attempts[].input_bytes · variant 1integeroptioneel——
attempts[].input_bytes · variant 2nulloptioneel——
attempts[].output_bytesanyOf<integer | null>optioneel——
attempts[].output_bytes · variant 1integeroptioneel——
attempts[].output_bytes · variant 2nulloptioneel——
attempts[].wall_msanyOf<integer | null>optioneel——
attempts[].wall_ms · variant 1integeroptioneel——
attempts[].wall_ms · variant 2nulloptioneel——
attempts[].cpu_msanyOf<integer | null>optioneel——
attempts[].cpu_ms · variant 1integeroptioneel——
attempts[].cpu_ms · variant 2nulloptioneel——
attempts[].peak_memory_mbanyOf<integer | null>optioneel——
attempts[].peak_memory_mb · variant 1integeroptioneel——
attempts[].peak_memory_mb · variant 2nulloptioneel——
attempts[].temp_bytesanyOf<integer | null>optioneel——
attempts[].temp_bytes · variant 1integeroptioneel——
attempts[].temp_bytes · variant 2nulloptioneel——
attempts[].error_codeanyOf<string | null>optioneel——
attempts[].error_code · variant 1stringoptioneel——
attempts[].error_code · variant 2nulloptioneel——
attempts[].error_messageanyOf<string | null>optioneel——
attempts[].error_message · variant 1stringoptioneel——
attempts[].error_message · variant 2nulloptioneel——
attempts[].estimated_creditsanyOf<string | null>optioneel——
attempts[].estimated_credits · variant 1stringoptioneel——
attempts[].estimated_credits · variant 2nulloptioneel——
attempts[].settled_creditsanyOf<string | null>optioneel——
attempts[].settled_credits · variant 1stringoptioneel——
attempts[].settled_credits · variant 2nulloptioneel——
attempts[].external_side_effect_started_atanyOf<string | null>optioneel——
attempts[].external_side_effect_started_at · variant 1stringoptioneel—
format: date-time
attempts[].external_side_effect_started_at · variant 2nulloptioneel——
attempts[].external_side_effect_committed_atanyOf<string | null>optioneel——
attempts[].external_side_effect_committed_at · variant 1stringoptioneel—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nulloptioneel——
attempts[].started_atstringverplicht—
format: date-time
attempts[].completed_atanyOf<string | null>optioneel——
attempts[].completed_at · variant 1stringoptioneel—
format: date-time
attempts[].completed_at · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
task_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
job_idstringverplicht——
namestringverplicht——
operationstringverplicht——
statusstringverplicht——
progressintegerverplicht——
inputobjectverplicht——
optionsobjectverplicht——
resultobjectverplicht——
requiredbooleanverplicht——
runtime_classstringverplicht——
prioritystringverplicht——
attempt_countintegerverplicht——
max_attemptsintegerverplicht——
error_codeanyOf<string | null>optioneel——
error_code · variant 1stringoptioneel——
error_code · variant 2nulloptioneel——
error_messageanyOf<string | null>optioneel——
error_message · variant 1stringoptioneel——
error_message · variant 2nulloptioneel——
created_atstringverplicht—
format: date-time
queued_atanyOf<string | null>optioneel——
queued_at · variant 1stringoptioneel—
format: date-time
queued_at · variant 2nulloptioneel——
started_atanyOf<string | null>optioneel——
started_at · variant 1stringoptioneel—
format: date-time
started_at · variant 2nulloptioneel——
completed_atanyOf<string | null>optioneel——
completed_at · variant 1stringoptioneel—
format: date-time
completed_at · variant 2nulloptioneel——
attemptsobject[]optioneel——
attempts[]objectoptioneel——
attempts[].idstringverplicht——
attempts[].attempt_numberintegerverplicht——
attempts[].statusstringverplicht——
attempts[].worker_idanyOf<string | null>optioneel——
attempts[].worker_id · variant 1stringoptioneel——
attempts[].worker_id · variant 2nulloptioneel——
attempts[].runtime_classanyOf<string | null>optioneel——
attempts[].runtime_class · variant 1stringoptioneel——
attempts[].runtime_class · variant 2nulloptioneel——
attempts[].regionanyOf<string | null>optioneel——
attempts[].region · variant 1stringoptioneel——
attempts[].region · variant 2nulloptioneel——
attempts[].engineanyOf<string | null>optioneel——
attempts[].engine · variant 1stringoptioneel——
attempts[].engine · variant 2nulloptioneel——
attempts[].engine_versionanyOf<string | null>optioneel——
attempts[].engine_version · variant 1stringoptioneel——
attempts[].engine_version · variant 2nulloptioneel——
attempts[].input_bytesanyOf<integer | null>optioneel——
attempts[].input_bytes · variant 1integeroptioneel——
attempts[].input_bytes · variant 2nulloptioneel——
attempts[].output_bytesanyOf<integer | null>optioneel——
attempts[].output_bytes · variant 1integeroptioneel——
attempts[].output_bytes · variant 2nulloptioneel——
attempts[].wall_msanyOf<integer | null>optioneel——
attempts[].wall_ms · variant 1integeroptioneel——
attempts[].wall_ms · variant 2nulloptioneel——
attempts[].cpu_msanyOf<integer | null>optioneel——
attempts[].cpu_ms · variant 1integeroptioneel——
attempts[].cpu_ms · variant 2nulloptioneel——
attempts[].peak_memory_mbanyOf<integer | null>optioneel——
attempts[].peak_memory_mb · variant 1integeroptioneel——
attempts[].peak_memory_mb · variant 2nulloptioneel——
attempts[].temp_bytesanyOf<integer | null>optioneel——
attempts[].temp_bytes · variant 1integeroptioneel——
attempts[].temp_bytes · variant 2nulloptioneel——
attempts[].error_codeanyOf<string | null>optioneel——
attempts[].error_code · variant 1stringoptioneel——
attempts[].error_code · variant 2nulloptioneel——
attempts[].error_messageanyOf<string | null>optioneel——
attempts[].error_message · variant 1stringoptioneel——
attempts[].error_message · variant 2nulloptioneel——
attempts[].estimated_creditsanyOf<string | null>optioneel——
attempts[].estimated_credits · variant 1stringoptioneel——
attempts[].estimated_credits · variant 2nulloptioneel——
attempts[].settled_creditsanyOf<string | null>optioneel——
attempts[].settled_credits · variant 1stringoptioneel——
attempts[].settled_credits · variant 2nulloptioneel——
attempts[].external_side_effect_started_atanyOf<string | null>optioneel——
attempts[].external_side_effect_started_at · variant 1stringoptioneel—
format: date-time
attempts[].external_side_effect_started_at · variant 2nulloptioneel——
attempts[].external_side_effect_committed_atanyOf<string | null>optioneel——
attempts[].external_side_effect_committed_at · variant 1stringoptioneel—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nulloptioneel——
attempts[].started_atstringverplicht—
format: date-time
attempts[].completed_atanyOf<string | null>optioneel——
attempts[].completed_at · variant 1stringoptioneel—
format: date-time
attempts[].completed_at · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
task_idpathstringverplicht—
timeoutqueryintegeroptioneel
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>optioneel—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
bodyunknownverplicht——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
task_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
job_idstringverplicht——
namestringverplicht——
operationstringverplicht——
statusstringverplicht——
progressintegerverplicht——
inputobjectverplicht——
optionsobjectverplicht——
resultobjectverplicht——
requiredbooleanverplicht——
runtime_classstringverplicht——
prioritystringverplicht——
attempt_countintegerverplicht——
max_attemptsintegerverplicht——
error_codeanyOf<string | null>optioneel——
error_code · variant 1stringoptioneel——
error_code · variant 2nulloptioneel——
error_messageanyOf<string | null>optioneel——
error_message · variant 1stringoptioneel——
error_message · variant 2nulloptioneel——
created_atstringverplicht—
format: date-time
queued_atanyOf<string | null>optioneel——
queued_at · variant 1stringoptioneel—
format: date-time
queued_at · variant 2nulloptioneel——
started_atanyOf<string | null>optioneel——
started_at · variant 1stringoptioneel—
format: date-time
started_at · variant 2nulloptioneel——
completed_atanyOf<string | null>optioneel——
completed_at · variant 1stringoptioneel—
format: date-time
completed_at · variant 2nulloptioneel——
attemptsobject[]optioneel——
attempts[]objectoptioneel——
attempts[].idstringverplicht——
attempts[].attempt_numberintegerverplicht——
attempts[].statusstringverplicht——
attempts[].worker_idanyOf<string | null>optioneel——
attempts[].worker_id · variant 1stringoptioneel——
attempts[].worker_id · variant 2nulloptioneel——
attempts[].runtime_classanyOf<string | null>optioneel——
attempts[].runtime_class · variant 1stringoptioneel——
attempts[].runtime_class · variant 2nulloptioneel——
attempts[].regionanyOf<string | null>optioneel——
attempts[].region · variant 1stringoptioneel——
attempts[].region · variant 2nulloptioneel——
attempts[].engineanyOf<string | null>optioneel——
attempts[].engine · variant 1stringoptioneel——
attempts[].engine · variant 2nulloptioneel——
attempts[].engine_versionanyOf<string | null>optioneel——
attempts[].engine_version · variant 1stringoptioneel——
attempts[].engine_version · variant 2nulloptioneel——
attempts[].input_bytesanyOf<integer | null>optioneel——
attempts[].input_bytes · variant 1integeroptioneel——
attempts[].input_bytes · variant 2nulloptioneel——
attempts[].output_bytesanyOf<integer | null>optioneel——
attempts[].output_bytes · variant 1integeroptioneel——
attempts[].output_bytes · variant 2nulloptioneel——
attempts[].wall_msanyOf<integer | null>optioneel——
attempts[].wall_ms · variant 1integeroptioneel——
attempts[].wall_ms · variant 2nulloptioneel——
attempts[].cpu_msanyOf<integer | null>optioneel——
attempts[].cpu_ms · variant 1integeroptioneel——
attempts[].cpu_ms · variant 2nulloptioneel——
attempts[].peak_memory_mbanyOf<integer | null>optioneel——
attempts[].peak_memory_mb · variant 1integeroptioneel——
attempts[].peak_memory_mb · variant 2nulloptioneel——
attempts[].temp_bytesanyOf<integer | null>optioneel——
attempts[].temp_bytes · variant 1integeroptioneel——
attempts[].temp_bytes · variant 2nulloptioneel——
attempts[].error_codeanyOf<string | null>optioneel——
attempts[].error_code · variant 1stringoptioneel——
attempts[].error_code · variant 2nulloptioneel——
attempts[].error_messageanyOf<string | null>optioneel——
attempts[].error_message · variant 1stringoptioneel——
attempts[].error_message · variant 2nulloptioneel——
attempts[].estimated_creditsanyOf<string | null>optioneel——
attempts[].estimated_credits · variant 1stringoptioneel——
attempts[].estimated_credits · variant 2nulloptioneel——
attempts[].settled_creditsanyOf<string | null>optioneel——
attempts[].settled_credits · variant 1stringoptioneel——
attempts[].settled_credits · variant 2nulloptioneel——
attempts[].external_side_effect_started_atanyOf<string | null>optioneel——
attempts[].external_side_effect_started_at · variant 1stringoptioneel—
format: date-time
attempts[].external_side_effect_started_at · variant 2nulloptioneel——
attempts[].external_side_effect_committed_atanyOf<string | null>optioneel——
attempts[].external_side_effect_committed_at · variant 1stringoptioneel—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nulloptioneel——
attempts[].started_atstringverplicht—
format: date-time
attempts[].completed_atanyOf<string | null>optioneel——
attempts[].completed_at · variant 1stringoptioneel—
format: date-time
attempts[].completed_at · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
limitqueryintegeroptioneel
default: 50min: 1max: 200
afterqueryanyOf<string | null>optioneel—
input_formatqueryanyOf<string | null>optioneel—
output_formatqueryanyOf<string | null>optioneel—
originqueryanyOf<string | null>optioneel—
outcomequeryanyOf<string | null>optioneel—
job_idqueryanyOf<string | null>optioneel—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
dataobject[]verplicht——
data[]objectoptioneel——
data[].idstringverplicht——
data[].api_key_idanyOf<string | null>optioneel——
data[].api_key_id · variant 1stringoptioneel——
data[].api_key_id · variant 2nulloptioneel——
data[].originstringverplicht——
data[].outcomestringoptioneel—
default: "succeeded"
data[].job_idanyOf<string | null>optioneel——
data[].job_id · variant 1stringoptioneel——
data[].job_id · variant 2nulloptioneel——
data[].task_idanyOf<string | null>optioneel——
data[].task_id · variant 1stringoptioneel——
data[].task_id · variant 2nulloptioneel——
data[].input_formatanyOf<string | null>optioneel——
data[].input_format · variant 1stringoptioneel——
data[].input_format · variant 2nulloptioneel——
data[].output_formatanyOf<string | null>optioneel——
data[].output_format · variant 1stringoptioneel——
data[].output_format · variant 2nulloptioneel——
data[].engineanyOf<string | null>optioneel——
data[].engine · variant 1stringoptioneel——
data[].engine · variant 2nulloptioneel——
data[].engine_versionanyOf<string | null>optioneel——
data[].engine_version · variant 1stringoptioneel——
data[].engine_version · variant 2nulloptioneel——
data[].runtime_classanyOf<string | null>optioneel——
data[].runtime_class · variant 1stringoptioneel——
data[].runtime_class · variant 2nulloptioneel——
data[].input_bytesanyOf<integer | null>optioneel——
data[].input_bytes · variant 1integeroptioneel——
data[].input_bytes · variant 2nulloptioneel——
data[].output_bytesanyOf<integer | null>optioneel——
data[].output_bytes · variant 1integeroptioneel——
data[].output_bytes · variant 2nulloptioneel——
data[].wall_msanyOf<integer | null>optioneel——
data[].wall_ms · variant 1integeroptioneel——
data[].wall_ms · variant 2nulloptioneel——
data[].creditsanyOf<string | null>optioneel——
data[].credits · variant 1stringoptioneel——
data[].credits · variant 2nulloptioneel——
data[].created_atstringverplicht—
format: date-time
paginationobjectverplicht——
pagination.nextanyOf<string | null>optioneel——
pagination.next · variant 1stringoptioneel——
pagination.next · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
startqueryanyOf<string | null>optioneel—
endqueryanyOf<string | null>optioneel—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
startstringverplicht—
format: date-time
endstringverplicht—
format: date-time
conversionsintegerverplicht——
creditsstringverplicht——
input_bytesintegerverplicht——
output_bytesintegerverplicht——
wall_msintegerverplicht——
by_originobject[]optioneel——
by_origin[]objectoptioneel——
by_origin[].keystringverplicht——
by_origin[].conversionsintegerverplicht——
by_origin[].creditsstringverplicht——
top_pairsobject[]optioneel——
top_pairs[]objectoptioneel——
top_pairs[].keystringverplicht——
top_pairs[].conversionsintegerverplicht——
top_pairs[].creditsstringverplicht——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
delivery_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
webhook_idstringverplicht——
event_idstringverplicht——
statusstringverplicht——
attemptintegerverplicht——
request_headersobjectverplicht——
request_bodyobjectverplicht——
response_statusanyOf<integer | null>optioneel——
response_status · variant 1integeroptioneel——
response_status · variant 2nulloptioneel——
response_bodyanyOf<string | null>optioneel——
response_body · variant 1stringoptioneel——
response_body · variant 2nulloptioneel——
latency_msanyOf<integer | null>optioneel——
latency_ms · variant 1integeroptioneel——
latency_ms · variant 2nulloptioneel——
error_messageanyOf<string | null>optioneel——
error_message · variant 1stringoptioneel——
error_message · variant 2nulloptioneel——
next_retry_atanyOf<string | null>optioneel——
next_retry_at · variant 1stringoptioneel—
format: date-time
next_retry_at · variant 2nulloptioneel——
delivered_atanyOf<string | null>optioneel——
delivered_at · variant 1stringoptioneel—
format: date-time
delivered_at · variant 2nulloptioneel——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
delivery_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
webhook_idstringverplicht——
event_idstringverplicht——
statusstringverplicht——
attemptintegerverplicht——
request_headersobjectverplicht——
request_bodyobjectverplicht——
response_statusanyOf<integer | null>optioneel——
response_status · variant 1integeroptioneel——
response_status · variant 2nulloptioneel——
response_bodyanyOf<string | null>optioneel——
response_body · variant 1stringoptioneel——
response_body · variant 2nulloptioneel——
latency_msanyOf<integer | null>optioneel——
latency_ms · variant 1integeroptioneel——
latency_ms · variant 2nulloptioneel——
error_messageanyOf<string | null>optioneel——
error_message · variant 1stringoptioneel——
error_message · variant 2nulloptioneel——
next_retry_atanyOf<string | null>optioneel——
next_retry_at · variant 1stringoptioneel—
format: date-time
next_retry_at · variant 2nulloptioneel——
delivered_atanyOf<string | null>optioneel——
delivered_at · variant 1stringoptioneel—
format: date-time
delivered_at · variant 2nulloptioneel——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
bodyobject[]verplicht——
items[]objectoptioneel——
items[].idstringverplicht——
items[].urlstringverplicht——
items[].descriptionanyOf<string | null>optioneel——
items[].description · variant 1stringoptioneel——
items[].description · variant 2nulloptioneel——
items[].event_typesstring[]verplicht——
items[].enabledbooleanverplicht——
items[].failure_countintegerverplicht——
items[].created_atstringverplicht—
format: date-time
items[].updated_atstringverplicht—
format: date-time
items[].signing_secretanyOf<string | null>optioneel——
items[].signing_secret · variant 1stringoptioneel——
items[].signing_secret · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
urlstringverplicht—
min length: 1max length: 2048
descriptionanyOf<string | null>optioneel——
description · variant 1stringoptioneel—
max length: 512
description · variant 2nulloptioneel——
event_typesstring[]optioneel——

Responses

201Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
urlstringverplicht——
descriptionanyOf<string | null>optioneel——
description · variant 1stringoptioneel——
description · variant 2nulloptioneel——
event_typesstring[]verplicht——
enabledbooleanverplicht——
failure_countintegerverplicht——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
signing_secretanyOf<string | null>optioneel——
signing_secret · variant 1stringoptioneel——
signing_secret · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
webhook_idpathstringverplicht—

Responses

204Successful Response

Geen response-inhoud.

400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
webhook_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
urlstringverplicht——
descriptionanyOf<string | null>optioneel——
description · variant 1stringoptioneel——
description · variant 2nulloptioneel——
event_typesstring[]verplicht——
enabledbooleanverplicht——
failure_countintegerverplicht——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
signing_secretanyOf<string | null>optioneel——
signing_secret · variant 1stringoptioneel——
signing_secret · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
webhook_idpathstringverplicht—

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
urlanyOf<string | null>optioneel——
url · variant 1stringoptioneel—
min length: 1max length: 2048
url · variant 2nulloptioneel——
descriptionanyOf<string | null>optioneel——
description · variant 1stringoptioneel—
max length: 512
description · variant 2nulloptioneel——
event_typesanyOf<string[] | null>optioneel——
event_types · variant 1string[]optioneel——
event_types · variant 2nulloptioneel——
enabledanyOf<boolean | null>optioneel——
enabled · variant 1booleanoptioneel——
enabled · variant 2nulloptioneel——

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
urlstringverplicht——
descriptionanyOf<string | null>optioneel——
description · variant 1stringoptioneel——
description · variant 2nulloptioneel——
event_typesstring[]verplicht——
enabledbooleanverplicht——
failure_countintegerverplicht——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
signing_secretanyOf<string | null>optioneel——
signing_secret · variant 1stringoptioneel——
signing_secret · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
webhook_idpathstringverplicht—
limitqueryintegeroptioneel
default: 50min: 1max: 100
afterqueryanyOf<string | null>optioneel—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
dataobject[]verplicht——
data[]objectoptioneel——
data[].idstringverplicht——
data[].webhook_idstringverplicht——
data[].event_idstringverplicht——
data[].statusstringverplicht——
data[].attemptintegerverplicht——
data[].request_headersobjectverplicht——
data[].request_bodyobjectverplicht——
data[].response_statusanyOf<integer | null>optioneel——
data[].response_status · variant 1integeroptioneel——
data[].response_status · variant 2nulloptioneel——
data[].response_bodyanyOf<string | null>optioneel——
data[].response_body · variant 1stringoptioneel——
data[].response_body · variant 2nulloptioneel——
data[].latency_msanyOf<integer | null>optioneel——
data[].latency_ms · variant 1integeroptioneel——
data[].latency_ms · variant 2nulloptioneel——
data[].error_messageanyOf<string | null>optioneel——
data[].error_message · variant 1stringoptioneel——
data[].error_message · variant 2nulloptioneel——
data[].next_retry_atanyOf<string | null>optioneel——
data[].next_retry_at · variant 1stringoptioneel—
format: date-time
data[].next_retry_at · variant 2nulloptioneel——
data[].delivered_atanyOf<string | null>optioneel——
data[].delivered_at · variant 1stringoptioneel—
format: date-time
data[].delivered_at · variant 2nulloptioneel——
data[].created_atstringverplicht—
format: date-time
data[].updated_atstringverplicht—
format: date-time
paginationobjectverplicht——
pagination.nextanyOf<string | null>optioneel——
pagination.next · variant 1stringoptioneel——
pagination.next · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
webhook_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
signing_secretstringverplicht——
previous_secret_valid_untilanyOf<string | null>optioneel——
previous_secret_valid_until · variant 1stringoptioneel—
format: date-time
previous_secret_valid_until · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
limitqueryintegeroptioneel
default: 50min: 1max: 200
afterqueryanyOf<string | null>optioneel—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
dataobject[]verplicht——
data[]objectoptioneel——
data[].idstringverplicht——
data[].namestringverplicht——
data[].descriptionanyOf<string | null>optioneel——
data[].description · variant 1stringoptioneel——
data[].description · variant 2nulloptioneel——
data[].current_versionintegerverplicht——
data[].definitionobjectverplicht——
data[].variables_schemaobjectverplicht——
data[].metadataobjectverplicht——
data[].created_atstringverplicht—
format: date-time
data[].updated_atstringverplicht—
format: date-time
paginationobjectverplicht——
pagination.nextanyOf<string | null>optioneel——
pagination.next · variant 1stringoptioneel——
pagination.next · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
namestringverplicht—
min length: 1max length: 255
descriptionanyOf<string | null>optioneel——
description · variant 1stringoptioneel—
max length: 2000
description · variant 2nulloptioneel——
definitionobjectverplicht——
definition.tasksobjectverplicht——
definition.taganyOf<string | null>optioneel——
definition.tag · variant 1stringoptioneel—
max length: 255
definition.tag · variant 2nulloptioneel——
definition.client_reference_idanyOf<string | null>optioneel——
definition.client_reference_id · variant 1stringoptioneel—
max length: 255
definition.client_reference_id · variant 2nulloptioneel——
definition.metadataobjectoptioneel——
definition.prioritystringoptioneel—
enum: "low", "normal", "high"default: "normal"
definition.retention_secondsanyOf<integer | null>optioneel——
definition.retention_seconds · variant 1integeroptioneel—
min: 0max: 86400
definition.retention_seconds · variant 2nulloptioneel——
variables_schemaobjectoptioneel——
metadataobjectoptioneel——

Responses

201Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
namestringverplicht——
descriptionanyOf<string | null>optioneel——
description · variant 1stringoptioneel——
description · variant 2nulloptioneel——
current_versionintegerverplicht——
definitionobjectverplicht——
variables_schemaobjectverplicht——
metadataobjectverplicht——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
workflow_idpathstringverplicht—

Responses

204Successful Response

Geen response-inhoud.

400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
workflow_idpathstringverplicht—

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
namestringverplicht——
descriptionanyOf<string | null>optioneel——
description · variant 1stringoptioneel——
description · variant 2nulloptioneel——
current_versionintegerverplicht——
definitionobjectverplicht——
variables_schemaobjectverplicht——
metadataobjectverplicht——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
workflow_idpathstringverplicht—

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
nameanyOf<string | null>optioneel——
name · variant 1stringoptioneel—
min length: 1max length: 255
name · variant 2nulloptioneel——
descriptionanyOf<string | null>optioneel——
description · variant 1stringoptioneel—
max length: 2000
description · variant 2nulloptioneel——
definitionanyOf<object | null>optioneel——
definition · variant 1objectoptioneel——
definition · variant 1.tasksobjectverplicht——
definition · variant 1.taganyOf<string | null>optioneel——
definition · variant 1.tag · variant 1stringoptioneel—
max length: 255
definition · variant 1.tag · variant 2nulloptioneel——
definition · variant 1.client_reference_idanyOf<string | null>optioneel——
definition · variant 1.client_reference_id · variant 1stringoptioneel—
max length: 255
definition · variant 1.client_reference_id · variant 2nulloptioneel——
definition · variant 1.metadataobjectoptioneel——
definition · variant 1.prioritystringoptioneel—
enum: "low", "normal", "high"default: "normal"
definition · variant 1.retention_secondsanyOf<integer | null>optioneel——
definition · variant 1.retention_seconds · variant 1integeroptioneel—
min: 0max: 86400
definition · variant 1.retention_seconds · variant 2nulloptioneel——
definition · variant 2nulloptioneel——
variables_schemaanyOf<object | null>optioneel——
variables_schema · variant 1objectoptioneel——
variables_schema · variant 2nulloptioneel——
metadataanyOf<object | null>optioneel——
metadata · variant 1objectoptioneel——
metadata · variant 2nulloptioneel——

Responses

200Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
namestringverplicht——
descriptionanyOf<string | null>optioneel——
description · variant 1stringoptioneel——
description · variant 2nulloptioneel——
current_versionintegerverplicht——
definitionobjectverplicht——
variables_schemaobjectverplicht——
metadataobjectverplicht——
created_atstringverplicht—
format: date-time
updated_atstringverplicht—
format: date-time
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
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.

Authenticatie
ConverterHQBearerhttp / bearer

Parameters

NaamLocatieTypeVerplichtBeschrijving / beperkingen
workflow_idpathstringverplicht—
Idempotency-KeyheaderanyOf<string | null>optioneel—

Verzoekinhoud verplicht

application/json
VeldTypeVerplichtBeschrijvingBeperkingen
variablesobjectoptioneel——
client_reference_idanyOf<string | null>optioneel——
client_reference_id · variant 1stringoptioneel—
max length: 255
client_reference_id · variant 2nulloptioneel——
metadataobjectoptioneel——

Responses

201Successful Response
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
idstringverplicht——
kindstringverplicht——
statusstringverplicht——
progressintegerverplicht——
taganyOf<string | null>optioneel——
tag · variant 1stringoptioneel——
tag · variant 2nulloptioneel——
client_reference_idanyOf<string | null>optioneel——
client_reference_id · variant 1stringoptioneel——
client_reference_id · variant 2nulloptioneel——
metadataobjectoptioneel——
prioritystringverplicht——
concurrency_limitintegeroptioneel—
default: 1
originstringverplicht——
created_atstringverplicht—
format: date-time
started_atanyOf<string | null>optioneel——
started_at · variant 1stringoptioneel—
format: date-time
started_at · variant 2nulloptioneel——
completed_atanyOf<string | null>optioneel——
completed_at · variant 1stringoptioneel—
format: date-time
completed_at · variant 2nulloptioneel——
error_codeanyOf<string | null>optioneel——
error_code · variant 1stringoptioneel——
error_code · variant 2nulloptioneel——
error_messageanyOf<string | null>optioneel——
error_message · variant 1stringoptioneel——
error_message · variant 2nulloptioneel——
tasksobject[]optioneel——
tasks[]objectoptioneel——
tasks[].idstringverplicht——
tasks[].job_idstringverplicht——
tasks[].namestringverplicht——
tasks[].operationstringverplicht——
tasks[].statusstringverplicht——
tasks[].progressintegerverplicht——
tasks[].inputobjectverplicht——
tasks[].optionsobjectverplicht——
tasks[].resultobjectverplicht——
tasks[].requiredbooleanverplicht——
tasks[].runtime_classstringverplicht——
tasks[].prioritystringverplicht——
tasks[].attempt_countintegerverplicht——
tasks[].max_attemptsintegerverplicht——
tasks[].error_codeanyOf<string | null>optioneel——
tasks[].error_code · variant 1stringoptioneel——
tasks[].error_code · variant 2nulloptioneel——
tasks[].error_messageanyOf<string | null>optioneel——
tasks[].error_message · variant 1stringoptioneel——
tasks[].error_message · variant 2nulloptioneel——
tasks[].created_atstringverplicht—
format: date-time
tasks[].queued_atanyOf<string | null>optioneel——
tasks[].queued_at · variant 1stringoptioneel—
format: date-time
tasks[].queued_at · variant 2nulloptioneel——
tasks[].started_atanyOf<string | null>optioneel——
tasks[].started_at · variant 1stringoptioneel—
format: date-time
tasks[].started_at · variant 2nulloptioneel——
tasks[].completed_atanyOf<string | null>optioneel——
tasks[].completed_at · variant 1stringoptioneel—
format: date-time
tasks[].completed_at · variant 2nulloptioneel——
tasks[].attemptsobject[]optioneel——
tasks[].attempts[]objectoptioneel——
tasks[].attempts[].idstringverplicht——
tasks[].attempts[].attempt_numberintegerverplicht——
tasks[].attempts[].statusstringverplicht——
tasks[].attempts[].worker_idanyOf<string | null>optioneel——
tasks[].attempts[].worker_id · variant 1stringoptioneel——
tasks[].attempts[].worker_id · variant 2nulloptioneel——
tasks[].attempts[].runtime_classanyOf<string | null>optioneel——
tasks[].attempts[].runtime_class · variant 1stringoptioneel——
tasks[].attempts[].runtime_class · variant 2nulloptioneel——
tasks[].attempts[].regionanyOf<string | null>optioneel——
tasks[].attempts[].region · variant 1stringoptioneel——
tasks[].attempts[].region · variant 2nulloptioneel——
tasks[].attempts[].engineanyOf<string | null>optioneel——
tasks[].attempts[].engine · variant 1stringoptioneel——
tasks[].attempts[].engine · variant 2nulloptioneel——
tasks[].attempts[].engine_versionanyOf<string | null>optioneel——
tasks[].attempts[].engine_version · variant 1stringoptioneel——
tasks[].attempts[].engine_version · variant 2nulloptioneel——
tasks[].attempts[].input_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].input_bytes · variant 1integeroptioneel——
tasks[].attempts[].input_bytes · variant 2nulloptioneel——
tasks[].attempts[].output_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].output_bytes · variant 1integeroptioneel——
tasks[].attempts[].output_bytes · variant 2nulloptioneel——
tasks[].attempts[].wall_msanyOf<integer | null>optioneel——
tasks[].attempts[].wall_ms · variant 1integeroptioneel——
tasks[].attempts[].wall_ms · variant 2nulloptioneel——
tasks[].attempts[].cpu_msanyOf<integer | null>optioneel——
tasks[].attempts[].cpu_ms · variant 1integeroptioneel——
tasks[].attempts[].cpu_ms · variant 2nulloptioneel——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>optioneel——
tasks[].attempts[].peak_memory_mb · variant 1integeroptioneel——
tasks[].attempts[].peak_memory_mb · variant 2nulloptioneel——
tasks[].attempts[].temp_bytesanyOf<integer | null>optioneel——
tasks[].attempts[].temp_bytes · variant 1integeroptioneel——
tasks[].attempts[].temp_bytes · variant 2nulloptioneel——
tasks[].attempts[].error_codeanyOf<string | null>optioneel——
tasks[].attempts[].error_code · variant 1stringoptioneel——
tasks[].attempts[].error_code · variant 2nulloptioneel——
tasks[].attempts[].error_messageanyOf<string | null>optioneel——
tasks[].attempts[].error_message · variant 1stringoptioneel——
tasks[].attempts[].error_message · variant 2nulloptioneel——
tasks[].attempts[].estimated_creditsanyOf<string | null>optioneel——
tasks[].attempts[].estimated_credits · variant 1stringoptioneel——
tasks[].attempts[].estimated_credits · variant 2nulloptioneel——
tasks[].attempts[].settled_creditsanyOf<string | null>optioneel——
tasks[].attempts[].settled_credits · variant 1stringoptioneel——
tasks[].attempts[].settled_credits · variant 2nulloptioneel——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optioneel——
tasks[].attempts[].external_side_effect_started_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nulloptioneel——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optioneel——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptioneel——
tasks[].attempts[].started_atstringverplicht—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>optioneel——
tasks[].attempts[].completed_at · variant 1stringoptioneel—
format: date-time
tasks[].attempts[].completed_at · variant 2nulloptioneel——
400The request could not be processed.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
401Authentication is missing or invalid.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
403The principal is not allowed to perform this operation.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
409The request conflicts with the current resource or idempotency state.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
422Validation Error
application/json
VeldTypeVerplichtBeschrijvingBeperkingen
detailobject[]optioneel——
detail[]objectoptioneel——
detail[].locanyOf<string | integer>[]verplicht——
detail[].loc[]anyOf<string | integer>optioneel——
detail[].loc[] · variant 1stringoptioneel——
detail[].loc[] · variant 2integeroptioneel——
detail[].msgstringverplicht——
detail[].typestringverplicht——
429The caller has exceeded an admission-control limit.
ResponseheadersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
500An unexpected server error occurred.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——
503A required service is temporarily unavailable.
application/problem+json
VeldTypeVerplichtBeschrijvingBeperkingen
typestringverplicht—
default: "about:blank"
titlestringverplicht——
statusintegerverplicht—
min: 400max: 599
codestringverplicht——
detailstringverplicht——
retryablebooleanverplicht——
parameteranyOf<string | null>optioneel——
parameter · variant 1stringoptioneel——
parameter · variant 2nulloptioneel——
request_idanyOf<string | null>optioneel——
request_id · variant 1stringoptioneel——
request_id · variant 2nulloptioneel——