ConverterHQDevelopers
Generated from the curated public OpenAPI contract

REST API Reference

Inspect endpoint parameters, authentication, nested request fields, response schemas, errors and executable examples. Consumer, SEO and administration routes are excluded from this contract.

74 endpoints shown74 total operations17 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.

AuthenticationPublic / no operation-level security requirement

Parameters

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

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
dataobject[]required——
data[]objectoptional——
data[].supportedbooleanrequired——
data[].input_formatstringrequired——
data[].output_formatstringrequired——
data[].maturitystringoptional—
enum: "stable", "disabled"default: "stable"
data[].settings_scopestringoptionalSettings 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[].routeobjectoptional——
data[].route.multi_stepbooleanoptionalTrue 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[]optionalSetting 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>optionalStable 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 1stringoptional——
data[].options_version · variant 2nulloptional——
data[].optionsobject[]optionalSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
data[].options[]objectoptional——
data[].options[].namestringrequired——
data[].options[].typestringrequired——
data[].options[].labelstringrequired——
data[].options[].descriptionanyOf<string | null>optional——
data[].options[].description · variant 1stringoptional——
data[].options[].description · variant 2nulloptional——
data[].options[].requiredbooleanoptional—
default: false
data[].options[].advancedbooleanoptional—
default: false
data[].options[].groupanyOf<string | null>optional——
data[].options[].group · variant 1stringoptional——
data[].options[].group · variant 2nulloptional——
data[].options[].defaultunknownoptional——
data[].options[].possible_valuesanyOf<unknown[] | null>optional——
data[].options[].possible_values · variant 1unknown[]optional——
data[].options[].possible_values · variant 2nulloptional——
data[].options[].minimumanyOf<integer | number | null>optional——
data[].options[].minimum · variant 1integeroptional——
data[].options[].minimum · variant 2numberoptional——
data[].options[].minimum · variant 3nulloptional——
data[].options[].maximumanyOf<integer | number | null>optional——
data[].options[].maximum · variant 1integeroptional——
data[].options[].maximum · variant 2numberoptional——
data[].options[].maximum · variant 3nulloptional——
data[].options[].depends_onobject[]optional——
data[].options[].conflicts_withstring[]optional——
data[].options[].schemaanyOf<object | null>optional——
data[].options[].schema · variant 1objectoptional——
data[].options[].schema · variant 2nulloptional——
data[].options_schemaobjectoptionalStrict JSON Schema for the settings accepted by this pair-level conversion task.—
data[].limitsobjectoptional——
data[].billingobjectoptional——
paginationobjectrequired——
pagination.nextanyOf<string | null>optional——
pagination.next · variant 1stringoptional——
pagination.next · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

AuthenticationPublic / no operation-level security requirement

Parameters

NameLocationTypeRequiredDescription / constraints
from_formatpathstringrequired—
to_formatpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
supportedbooleanrequired——
input_formatstringrequired——
output_formatstringrequired——
maturitystringoptional—
enum: "stable", "disabled"default: "stable"
settings_scopestringoptionalSettings 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"
routeobjectoptional——
route.multi_stepbooleanoptionalTrue 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[]optionalSetting 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>optionalStable 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 1stringoptional——
options_version · variant 2nulloptional——
optionsobject[]optionalSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
options[]objectoptional——
options[].namestringrequired——
options[].typestringrequired——
options[].labelstringrequired——
options[].descriptionanyOf<string | null>optional——
options[].description · variant 1stringoptional——
options[].description · variant 2nulloptional——
options[].requiredbooleanoptional—
default: false
options[].advancedbooleanoptional—
default: false
options[].groupanyOf<string | null>optional——
options[].group · variant 1stringoptional——
options[].group · variant 2nulloptional——
options[].defaultunknownoptional——
options[].possible_valuesanyOf<unknown[] | null>optional——
options[].possible_values · variant 1unknown[]optional——
options[].possible_values · variant 2nulloptional——
options[].minimumanyOf<integer | number | null>optional——
options[].minimum · variant 1integeroptional——
options[].minimum · variant 2numberoptional——
options[].minimum · variant 3nulloptional——
options[].maximumanyOf<integer | number | null>optional——
options[].maximum · variant 1integeroptional——
options[].maximum · variant 2numberoptional——
options[].maximum · variant 3nulloptional——
options[].depends_onobject[]optional——
options[].conflicts_withstring[]optional——
options[].schemaanyOf<object | null>optional——
options[].schema · variant 1objectoptional——
options[].schema · variant 2nulloptional——
options_schemaobjectoptionalStrict JSON Schema for the settings accepted by this pair-level conversion task.—
limitsobjectoptional——
billingobjectoptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
account_idstringrequired——
productstringrequired——
api_enabledbooleanrequired——
plansstring[]required——
effective_planobjectrequired——
effective_plan.codestringrequired——
effective_plan.namestringrequired——
effective_plan.familyanyOf<string | null>optional——
effective_plan.family · variant 1stringoptional——
effective_plan.family · variant 2nulloptional——
effective_plan.billing_intervalanyOf<string | null>optional——
effective_plan.billing_interval · variant 1stringoptional——
effective_plan.billing_interval · variant 2nulloptional——
creditsobjectrequired——
credits.availablestringrequired——
credits.reservedstringrequired——
credits.debtstringrequired——
quotaanyOf<object | null>optional——
quota · variant 1objectoptional——
quota · variant 1.keystringrequired——
quota · variant 1.periodstringrequired——
quota · variant 1.period_keystringrequired——
quota · variant 1.limitstringrequired——
quota · variant 1.usedstringrequired——
quota · variant 1.remainingstringrequired——
quota · variant 1.period_startstringrequired—
format: date-time
quota · variant 1.period_endstringrequired—
format: date-time
quota · variant 2nulloptional——
subscriptionsobject[]required——
subscriptions[]objectoptional——
subscriptions[].idstringrequired——
subscriptions[].planstringrequired——
subscriptions[].statusstringrequired——
subscriptions[].billing_intervalanyOf<string | null>optional——
subscriptions[].billing_interval · variant 1stringoptional——
subscriptions[].billing_interval · variant 2nulloptional——
subscriptions[].current_period_startanyOf<string | null>optional——
subscriptions[].current_period_start · variant 1stringoptional—
format: date-time
subscriptions[].current_period_start · variant 2nulloptional——
subscriptions[].current_period_endanyOf<string | null>optional——
subscriptions[].current_period_end · variant 1stringoptional—
format: date-time
subscriptions[].current_period_end · variant 2nulloptional——
subscriptions[].next_billed_atanyOf<string | null>optional——
subscriptions[].next_billed_at · variant 1stringoptional—
format: date-time
subscriptions[].next_billed_at · variant 2nulloptional——
passesobject[]required——
passes[]objectoptional——
passes[].idstringrequired——
passes[].offerstringrequired——
passes[].planstringrequired——
passes[].starts_atstringrequired—
format: date-time
passes[].expires_atstringrequired—
format: date-time
generated_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
limitqueryintegeroptional
default: 50min: 1max: 200
afterqueryanyOf<string | null>optional—
providerqueryanyOf<string | null>optional—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
dataobject[]required——
data[]objectoptional——
data[].idstringrequired——
data[].namestringrequired——
data[].providerstringrequired—
enum: "s3", "gcs", "azure", "sftp"
data[].config_summaryobjectrequired——
data[].enabledbooleanrequired——
data[].created_atstringrequired—
format: date-time
data[].updated_atstringrequired—
format: date-time
paginationobjectrequired——
pagination.nextanyOf<string | null>optional——
pagination.next · variant 1stringoptional——
pagination.next · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
namestringrequired—
min length: 1max length: 255
providerstringrequired—
enum: "s3", "gcs", "azure", "sftp"
configobjectrequired——

Responses

201Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
namestringrequired——
providerstringrequired—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectrequired——
enabledbooleanrequired——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
connection_idpathstringrequired—

Responses

204Successful Response

No response body.

400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
connection_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
namestringrequired——
providerstringrequired—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectrequired——
enabledbooleanrequired——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
connection_idpathstringrequired—

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
nameanyOf<string | null>optional——
name · variant 1stringoptional—
min length: 1max length: 255
name · variant 2nulloptional——
configanyOf<object | null>optional——
config · variant 1objectoptional——
config · variant 2nulloptional——
enabledanyOf<boolean | null>optional——
enabled · variant 1booleanoptional——
enabled · variant 2nulloptional——

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
namestringrequired——
providerstringrequired—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectrequired——
enabledbooleanrequired——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
connection_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
okbooleanrequired——
providerstringrequired——
detailsobjectoptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
PreferheaderanyOf<string | null>optional—
Idempotency-KeyheaderanyOf<string | null>optional—

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
inputobjectrequired——
input.file_idanyOf<string | null>optional—
default: null
input.file_id · variant 1stringoptional——
input.file_id · variant 2nulloptional——
input.urlanyOf<string | null>optional—
default: null
input.url · variant 1stringoptional——
input.url · variant 2nulloptional——
input_formatanyOf<string | null>optional—
default: null
input_format · variant 1stringoptional——
input_format · variant 2nulloptional——
output_formatstringrequired—
min length: 1max length: 64
optionsobjectoptional——
filenameanyOf<string | null>optional—
default: null
filename · variant 1stringoptional—
max length: 512
filename · variant 2nulloptional——
metadataobjectoptional——
client_reference_idanyOf<string | null>optional—
default: null
client_reference_id · variant 1stringoptional—
max length: 255
client_reference_id · variant 2nulloptional——
retention_secondsanyOf<integer | null>optional—
default: null
retention_seconds · variant 1integeroptional—
min: 0max: 86400
retention_seconds · variant 2nulloptional——
multipart/form-data
FieldTypeRequiredDescriptionConstraints
filestringrequiredInput file, up to 4 MiB.
format: binary
input_formatstringoptionalOptional source format when it cannot be detected.—
output_formatstringrequiredRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringoptionalJSON object containing pair-specific conversion options.—
metadatastringoptionalJSON object copied to the created Job.—
filenamestringoptionalOptional output filename hint.—
client_reference_idstringoptionalOptional caller-defined reference.—
retention_secondsintegeroptional—
min: 0max: 86400

Responses

200Conversion completed within the requested wait window.
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
job_idstringrequired——
statusstringrequired——
progressintegerrequired——
input_formatanyOf<string | null>optional——
input_format · variant 1stringoptional——
input_format · variant 2nulloptional——
output_formatstringrequired——
output_fileanyOf<object | null>optional——
output_file · variant 1objectoptional——
output_file · variant 1.idstringrequired——
output_file · variant 1.statusstringrequired——
output_file · variant 1.rolestringrequired——
output_file · variant 1.filenamestringrequired——
output_file · variant 1.content_typeanyOf<string | null>optional——
output_file · variant 1.content_type · variant 1stringoptional——
output_file · variant 1.content_type · variant 2nulloptional——
output_file · variant 1.detected_content_typeanyOf<string | null>optional——
output_file · variant 1.detected_content_type · variant 1stringoptional——
output_file · variant 1.detected_content_type · variant 2nulloptional——
output_file · variant 1.detected_formatanyOf<string | null>optional——
output_file · variant 1.detected_format · variant 1stringoptional——
output_file · variant 1.detected_format · variant 2nulloptional——
output_file · variant 1.size_bytesanyOf<integer | null>optional——
output_file · variant 1.size_bytes · variant 1integeroptional——
output_file · variant 1.size_bytes · variant 2nulloptional——
output_file · variant 1.checksum_sha256anyOf<string | null>optional——
output_file · variant 1.checksum_sha256 · variant 1stringoptional——
output_file · variant 1.checksum_sha256 · variant 2nulloptional——
output_file · variant 1.source_typestringrequired——
output_file · variant 1.created_atstringrequired—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>optional——
output_file · variant 1.ready_at · variant 1stringoptional—
format: date-time
output_file · variant 1.ready_at · variant 2nulloptional——
output_file · variant 1.expires_atanyOf<string | null>optional——
output_file · variant 1.expires_at · variant 1stringoptional—
format: date-time
output_file · variant 1.expires_at · variant 2nulloptional——
output_file · variant 1.metadataobjectoptional——
output_file · variant 1.uploadanyOf<object | null>optional——
output_file · variant 1.upload · variant 1objectoptional——
output_file · variant 1.upload · variant 1.methodstringoptional—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringrequired——
output_file · variant 1.upload · variant 1.expires_atstringrequired—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectoptional——
output_file · variant 1.upload · variant 2nulloptional——
output_file · variant 1.download_urlanyOf<string | null>optional——
output_file · variant 1.download_url · variant 1stringoptional——
output_file · variant 1.download_url · variant 2nulloptional——
output_file · variant 1.download_expires_atanyOf<string | null>optional——
output_file · variant 1.download_expires_at · variant 1stringoptional—
format: date-time
output_file · variant 1.download_expires_at · variant 2nulloptional——
output_file · variant 2nulloptional——
created_atstringrequired—
format: date-time
202Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
job_idstringrequired——
statusstringrequired——
progressintegerrequired——
input_formatanyOf<string | null>optional——
input_format · variant 1stringoptional——
input_format · variant 2nulloptional——
output_formatstringrequired——
output_fileanyOf<object | null>optional——
output_file · variant 1objectoptional——
output_file · variant 1.idstringrequired——
output_file · variant 1.statusstringrequired——
output_file · variant 1.rolestringrequired——
output_file · variant 1.filenamestringrequired——
output_file · variant 1.content_typeanyOf<string | null>optional——
output_file · variant 1.content_type · variant 1stringoptional——
output_file · variant 1.content_type · variant 2nulloptional——
output_file · variant 1.detected_content_typeanyOf<string | null>optional——
output_file · variant 1.detected_content_type · variant 1stringoptional——
output_file · variant 1.detected_content_type · variant 2nulloptional——
output_file · variant 1.detected_formatanyOf<string | null>optional——
output_file · variant 1.detected_format · variant 1stringoptional——
output_file · variant 1.detected_format · variant 2nulloptional——
output_file · variant 1.size_bytesanyOf<integer | null>optional——
output_file · variant 1.size_bytes · variant 1integeroptional——
output_file · variant 1.size_bytes · variant 2nulloptional——
output_file · variant 1.checksum_sha256anyOf<string | null>optional——
output_file · variant 1.checksum_sha256 · variant 1stringoptional——
output_file · variant 1.checksum_sha256 · variant 2nulloptional——
output_file · variant 1.source_typestringrequired——
output_file · variant 1.created_atstringrequired—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>optional——
output_file · variant 1.ready_at · variant 1stringoptional—
format: date-time
output_file · variant 1.ready_at · variant 2nulloptional——
output_file · variant 1.expires_atanyOf<string | null>optional——
output_file · variant 1.expires_at · variant 1stringoptional—
format: date-time
output_file · variant 1.expires_at · variant 2nulloptional——
output_file · variant 1.metadataobjectoptional——
output_file · variant 1.uploadanyOf<object | null>optional——
output_file · variant 1.upload · variant 1objectoptional——
output_file · variant 1.upload · variant 1.methodstringoptional—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringrequired——
output_file · variant 1.upload · variant 1.expires_atstringrequired—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectoptional——
output_file · variant 1.upload · variant 2nulloptional——
output_file · variant 1.download_urlanyOf<string | null>optional——
output_file · variant 1.download_url · variant 1stringoptional——
output_file · variant 1.download_url · variant 2nulloptional——
output_file · variant 1.download_expires_atanyOf<string | null>optional——
output_file · variant 1.download_expires_at · variant 1stringoptional—
format: date-time
output_file · variant 1.download_expires_at · variant 2nulloptional——
output_file · variant 2nulloptional——
created_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
from_formatpathstringrequired—
to_formatpathstringrequired—
PreferheaderanyOf<string | null>optional—
Idempotency-KeyheaderanyOf<string | null>optional—

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
inputobjectrequired——
input.file_idanyOf<string | null>optional—
default: null
input.file_id · variant 1stringoptional——
input.file_id · variant 2nulloptional——
input.urlanyOf<string | null>optional—
default: null
input.url · variant 1stringoptional——
input.url · variant 2nulloptional——
input_formatanyOf<string | null>optional—
default: null
input_format · variant 1stringoptional——
input_format · variant 2nulloptional——
output_formatstringrequired—
min length: 1max length: 64
optionsobjectoptional——
filenameanyOf<string | null>optional—
default: null
filename · variant 1stringoptional—
max length: 512
filename · variant 2nulloptional——
metadataobjectoptional——
client_reference_idanyOf<string | null>optional—
default: null
client_reference_id · variant 1stringoptional—
max length: 255
client_reference_id · variant 2nulloptional——
retention_secondsanyOf<integer | null>optional—
default: null
retention_seconds · variant 1integeroptional—
min: 0max: 86400
retention_seconds · variant 2nulloptional——
multipart/form-data
FieldTypeRequiredDescriptionConstraints
filestringrequiredInput file, up to 4 MiB.
format: binary
input_formatstringoptionalOptional source format when it cannot be detected.—
output_formatstringoptionalRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringoptionalJSON object containing pair-specific conversion options.—
metadatastringoptionalJSON object copied to the created Job.—
filenamestringoptionalOptional output filename hint.—
client_reference_idstringoptionalOptional caller-defined reference.—
retention_secondsintegeroptional—
min: 0max: 86400

Responses

200Conversion completed within the requested wait window.
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
job_idstringrequired——
statusstringrequired——
progressintegerrequired——
input_formatanyOf<string | null>optional——
input_format · variant 1stringoptional——
input_format · variant 2nulloptional——
output_formatstringrequired——
output_fileanyOf<object | null>optional——
output_file · variant 1objectoptional——
output_file · variant 1.idstringrequired——
output_file · variant 1.statusstringrequired——
output_file · variant 1.rolestringrequired——
output_file · variant 1.filenamestringrequired——
output_file · variant 1.content_typeanyOf<string | null>optional——
output_file · variant 1.content_type · variant 1stringoptional——
output_file · variant 1.content_type · variant 2nulloptional——
output_file · variant 1.detected_content_typeanyOf<string | null>optional——
output_file · variant 1.detected_content_type · variant 1stringoptional——
output_file · variant 1.detected_content_type · variant 2nulloptional——
output_file · variant 1.detected_formatanyOf<string | null>optional——
output_file · variant 1.detected_format · variant 1stringoptional——
output_file · variant 1.detected_format · variant 2nulloptional——
output_file · variant 1.size_bytesanyOf<integer | null>optional——
output_file · variant 1.size_bytes · variant 1integeroptional——
output_file · variant 1.size_bytes · variant 2nulloptional——
output_file · variant 1.checksum_sha256anyOf<string | null>optional——
output_file · variant 1.checksum_sha256 · variant 1stringoptional——
output_file · variant 1.checksum_sha256 · variant 2nulloptional——
output_file · variant 1.source_typestringrequired——
output_file · variant 1.created_atstringrequired—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>optional——
output_file · variant 1.ready_at · variant 1stringoptional—
format: date-time
output_file · variant 1.ready_at · variant 2nulloptional——
output_file · variant 1.expires_atanyOf<string | null>optional——
output_file · variant 1.expires_at · variant 1stringoptional—
format: date-time
output_file · variant 1.expires_at · variant 2nulloptional——
output_file · variant 1.metadataobjectoptional——
output_file · variant 1.uploadanyOf<object | null>optional——
output_file · variant 1.upload · variant 1objectoptional——
output_file · variant 1.upload · variant 1.methodstringoptional—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringrequired——
output_file · variant 1.upload · variant 1.expires_atstringrequired—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectoptional——
output_file · variant 1.upload · variant 2nulloptional——
output_file · variant 1.download_urlanyOf<string | null>optional——
output_file · variant 1.download_url · variant 1stringoptional——
output_file · variant 1.download_url · variant 2nulloptional——
output_file · variant 1.download_expires_atanyOf<string | null>optional——
output_file · variant 1.download_expires_at · variant 1stringoptional—
format: date-time
output_file · variant 1.download_expires_at · variant 2nulloptional——
output_file · variant 2nulloptional——
created_atstringrequired—
format: date-time
202Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
job_idstringrequired——
statusstringrequired——
progressintegerrequired——
input_formatanyOf<string | null>optional——
input_format · variant 1stringoptional——
input_format · variant 2nulloptional——
output_formatstringrequired——
output_fileanyOf<object | null>optional——
output_file · variant 1objectoptional——
output_file · variant 1.idstringrequired——
output_file · variant 1.statusstringrequired——
output_file · variant 1.rolestringrequired——
output_file · variant 1.filenamestringrequired——
output_file · variant 1.content_typeanyOf<string | null>optional——
output_file · variant 1.content_type · variant 1stringoptional——
output_file · variant 1.content_type · variant 2nulloptional——
output_file · variant 1.detected_content_typeanyOf<string | null>optional——
output_file · variant 1.detected_content_type · variant 1stringoptional——
output_file · variant 1.detected_content_type · variant 2nulloptional——
output_file · variant 1.detected_formatanyOf<string | null>optional——
output_file · variant 1.detected_format · variant 1stringoptional——
output_file · variant 1.detected_format · variant 2nulloptional——
output_file · variant 1.size_bytesanyOf<integer | null>optional——
output_file · variant 1.size_bytes · variant 1integeroptional——
output_file · variant 1.size_bytes · variant 2nulloptional——
output_file · variant 1.checksum_sha256anyOf<string | null>optional——
output_file · variant 1.checksum_sha256 · variant 1stringoptional——
output_file · variant 1.checksum_sha256 · variant 2nulloptional——
output_file · variant 1.source_typestringrequired——
output_file · variant 1.created_atstringrequired—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>optional——
output_file · variant 1.ready_at · variant 1stringoptional—
format: date-time
output_file · variant 1.ready_at · variant 2nulloptional——
output_file · variant 1.expires_atanyOf<string | null>optional——
output_file · variant 1.expires_at · variant 1stringoptional—
format: date-time
output_file · variant 1.expires_at · variant 2nulloptional——
output_file · variant 1.metadataobjectoptional——
output_file · variant 1.uploadanyOf<object | null>optional——
output_file · variant 1.upload · variant 1objectoptional——
output_file · variant 1.upload · variant 1.methodstringoptional—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringrequired——
output_file · variant 1.upload · variant 1.expires_atstringrequired—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectoptional——
output_file · variant 1.upload · variant 2nulloptional——
output_file · variant 1.download_urlanyOf<string | null>optional——
output_file · variant 1.download_url · variant 1stringoptional——
output_file · variant 1.download_url · variant 2nulloptional——
output_file · variant 1.download_expires_atanyOf<string | null>optional——
output_file · variant 1.download_expires_at · variant 1stringoptional—
format: date-time
output_file · variant 1.download_expires_at · variant 2nulloptional——
output_file · variant 2nulloptional——
created_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
input_formatstringrequired——
output_formatstringrequired——
size_bytesanyOf<integer | null>optional——
size_bytes · variant 1integeroptional—
min: 0
size_bytes · variant 2nulloptional——
page_countanyOf<integer | null>optional——
page_count · variant 1integeroptional—
min: 0
page_count · variant 2nulloptional——
duration_secondsanyOf<number | null>optional——
duration_seconds · variant 1numberoptional—
min: 0
duration_seconds · variant 2nulloptional——
optionsobjectoptional——

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
supportedbooleanrequired——
recommended_modestringrequired—
enum: "sync", "async"
creditsobjectrequired——
warningsstring[]optional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
GET/v1/event-typesEvent TypesDiscovery#

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

AuthenticationPublic / no operation-level security requirement

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
dataobject[]required——
data[]objectoptional——
data[].typestringrequired——
data[].descriptionstringrequired——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
limitqueryintegeroptional
default: 50min: 1max: 200
afterqueryanyOf<string | null>optional—
statusqueryanyOf<string | null>optional—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
dataobject[]required——
data[]objectoptional——
data[].idstringrequired——
data[].statusstringrequired——
data[].rolestringrequired——
data[].filenamestringrequired——
data[].content_typeanyOf<string | null>optional——
data[].content_type · variant 1stringoptional——
data[].content_type · variant 2nulloptional——
data[].detected_content_typeanyOf<string | null>optional——
data[].detected_content_type · variant 1stringoptional——
data[].detected_content_type · variant 2nulloptional——
data[].detected_formatanyOf<string | null>optional——
data[].detected_format · variant 1stringoptional——
data[].detected_format · variant 2nulloptional——
data[].size_bytesanyOf<integer | null>optional——
data[].size_bytes · variant 1integeroptional——
data[].size_bytes · variant 2nulloptional——
data[].checksum_sha256anyOf<string | null>optional——
data[].checksum_sha256 · variant 1stringoptional——
data[].checksum_sha256 · variant 2nulloptional——
data[].source_typestringrequired——
data[].created_atstringrequired—
format: date-time
data[].ready_atanyOf<string | null>optional——
data[].ready_at · variant 1stringoptional—
format: date-time
data[].ready_at · variant 2nulloptional——
data[].expires_atanyOf<string | null>optional——
data[].expires_at · variant 1stringoptional—
format: date-time
data[].expires_at · variant 2nulloptional——
data[].metadataobjectoptional——
data[].uploadanyOf<object | null>optional——
data[].upload · variant 1objectoptional——
data[].upload · variant 1.methodstringoptional—
default: "PUT"
data[].upload · variant 1.urlstringrequired——
data[].upload · variant 1.expires_atstringrequired—
format: date-time
data[].upload · variant 1.headersobjectoptional——
data[].upload · variant 2nulloptional——
data[].download_urlanyOf<string | null>optional——
data[].download_url · variant 1stringoptional——
data[].download_url · variant 2nulloptional——
data[].download_expires_atanyOf<string | null>optional——
data[].download_expires_at · variant 1stringoptional—
format: date-time
data[].download_expires_at · variant 2nulloptional——
paginationobjectrequired——
pagination.nextanyOf<string | null>optional——
pagination.next · variant 1stringoptional——
pagination.next · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
filenamestringrequired—
min length: 1max length: 512
size_bytesanyOf<integer | null>optional——
size_bytes · variant 1integeroptional—
min: 0
size_bytes · variant 2nulloptional——
content_typeanyOf<string | null>optional——
content_type · variant 1stringoptional—
max length: 255
content_type · variant 2nulloptional——
checksum_sha256anyOf<string | null>optional——
checksum_sha256 · variant 1stringoptional—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nulloptional——
retention_secondsanyOf<integer | null>optional——
retention_seconds · variant 1integeroptional—
min: 0max: 86400
retention_seconds · variant 2nulloptional——
metadataobjectoptional——

Responses

201Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
statusstringrequired——
rolestringrequired——
filenamestringrequired——
content_typeanyOf<string | null>optional——
content_type · variant 1stringoptional——
content_type · variant 2nulloptional——
detected_content_typeanyOf<string | null>optional——
detected_content_type · variant 1stringoptional——
detected_content_type · variant 2nulloptional——
detected_formatanyOf<string | null>optional——
detected_format · variant 1stringoptional——
detected_format · variant 2nulloptional——
size_bytesanyOf<integer | null>optional——
size_bytes · variant 1integeroptional——
size_bytes · variant 2nulloptional——
checksum_sha256anyOf<string | null>optional——
checksum_sha256 · variant 1stringoptional——
checksum_sha256 · variant 2nulloptional——
source_typestringrequired——
created_atstringrequired—
format: date-time
ready_atanyOf<string | null>optional——
ready_at · variant 1stringoptional—
format: date-time
ready_at · variant 2nulloptional——
expires_atanyOf<string | null>optional——
expires_at · variant 1stringoptional—
format: date-time
expires_at · variant 2nulloptional——
metadataobjectoptional——
uploadanyOf<object | null>optional——
upload · variant 1objectoptional——
upload · variant 1.methodstringoptional—
default: "PUT"
upload · variant 1.urlstringrequired——
upload · variant 1.expires_atstringrequired—
format: date-time
upload · variant 1.headersobjectoptional——
upload · variant 2nulloptional——
download_urlanyOf<string | null>optional——
download_url · variant 1stringoptional——
download_url · variant 2nulloptional——
download_expires_atanyOf<string | null>optional——
download_expires_at · variant 1stringoptional—
format: date-time
download_expires_at · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
file_idpathstringrequired—

Responses

204Successful Response

No response body.

400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
file_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
statusstringrequired——
rolestringrequired——
filenamestringrequired——
content_typeanyOf<string | null>optional——
content_type · variant 1stringoptional——
content_type · variant 2nulloptional——
detected_content_typeanyOf<string | null>optional——
detected_content_type · variant 1stringoptional——
detected_content_type · variant 2nulloptional——
detected_formatanyOf<string | null>optional——
detected_format · variant 1stringoptional——
detected_format · variant 2nulloptional——
size_bytesanyOf<integer | null>optional——
size_bytes · variant 1integeroptional——
size_bytes · variant 2nulloptional——
checksum_sha256anyOf<string | null>optional——
checksum_sha256 · variant 1stringoptional——
checksum_sha256 · variant 2nulloptional——
source_typestringrequired——
created_atstringrequired—
format: date-time
ready_atanyOf<string | null>optional——
ready_at · variant 1stringoptional—
format: date-time
ready_at · variant 2nulloptional——
expires_atanyOf<string | null>optional——
expires_at · variant 1stringoptional—
format: date-time
expires_at · variant 2nulloptional——
metadataobjectoptional——
uploadanyOf<object | null>optional——
upload · variant 1objectoptional——
upload · variant 1.methodstringoptional—
default: "PUT"
upload · variant 1.urlstringrequired——
upload · variant 1.expires_atstringrequired—
format: date-time
upload · variant 1.headersobjectoptional——
upload · variant 2nulloptional——
download_urlanyOf<string | null>optional——
download_url · variant 1stringoptional——
download_url · variant 2nulloptional——
download_expires_atanyOf<string | null>optional——
download_expires_at · variant 1stringoptional—
format: date-time
download_expires_at · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
file_idpathstringrequired—

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
checksum_sha256anyOf<string | null>optional——
checksum_sha256 · variant 1stringoptional—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nulloptional——

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
statusstringrequired——
rolestringrequired——
filenamestringrequired——
content_typeanyOf<string | null>optional——
content_type · variant 1stringoptional——
content_type · variant 2nulloptional——
detected_content_typeanyOf<string | null>optional——
detected_content_type · variant 1stringoptional——
detected_content_type · variant 2nulloptional——
detected_formatanyOf<string | null>optional——
detected_format · variant 1stringoptional——
detected_format · variant 2nulloptional——
size_bytesanyOf<integer | null>optional——
size_bytes · variant 1integeroptional——
size_bytes · variant 2nulloptional——
checksum_sha256anyOf<string | null>optional——
checksum_sha256 · variant 1stringoptional——
checksum_sha256 · variant 2nulloptional——
source_typestringrequired——
created_atstringrequired—
format: date-time
ready_atanyOf<string | null>optional——
ready_at · variant 1stringoptional—
format: date-time
ready_at · variant 2nulloptional——
expires_atanyOf<string | null>optional——
expires_at · variant 1stringoptional—
format: date-time
expires_at · variant 2nulloptional——
metadataobjectoptional——
uploadanyOf<object | null>optional——
upload · variant 1objectoptional——
upload · variant 1.methodstringoptional—
default: "PUT"
upload · variant 1.urlstringrequired——
upload · variant 1.expires_atstringrequired—
format: date-time
upload · variant 1.headersobjectoptional——
upload · variant 2nulloptional——
download_urlanyOf<string | null>optional——
download_url · variant 1stringoptional——
download_url · variant 2nulloptional——
download_expires_atanyOf<string | null>optional——
download_expires_at · variant 1stringoptional—
format: date-time
download_expires_at · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
file_idpathstringrequired—

Responses

204Successful Response

No response body.

400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
file_idpathstringrequired—

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
part_sizeanyOf<integer | null>optional——
part_size · variant 1integeroptional—
min: 5242880max: 5368709120
part_size · variant 2nulloptional——

Responses

201Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
file_idstringrequired——
upload_idstringrequired——
part_sizeintegerrequired——
max_partsintegeroptional—
default: 10000
expires_atstringrequired—
format: date-time
partsobject[]optional——
parts[]objectoptional——
parts[].part_numberintegerrequired——
parts[].urlstringrequired——
parts[].expires_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
file_idpathstringrequired—

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
partsobject[]required—
min items: 1max items: 10000
parts[]objectoptional——
parts[].part_numberintegerrequired—
min: 1max: 10000
parts[].etagstringrequired—
min length: 1max length: 512
checksum_sha256anyOf<string | null>optional——
checksum_sha256 · variant 1stringoptional—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nulloptional——

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
statusstringrequired——
rolestringrequired——
filenamestringrequired——
content_typeanyOf<string | null>optional——
content_type · variant 1stringoptional——
content_type · variant 2nulloptional——
detected_content_typeanyOf<string | null>optional——
detected_content_type · variant 1stringoptional——
detected_content_type · variant 2nulloptional——
detected_formatanyOf<string | null>optional——
detected_format · variant 1stringoptional——
detected_format · variant 2nulloptional——
size_bytesanyOf<integer | null>optional——
size_bytes · variant 1integeroptional——
size_bytes · variant 2nulloptional——
checksum_sha256anyOf<string | null>optional——
checksum_sha256 · variant 1stringoptional——
checksum_sha256 · variant 2nulloptional——
source_typestringrequired——
created_atstringrequired—
format: date-time
ready_atanyOf<string | null>optional——
ready_at · variant 1stringoptional—
format: date-time
ready_at · variant 2nulloptional——
expires_atanyOf<string | null>optional——
expires_at · variant 1stringoptional—
format: date-time
expires_at · variant 2nulloptional——
metadataobjectoptional——
uploadanyOf<object | null>optional——
upload · variant 1objectoptional——
upload · variant 1.methodstringoptional—
default: "PUT"
upload · variant 1.urlstringrequired——
upload · variant 1.expires_atstringrequired—
format: date-time
upload · variant 1.headersobjectoptional——
upload · variant 2nulloptional——
download_urlanyOf<string | null>optional——
download_url · variant 1stringoptional——
download_url · variant 2nulloptional——
download_expires_atanyOf<string | null>optional——
download_expires_at · variant 1stringoptional—
format: date-time
download_expires_at · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
file_idpathstringrequired—

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
part_numbersinteger[]required—
min items: 1max items: 1000

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
file_idstringrequired——
upload_idstringrequired——
part_sizeintegerrequired——
max_partsintegeroptional—
default: 10000
expires_atstringrequired—
format: date-time
partsobject[]optional——
parts[]objectoptional——
parts[].part_numberintegerrequired——
parts[].urlstringrequired——
parts[].expires_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

AuthenticationPublic / no operation-level security requirement

Parameters

NameLocationTypeRequiredDescription / constraints
limitqueryintegeroptional
default: 500min: 1max: 500

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
dataobject[]required——
data[]objectoptional——
data[].slugstringrequired——
data[].labelstringrequired——
data[].categorystringrequired——
data[].mime_typesstring[]required——
data[].extensionsstring[]required——
paginationobjectrequired——
pagination.nextanyOf<string | null>optional——
pagination.next · variant 1stringoptional——
pagination.next · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

AuthenticationPublic / no operation-level security requirement

Parameters

NameLocationTypeRequiredDescription / constraints
slugpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
slugstringrequired——
labelstringrequired——
categorystringrequired——
mime_typesstring[]required——
extensionsstring[]required——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

AuthenticationPublic / no operation-level security requirement

Parameters

NameLocationTypeRequiredDescription / constraints
slugpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
dataobject[]required——
data[]objectoptional——
data[].slugstringrequired——
data[].labelstringrequired——
data[].categorystringrequired——
data[].mime_typesstring[]required——
data[].extensionsstring[]required——
paginationobjectrequired——
pagination.nextanyOf<string | null>optional——
pagination.next · variant 1stringoptional——
pagination.next · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

AuthenticationPublic / no operation-level security requirement

Parameters

NameLocationTypeRequiredDescription / constraints
slugpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
dataobject[]required——
data[]objectoptional——
data[].slugstringrequired——
data[].labelstringrequired——
data[].categorystringrequired——
data[].mime_typesstring[]required——
data[].extensionsstring[]required——
paginationobjectrequired——
pagination.nextanyOf<string | null>optional——
pagination.next · variant 1stringoptional——
pagination.next · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
limitqueryintegeroptional
default: 50min: 1max: 200
afterqueryanyOf<string | null>optional—
statusqueryanyOf<string | null>optional—
tagqueryanyOf<string | null>optional—
originqueryanyOf<string | null>optional—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
dataobject[]required——
data[]objectoptional——
data[].idstringrequired——
data[].kindstringrequired——
data[].statusstringrequired——
data[].progressintegerrequired——
data[].taganyOf<string | null>optional——
data[].tag · variant 1stringoptional——
data[].tag · variant 2nulloptional——
data[].client_reference_idanyOf<string | null>optional——
data[].client_reference_id · variant 1stringoptional——
data[].client_reference_id · variant 2nulloptional——
data[].metadataobjectoptional——
data[].prioritystringrequired——
data[].concurrency_limitintegeroptional—
default: 1
data[].originstringrequired——
data[].created_atstringrequired—
format: date-time
data[].started_atanyOf<string | null>optional——
data[].started_at · variant 1stringoptional—
format: date-time
data[].started_at · variant 2nulloptional——
data[].completed_atanyOf<string | null>optional——
data[].completed_at · variant 1stringoptional—
format: date-time
data[].completed_at · variant 2nulloptional——
data[].error_codeanyOf<string | null>optional——
data[].error_code · variant 1stringoptional——
data[].error_code · variant 2nulloptional——
data[].error_messageanyOf<string | null>optional——
data[].error_message · variant 1stringoptional——
data[].error_message · variant 2nulloptional——
data[].tasksobject[]optional——
data[].tasks[]objectoptional——
data[].tasks[].idstringrequired——
data[].tasks[].job_idstringrequired——
data[].tasks[].namestringrequired——
data[].tasks[].operationstringrequired——
data[].tasks[].statusstringrequired——
data[].tasks[].progressintegerrequired——
data[].tasks[].inputobjectrequired——
data[].tasks[].optionsobjectrequired——
data[].tasks[].resultobjectrequired——
data[].tasks[].requiredbooleanrequired——
data[].tasks[].runtime_classstringrequired——
data[].tasks[].prioritystringrequired——
data[].tasks[].attempt_countintegerrequired——
data[].tasks[].max_attemptsintegerrequired——
data[].tasks[].error_codeanyOf<string | null>optional——
data[].tasks[].error_code · variant 1stringoptional——
data[].tasks[].error_code · variant 2nulloptional——
data[].tasks[].error_messageanyOf<string | null>optional——
data[].tasks[].error_message · variant 1stringoptional——
data[].tasks[].error_message · variant 2nulloptional——
data[].tasks[].created_atstringrequired—
format: date-time
data[].tasks[].queued_atanyOf<string | null>optional——
data[].tasks[].queued_at · variant 1stringoptional—
format: date-time
data[].tasks[].queued_at · variant 2nulloptional——
data[].tasks[].started_atanyOf<string | null>optional——
data[].tasks[].started_at · variant 1stringoptional—
format: date-time
data[].tasks[].started_at · variant 2nulloptional——
data[].tasks[].completed_atanyOf<string | null>optional——
data[].tasks[].completed_at · variant 1stringoptional—
format: date-time
data[].tasks[].completed_at · variant 2nulloptional——
data[].tasks[].attemptsobject[]optional——
data[].tasks[].attempts[]objectoptional——
data[].tasks[].attempts[].idstringrequired——
data[].tasks[].attempts[].attempt_numberintegerrequired——
data[].tasks[].attempts[].statusstringrequired——
data[].tasks[].attempts[].worker_idanyOf<string | null>optional——
data[].tasks[].attempts[].worker_id · variant 1stringoptional——
data[].tasks[].attempts[].worker_id · variant 2nulloptional——
data[].tasks[].attempts[].runtime_classanyOf<string | null>optional——
data[].tasks[].attempts[].runtime_class · variant 1stringoptional——
data[].tasks[].attempts[].runtime_class · variant 2nulloptional——
data[].tasks[].attempts[].regionanyOf<string | null>optional——
data[].tasks[].attempts[].region · variant 1stringoptional——
data[].tasks[].attempts[].region · variant 2nulloptional——
data[].tasks[].attempts[].engineanyOf<string | null>optional——
data[].tasks[].attempts[].engine · variant 1stringoptional——
data[].tasks[].attempts[].engine · variant 2nulloptional——
data[].tasks[].attempts[].engine_versionanyOf<string | null>optional——
data[].tasks[].attempts[].engine_version · variant 1stringoptional——
data[].tasks[].attempts[].engine_version · variant 2nulloptional——
data[].tasks[].attempts[].input_bytesanyOf<integer | null>optional——
data[].tasks[].attempts[].input_bytes · variant 1integeroptional——
data[].tasks[].attempts[].input_bytes · variant 2nulloptional——
data[].tasks[].attempts[].output_bytesanyOf<integer | null>optional——
data[].tasks[].attempts[].output_bytes · variant 1integeroptional——
data[].tasks[].attempts[].output_bytes · variant 2nulloptional——
data[].tasks[].attempts[].wall_msanyOf<integer | null>optional——
data[].tasks[].attempts[].wall_ms · variant 1integeroptional——
data[].tasks[].attempts[].wall_ms · variant 2nulloptional——
data[].tasks[].attempts[].cpu_msanyOf<integer | null>optional——
data[].tasks[].attempts[].cpu_ms · variant 1integeroptional——
data[].tasks[].attempts[].cpu_ms · variant 2nulloptional——
data[].tasks[].attempts[].peak_memory_mbanyOf<integer | null>optional——
data[].tasks[].attempts[].peak_memory_mb · variant 1integeroptional——
data[].tasks[].attempts[].peak_memory_mb · variant 2nulloptional——
data[].tasks[].attempts[].temp_bytesanyOf<integer | null>optional——
data[].tasks[].attempts[].temp_bytes · variant 1integeroptional——
data[].tasks[].attempts[].temp_bytes · variant 2nulloptional——
data[].tasks[].attempts[].error_codeanyOf<string | null>optional——
data[].tasks[].attempts[].error_code · variant 1stringoptional——
data[].tasks[].attempts[].error_code · variant 2nulloptional——
data[].tasks[].attempts[].error_messageanyOf<string | null>optional——
data[].tasks[].attempts[].error_message · variant 1stringoptional——
data[].tasks[].attempts[].error_message · variant 2nulloptional——
data[].tasks[].attempts[].estimated_creditsanyOf<string | null>optional——
data[].tasks[].attempts[].estimated_credits · variant 1stringoptional——
data[].tasks[].attempts[].estimated_credits · variant 2nulloptional——
data[].tasks[].attempts[].settled_creditsanyOf<string | null>optional——
data[].tasks[].attempts[].settled_credits · variant 1stringoptional——
data[].tasks[].attempts[].settled_credits · variant 2nulloptional——
data[].tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optional——
data[].tasks[].attempts[].external_side_effect_started_at · variant 1stringoptional—
format: date-time
data[].tasks[].attempts[].external_side_effect_started_at · variant 2nulloptional——
data[].tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optional——
data[].tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptional—
format: date-time
data[].tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptional——
data[].tasks[].attempts[].started_atstringrequired—
format: date-time
data[].tasks[].attempts[].completed_atanyOf<string | null>optional——
data[].tasks[].attempts[].completed_at · variant 1stringoptional—
format: date-time
data[].tasks[].attempts[].completed_at · variant 2nulloptional——
paginationobjectrequired——
pagination.nextanyOf<string | null>optional——
pagination.next · variant 1stringoptional——
pagination.next · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
Idempotency-KeyheaderanyOf<string | null>optional—

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
tasksobjectrequired——
taganyOf<string | null>optional——
tag · variant 1stringoptional—
max length: 255
tag · variant 2nulloptional——
client_reference_idanyOf<string | null>optional——
client_reference_id · variant 1stringoptional—
max length: 255
client_reference_id · variant 2nulloptional——
metadataobjectoptional——
prioritystringoptional—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>optional——
retention_seconds · variant 1integeroptional—
min: 0max: 86400
retention_seconds · variant 2nulloptional——

Responses

201Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
kindstringrequired——
statusstringrequired——
progressintegerrequired——
taganyOf<string | null>optional——
tag · variant 1stringoptional——
tag · variant 2nulloptional——
client_reference_idanyOf<string | null>optional——
client_reference_id · variant 1stringoptional——
client_reference_id · variant 2nulloptional——
metadataobjectoptional——
prioritystringrequired——
concurrency_limitintegeroptional—
default: 1
originstringrequired——
created_atstringrequired—
format: date-time
started_atanyOf<string | null>optional——
started_at · variant 1stringoptional—
format: date-time
started_at · variant 2nulloptional——
completed_atanyOf<string | null>optional——
completed_at · variant 1stringoptional—
format: date-time
completed_at · variant 2nulloptional——
error_codeanyOf<string | null>optional——
error_code · variant 1stringoptional——
error_code · variant 2nulloptional——
error_messageanyOf<string | null>optional——
error_message · variant 1stringoptional——
error_message · variant 2nulloptional——
tasksobject[]optional——
tasks[]objectoptional——
tasks[].idstringrequired——
tasks[].job_idstringrequired——
tasks[].namestringrequired——
tasks[].operationstringrequired——
tasks[].statusstringrequired——
tasks[].progressintegerrequired——
tasks[].inputobjectrequired——
tasks[].optionsobjectrequired——
tasks[].resultobjectrequired——
tasks[].requiredbooleanrequired——
tasks[].runtime_classstringrequired——
tasks[].prioritystringrequired——
tasks[].attempt_countintegerrequired——
tasks[].max_attemptsintegerrequired——
tasks[].error_codeanyOf<string | null>optional——
tasks[].error_code · variant 1stringoptional——
tasks[].error_code · variant 2nulloptional——
tasks[].error_messageanyOf<string | null>optional——
tasks[].error_message · variant 1stringoptional——
tasks[].error_message · variant 2nulloptional——
tasks[].created_atstringrequired—
format: date-time
tasks[].queued_atanyOf<string | null>optional——
tasks[].queued_at · variant 1stringoptional—
format: date-time
tasks[].queued_at · variant 2nulloptional——
tasks[].started_atanyOf<string | null>optional——
tasks[].started_at · variant 1stringoptional—
format: date-time
tasks[].started_at · variant 2nulloptional——
tasks[].completed_atanyOf<string | null>optional——
tasks[].completed_at · variant 1stringoptional—
format: date-time
tasks[].completed_at · variant 2nulloptional——
tasks[].attemptsobject[]optional——
tasks[].attempts[]objectoptional——
tasks[].attempts[].idstringrequired——
tasks[].attempts[].attempt_numberintegerrequired——
tasks[].attempts[].statusstringrequired——
tasks[].attempts[].worker_idanyOf<string | null>optional——
tasks[].attempts[].worker_id · variant 1stringoptional——
tasks[].attempts[].worker_id · variant 2nulloptional——
tasks[].attempts[].runtime_classanyOf<string | null>optional——
tasks[].attempts[].runtime_class · variant 1stringoptional——
tasks[].attempts[].runtime_class · variant 2nulloptional——
tasks[].attempts[].regionanyOf<string | null>optional——
tasks[].attempts[].region · variant 1stringoptional——
tasks[].attempts[].region · variant 2nulloptional——
tasks[].attempts[].engineanyOf<string | null>optional——
tasks[].attempts[].engine · variant 1stringoptional——
tasks[].attempts[].engine · variant 2nulloptional——
tasks[].attempts[].engine_versionanyOf<string | null>optional——
tasks[].attempts[].engine_version · variant 1stringoptional——
tasks[].attempts[].engine_version · variant 2nulloptional——
tasks[].attempts[].input_bytesanyOf<integer | null>optional——
tasks[].attempts[].input_bytes · variant 1integeroptional——
tasks[].attempts[].input_bytes · variant 2nulloptional——
tasks[].attempts[].output_bytesanyOf<integer | null>optional——
tasks[].attempts[].output_bytes · variant 1integeroptional——
tasks[].attempts[].output_bytes · variant 2nulloptional——
tasks[].attempts[].wall_msanyOf<integer | null>optional——
tasks[].attempts[].wall_ms · variant 1integeroptional——
tasks[].attempts[].wall_ms · variant 2nulloptional——
tasks[].attempts[].cpu_msanyOf<integer | null>optional——
tasks[].attempts[].cpu_ms · variant 1integeroptional——
tasks[].attempts[].cpu_ms · variant 2nulloptional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>optional——
tasks[].attempts[].peak_memory_mb · variant 1integeroptional——
tasks[].attempts[].peak_memory_mb · variant 2nulloptional——
tasks[].attempts[].temp_bytesanyOf<integer | null>optional——
tasks[].attempts[].temp_bytes · variant 1integeroptional——
tasks[].attempts[].temp_bytes · variant 2nulloptional——
tasks[].attempts[].error_codeanyOf<string | null>optional——
tasks[].attempts[].error_code · variant 1stringoptional——
tasks[].attempts[].error_code · variant 2nulloptional——
tasks[].attempts[].error_messageanyOf<string | null>optional——
tasks[].attempts[].error_message · variant 1stringoptional——
tasks[].attempts[].error_message · variant 2nulloptional——
tasks[].attempts[].estimated_creditsanyOf<string | null>optional——
tasks[].attempts[].estimated_credits · variant 1stringoptional——
tasks[].attempts[].estimated_credits · variant 2nulloptional——
tasks[].attempts[].settled_creditsanyOf<string | null>optional——
tasks[].attempts[].settled_credits · variant 1stringoptional——
tasks[].attempts[].settled_credits · variant 2nulloptional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nulloptional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptional——
tasks[].attempts[].started_atstringrequired—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>optional——
tasks[].attempts[].completed_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].completed_at · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
job_idpathstringrequired—
include_attemptsquerybooleanoptional
default: false

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
kindstringrequired——
statusstringrequired——
progressintegerrequired——
taganyOf<string | null>optional——
tag · variant 1stringoptional——
tag · variant 2nulloptional——
client_reference_idanyOf<string | null>optional——
client_reference_id · variant 1stringoptional——
client_reference_id · variant 2nulloptional——
metadataobjectoptional——
prioritystringrequired——
concurrency_limitintegeroptional—
default: 1
originstringrequired——
created_atstringrequired—
format: date-time
started_atanyOf<string | null>optional——
started_at · variant 1stringoptional—
format: date-time
started_at · variant 2nulloptional——
completed_atanyOf<string | null>optional——
completed_at · variant 1stringoptional—
format: date-time
completed_at · variant 2nulloptional——
error_codeanyOf<string | null>optional——
error_code · variant 1stringoptional——
error_code · variant 2nulloptional——
error_messageanyOf<string | null>optional——
error_message · variant 1stringoptional——
error_message · variant 2nulloptional——
tasksobject[]optional——
tasks[]objectoptional——
tasks[].idstringrequired——
tasks[].job_idstringrequired——
tasks[].namestringrequired——
tasks[].operationstringrequired——
tasks[].statusstringrequired——
tasks[].progressintegerrequired——
tasks[].inputobjectrequired——
tasks[].optionsobjectrequired——
tasks[].resultobjectrequired——
tasks[].requiredbooleanrequired——
tasks[].runtime_classstringrequired——
tasks[].prioritystringrequired——
tasks[].attempt_countintegerrequired——
tasks[].max_attemptsintegerrequired——
tasks[].error_codeanyOf<string | null>optional——
tasks[].error_code · variant 1stringoptional——
tasks[].error_code · variant 2nulloptional——
tasks[].error_messageanyOf<string | null>optional——
tasks[].error_message · variant 1stringoptional——
tasks[].error_message · variant 2nulloptional——
tasks[].created_atstringrequired—
format: date-time
tasks[].queued_atanyOf<string | null>optional——
tasks[].queued_at · variant 1stringoptional—
format: date-time
tasks[].queued_at · variant 2nulloptional——
tasks[].started_atanyOf<string | null>optional——
tasks[].started_at · variant 1stringoptional—
format: date-time
tasks[].started_at · variant 2nulloptional——
tasks[].completed_atanyOf<string | null>optional——
tasks[].completed_at · variant 1stringoptional—
format: date-time
tasks[].completed_at · variant 2nulloptional——
tasks[].attemptsobject[]optional——
tasks[].attempts[]objectoptional——
tasks[].attempts[].idstringrequired——
tasks[].attempts[].attempt_numberintegerrequired——
tasks[].attempts[].statusstringrequired——
tasks[].attempts[].worker_idanyOf<string | null>optional——
tasks[].attempts[].worker_id · variant 1stringoptional——
tasks[].attempts[].worker_id · variant 2nulloptional——
tasks[].attempts[].runtime_classanyOf<string | null>optional——
tasks[].attempts[].runtime_class · variant 1stringoptional——
tasks[].attempts[].runtime_class · variant 2nulloptional——
tasks[].attempts[].regionanyOf<string | null>optional——
tasks[].attempts[].region · variant 1stringoptional——
tasks[].attempts[].region · variant 2nulloptional——
tasks[].attempts[].engineanyOf<string | null>optional——
tasks[].attempts[].engine · variant 1stringoptional——
tasks[].attempts[].engine · variant 2nulloptional——
tasks[].attempts[].engine_versionanyOf<string | null>optional——
tasks[].attempts[].engine_version · variant 1stringoptional——
tasks[].attempts[].engine_version · variant 2nulloptional——
tasks[].attempts[].input_bytesanyOf<integer | null>optional——
tasks[].attempts[].input_bytes · variant 1integeroptional——
tasks[].attempts[].input_bytes · variant 2nulloptional——
tasks[].attempts[].output_bytesanyOf<integer | null>optional——
tasks[].attempts[].output_bytes · variant 1integeroptional——
tasks[].attempts[].output_bytes · variant 2nulloptional——
tasks[].attempts[].wall_msanyOf<integer | null>optional——
tasks[].attempts[].wall_ms · variant 1integeroptional——
tasks[].attempts[].wall_ms · variant 2nulloptional——
tasks[].attempts[].cpu_msanyOf<integer | null>optional——
tasks[].attempts[].cpu_ms · variant 1integeroptional——
tasks[].attempts[].cpu_ms · variant 2nulloptional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>optional——
tasks[].attempts[].peak_memory_mb · variant 1integeroptional——
tasks[].attempts[].peak_memory_mb · variant 2nulloptional——
tasks[].attempts[].temp_bytesanyOf<integer | null>optional——
tasks[].attempts[].temp_bytes · variant 1integeroptional——
tasks[].attempts[].temp_bytes · variant 2nulloptional——
tasks[].attempts[].error_codeanyOf<string | null>optional——
tasks[].attempts[].error_code · variant 1stringoptional——
tasks[].attempts[].error_code · variant 2nulloptional——
tasks[].attempts[].error_messageanyOf<string | null>optional——
tasks[].attempts[].error_message · variant 1stringoptional——
tasks[].attempts[].error_message · variant 2nulloptional——
tasks[].attempts[].estimated_creditsanyOf<string | null>optional——
tasks[].attempts[].estimated_credits · variant 1stringoptional——
tasks[].attempts[].estimated_credits · variant 2nulloptional——
tasks[].attempts[].settled_creditsanyOf<string | null>optional——
tasks[].attempts[].settled_credits · variant 1stringoptional——
tasks[].attempts[].settled_credits · variant 2nulloptional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nulloptional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptional——
tasks[].attempts[].started_atstringrequired—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>optional——
tasks[].attempts[].completed_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].completed_at · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
job_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
kindstringrequired——
statusstringrequired——
progressintegerrequired——
taganyOf<string | null>optional——
tag · variant 1stringoptional——
tag · variant 2nulloptional——
client_reference_idanyOf<string | null>optional——
client_reference_id · variant 1stringoptional——
client_reference_id · variant 2nulloptional——
metadataobjectoptional——
prioritystringrequired——
concurrency_limitintegeroptional—
default: 1
originstringrequired——
created_atstringrequired—
format: date-time
started_atanyOf<string | null>optional——
started_at · variant 1stringoptional—
format: date-time
started_at · variant 2nulloptional——
completed_atanyOf<string | null>optional——
completed_at · variant 1stringoptional—
format: date-time
completed_at · variant 2nulloptional——
error_codeanyOf<string | null>optional——
error_code · variant 1stringoptional——
error_code · variant 2nulloptional——
error_messageanyOf<string | null>optional——
error_message · variant 1stringoptional——
error_message · variant 2nulloptional——
tasksobject[]optional——
tasks[]objectoptional——
tasks[].idstringrequired——
tasks[].job_idstringrequired——
tasks[].namestringrequired——
tasks[].operationstringrequired——
tasks[].statusstringrequired——
tasks[].progressintegerrequired——
tasks[].inputobjectrequired——
tasks[].optionsobjectrequired——
tasks[].resultobjectrequired——
tasks[].requiredbooleanrequired——
tasks[].runtime_classstringrequired——
tasks[].prioritystringrequired——
tasks[].attempt_countintegerrequired——
tasks[].max_attemptsintegerrequired——
tasks[].error_codeanyOf<string | null>optional——
tasks[].error_code · variant 1stringoptional——
tasks[].error_code · variant 2nulloptional——
tasks[].error_messageanyOf<string | null>optional——
tasks[].error_message · variant 1stringoptional——
tasks[].error_message · variant 2nulloptional——
tasks[].created_atstringrequired—
format: date-time
tasks[].queued_atanyOf<string | null>optional——
tasks[].queued_at · variant 1stringoptional—
format: date-time
tasks[].queued_at · variant 2nulloptional——
tasks[].started_atanyOf<string | null>optional——
tasks[].started_at · variant 1stringoptional—
format: date-time
tasks[].started_at · variant 2nulloptional——
tasks[].completed_atanyOf<string | null>optional——
tasks[].completed_at · variant 1stringoptional—
format: date-time
tasks[].completed_at · variant 2nulloptional——
tasks[].attemptsobject[]optional——
tasks[].attempts[]objectoptional——
tasks[].attempts[].idstringrequired——
tasks[].attempts[].attempt_numberintegerrequired——
tasks[].attempts[].statusstringrequired——
tasks[].attempts[].worker_idanyOf<string | null>optional——
tasks[].attempts[].worker_id · variant 1stringoptional——
tasks[].attempts[].worker_id · variant 2nulloptional——
tasks[].attempts[].runtime_classanyOf<string | null>optional——
tasks[].attempts[].runtime_class · variant 1stringoptional——
tasks[].attempts[].runtime_class · variant 2nulloptional——
tasks[].attempts[].regionanyOf<string | null>optional——
tasks[].attempts[].region · variant 1stringoptional——
tasks[].attempts[].region · variant 2nulloptional——
tasks[].attempts[].engineanyOf<string | null>optional——
tasks[].attempts[].engine · variant 1stringoptional——
tasks[].attempts[].engine · variant 2nulloptional——
tasks[].attempts[].engine_versionanyOf<string | null>optional——
tasks[].attempts[].engine_version · variant 1stringoptional——
tasks[].attempts[].engine_version · variant 2nulloptional——
tasks[].attempts[].input_bytesanyOf<integer | null>optional——
tasks[].attempts[].input_bytes · variant 1integeroptional——
tasks[].attempts[].input_bytes · variant 2nulloptional——
tasks[].attempts[].output_bytesanyOf<integer | null>optional——
tasks[].attempts[].output_bytes · variant 1integeroptional——
tasks[].attempts[].output_bytes · variant 2nulloptional——
tasks[].attempts[].wall_msanyOf<integer | null>optional——
tasks[].attempts[].wall_ms · variant 1integeroptional——
tasks[].attempts[].wall_ms · variant 2nulloptional——
tasks[].attempts[].cpu_msanyOf<integer | null>optional——
tasks[].attempts[].cpu_ms · variant 1integeroptional——
tasks[].attempts[].cpu_ms · variant 2nulloptional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>optional——
tasks[].attempts[].peak_memory_mb · variant 1integeroptional——
tasks[].attempts[].peak_memory_mb · variant 2nulloptional——
tasks[].attempts[].temp_bytesanyOf<integer | null>optional——
tasks[].attempts[].temp_bytes · variant 1integeroptional——
tasks[].attempts[].temp_bytes · variant 2nulloptional——
tasks[].attempts[].error_codeanyOf<string | null>optional——
tasks[].attempts[].error_code · variant 1stringoptional——
tasks[].attempts[].error_code · variant 2nulloptional——
tasks[].attempts[].error_messageanyOf<string | null>optional——
tasks[].attempts[].error_message · variant 1stringoptional——
tasks[].attempts[].error_message · variant 2nulloptional——
tasks[].attempts[].estimated_creditsanyOf<string | null>optional——
tasks[].attempts[].estimated_credits · variant 1stringoptional——
tasks[].attempts[].estimated_credits · variant 2nulloptional——
tasks[].attempts[].settled_creditsanyOf<string | null>optional——
tasks[].attempts[].settled_credits · variant 1stringoptional——
tasks[].attempts[].settled_credits · variant 2nulloptional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nulloptional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptional——
tasks[].attempts[].started_atstringrequired—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>optional——
tasks[].attempts[].completed_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].completed_at · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
job_idpathstringrequired—
timeoutqueryintegeroptional
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>optional—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
bodyunknownrequired——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
job_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
kindstringrequired——
statusstringrequired——
progressintegerrequired——
taganyOf<string | null>optional——
tag · variant 1stringoptional——
tag · variant 2nulloptional——
client_reference_idanyOf<string | null>optional——
client_reference_id · variant 1stringoptional——
client_reference_id · variant 2nulloptional——
metadataobjectoptional——
prioritystringrequired——
concurrency_limitintegeroptional—
default: 1
originstringrequired——
created_atstringrequired—
format: date-time
started_atanyOf<string | null>optional——
started_at · variant 1stringoptional—
format: date-time
started_at · variant 2nulloptional——
completed_atanyOf<string | null>optional——
completed_at · variant 1stringoptional—
format: date-time
completed_at · variant 2nulloptional——
error_codeanyOf<string | null>optional——
error_code · variant 1stringoptional——
error_code · variant 2nulloptional——
error_messageanyOf<string | null>optional——
error_message · variant 1stringoptional——
error_message · variant 2nulloptional——
tasksobject[]optional——
tasks[]objectoptional——
tasks[].idstringrequired——
tasks[].job_idstringrequired——
tasks[].namestringrequired——
tasks[].operationstringrequired——
tasks[].statusstringrequired——
tasks[].progressintegerrequired——
tasks[].inputobjectrequired——
tasks[].optionsobjectrequired——
tasks[].resultobjectrequired——
tasks[].requiredbooleanrequired——
tasks[].runtime_classstringrequired——
tasks[].prioritystringrequired——
tasks[].attempt_countintegerrequired——
tasks[].max_attemptsintegerrequired——
tasks[].error_codeanyOf<string | null>optional——
tasks[].error_code · variant 1stringoptional——
tasks[].error_code · variant 2nulloptional——
tasks[].error_messageanyOf<string | null>optional——
tasks[].error_message · variant 1stringoptional——
tasks[].error_message · variant 2nulloptional——
tasks[].created_atstringrequired—
format: date-time
tasks[].queued_atanyOf<string | null>optional——
tasks[].queued_at · variant 1stringoptional—
format: date-time
tasks[].queued_at · variant 2nulloptional——
tasks[].started_atanyOf<string | null>optional——
tasks[].started_at · variant 1stringoptional—
format: date-time
tasks[].started_at · variant 2nulloptional——
tasks[].completed_atanyOf<string | null>optional——
tasks[].completed_at · variant 1stringoptional—
format: date-time
tasks[].completed_at · variant 2nulloptional——
tasks[].attemptsobject[]optional——
tasks[].attempts[]objectoptional——
tasks[].attempts[].idstringrequired——
tasks[].attempts[].attempt_numberintegerrequired——
tasks[].attempts[].statusstringrequired——
tasks[].attempts[].worker_idanyOf<string | null>optional——
tasks[].attempts[].worker_id · variant 1stringoptional——
tasks[].attempts[].worker_id · variant 2nulloptional——
tasks[].attempts[].runtime_classanyOf<string | null>optional——
tasks[].attempts[].runtime_class · variant 1stringoptional——
tasks[].attempts[].runtime_class · variant 2nulloptional——
tasks[].attempts[].regionanyOf<string | null>optional——
tasks[].attempts[].region · variant 1stringoptional——
tasks[].attempts[].region · variant 2nulloptional——
tasks[].attempts[].engineanyOf<string | null>optional——
tasks[].attempts[].engine · variant 1stringoptional——
tasks[].attempts[].engine · variant 2nulloptional——
tasks[].attempts[].engine_versionanyOf<string | null>optional——
tasks[].attempts[].engine_version · variant 1stringoptional——
tasks[].attempts[].engine_version · variant 2nulloptional——
tasks[].attempts[].input_bytesanyOf<integer | null>optional——
tasks[].attempts[].input_bytes · variant 1integeroptional——
tasks[].attempts[].input_bytes · variant 2nulloptional——
tasks[].attempts[].output_bytesanyOf<integer | null>optional——
tasks[].attempts[].output_bytes · variant 1integeroptional——
tasks[].attempts[].output_bytes · variant 2nulloptional——
tasks[].attempts[].wall_msanyOf<integer | null>optional——
tasks[].attempts[].wall_ms · variant 1integeroptional——
tasks[].attempts[].wall_ms · variant 2nulloptional——
tasks[].attempts[].cpu_msanyOf<integer | null>optional——
tasks[].attempts[].cpu_ms · variant 1integeroptional——
tasks[].attempts[].cpu_ms · variant 2nulloptional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>optional——
tasks[].attempts[].peak_memory_mb · variant 1integeroptional——
tasks[].attempts[].peak_memory_mb · variant 2nulloptional——
tasks[].attempts[].temp_bytesanyOf<integer | null>optional——
tasks[].attempts[].temp_bytes · variant 1integeroptional——
tasks[].attempts[].temp_bytes · variant 2nulloptional——
tasks[].attempts[].error_codeanyOf<string | null>optional——
tasks[].attempts[].error_code · variant 1stringoptional——
tasks[].attempts[].error_code · variant 2nulloptional——
tasks[].attempts[].error_messageanyOf<string | null>optional——
tasks[].attempts[].error_message · variant 1stringoptional——
tasks[].attempts[].error_message · variant 2nulloptional——
tasks[].attempts[].estimated_creditsanyOf<string | null>optional——
tasks[].attempts[].estimated_credits · variant 1stringoptional——
tasks[].attempts[].estimated_credits · variant 2nulloptional——
tasks[].attempts[].settled_creditsanyOf<string | null>optional——
tasks[].attempts[].settled_credits · variant 1stringoptional——
tasks[].attempts[].settled_credits · variant 2nulloptional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nulloptional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptional——
tasks[].attempts[].started_atstringrequired—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>optional——
tasks[].attempts[].completed_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].completed_at · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
job_idpathstringrequired—
timeoutqueryintegeroptional
default: 20min: 0max: 30

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
kindstringrequired——
statusstringrequired——
progressintegerrequired——
taganyOf<string | null>optional——
tag · variant 1stringoptional——
tag · variant 2nulloptional——
client_reference_idanyOf<string | null>optional——
client_reference_id · variant 1stringoptional——
client_reference_id · variant 2nulloptional——
metadataobjectoptional——
prioritystringrequired——
concurrency_limitintegeroptional—
default: 1
originstringrequired——
created_atstringrequired—
format: date-time
started_atanyOf<string | null>optional——
started_at · variant 1stringoptional—
format: date-time
started_at · variant 2nulloptional——
completed_atanyOf<string | null>optional——
completed_at · variant 1stringoptional—
format: date-time
completed_at · variant 2nulloptional——
error_codeanyOf<string | null>optional——
error_code · variant 1stringoptional——
error_code · variant 2nulloptional——
error_messageanyOf<string | null>optional——
error_message · variant 1stringoptional——
error_message · variant 2nulloptional——
tasksobject[]optional——
tasks[]objectoptional——
tasks[].idstringrequired——
tasks[].job_idstringrequired——
tasks[].namestringrequired——
tasks[].operationstringrequired——
tasks[].statusstringrequired——
tasks[].progressintegerrequired——
tasks[].inputobjectrequired——
tasks[].optionsobjectrequired——
tasks[].resultobjectrequired——
tasks[].requiredbooleanrequired——
tasks[].runtime_classstringrequired——
tasks[].prioritystringrequired——
tasks[].attempt_countintegerrequired——
tasks[].max_attemptsintegerrequired——
tasks[].error_codeanyOf<string | null>optional——
tasks[].error_code · variant 1stringoptional——
tasks[].error_code · variant 2nulloptional——
tasks[].error_messageanyOf<string | null>optional——
tasks[].error_message · variant 1stringoptional——
tasks[].error_message · variant 2nulloptional——
tasks[].created_atstringrequired—
format: date-time
tasks[].queued_atanyOf<string | null>optional——
tasks[].queued_at · variant 1stringoptional—
format: date-time
tasks[].queued_at · variant 2nulloptional——
tasks[].started_atanyOf<string | null>optional——
tasks[].started_at · variant 1stringoptional—
format: date-time
tasks[].started_at · variant 2nulloptional——
tasks[].completed_atanyOf<string | null>optional——
tasks[].completed_at · variant 1stringoptional—
format: date-time
tasks[].completed_at · variant 2nulloptional——
tasks[].attemptsobject[]optional——
tasks[].attempts[]objectoptional——
tasks[].attempts[].idstringrequired——
tasks[].attempts[].attempt_numberintegerrequired——
tasks[].attempts[].statusstringrequired——
tasks[].attempts[].worker_idanyOf<string | null>optional——
tasks[].attempts[].worker_id · variant 1stringoptional——
tasks[].attempts[].worker_id · variant 2nulloptional——
tasks[].attempts[].runtime_classanyOf<string | null>optional——
tasks[].attempts[].runtime_class · variant 1stringoptional——
tasks[].attempts[].runtime_class · variant 2nulloptional——
tasks[].attempts[].regionanyOf<string | null>optional——
tasks[].attempts[].region · variant 1stringoptional——
tasks[].attempts[].region · variant 2nulloptional——
tasks[].attempts[].engineanyOf<string | null>optional——
tasks[].attempts[].engine · variant 1stringoptional——
tasks[].attempts[].engine · variant 2nulloptional——
tasks[].attempts[].engine_versionanyOf<string | null>optional——
tasks[].attempts[].engine_version · variant 1stringoptional——
tasks[].attempts[].engine_version · variant 2nulloptional——
tasks[].attempts[].input_bytesanyOf<integer | null>optional——
tasks[].attempts[].input_bytes · variant 1integeroptional——
tasks[].attempts[].input_bytes · variant 2nulloptional——
tasks[].attempts[].output_bytesanyOf<integer | null>optional——
tasks[].attempts[].output_bytes · variant 1integeroptional——
tasks[].attempts[].output_bytes · variant 2nulloptional——
tasks[].attempts[].wall_msanyOf<integer | null>optional——
tasks[].attempts[].wall_ms · variant 1integeroptional——
tasks[].attempts[].wall_ms · variant 2nulloptional——
tasks[].attempts[].cpu_msanyOf<integer | null>optional——
tasks[].attempts[].cpu_ms · variant 1integeroptional——
tasks[].attempts[].cpu_ms · variant 2nulloptional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>optional——
tasks[].attempts[].peak_memory_mb · variant 1integeroptional——
tasks[].attempts[].peak_memory_mb · variant 2nulloptional——
tasks[].attempts[].temp_bytesanyOf<integer | null>optional——
tasks[].attempts[].temp_bytes · variant 1integeroptional——
tasks[].attempts[].temp_bytes · variant 2nulloptional——
tasks[].attempts[].error_codeanyOf<string | null>optional——
tasks[].attempts[].error_code · variant 1stringoptional——
tasks[].attempts[].error_code · variant 2nulloptional——
tasks[].attempts[].error_messageanyOf<string | null>optional——
tasks[].attempts[].error_message · variant 1stringoptional——
tasks[].attempts[].error_message · variant 2nulloptional——
tasks[].attempts[].estimated_creditsanyOf<string | null>optional——
tasks[].attempts[].estimated_credits · variant 1stringoptional——
tasks[].attempts[].estimated_credits · variant 2nulloptional——
tasks[].attempts[].settled_creditsanyOf<string | null>optional——
tasks[].attempts[].settled_credits · variant 1stringoptional——
tasks[].attempts[].settled_credits · variant 2nulloptional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nulloptional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptional——
tasks[].attempts[].started_atstringrequired—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>optional——
tasks[].attempts[].completed_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].completed_at · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
tasksobjectrequired——
taganyOf<string | null>optional——
tag · variant 1stringoptional—
max length: 255
tag · variant 2nulloptional——
client_reference_idanyOf<string | null>optional——
client_reference_id · variant 1stringoptional—
max length: 255
client_reference_id · variant 2nulloptional——
metadataobjectoptional——
prioritystringoptional—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>optional——
retention_seconds · variant 1integeroptional—
min: 0max: 86400
retention_seconds · variant 2nulloptional——

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
validbooleanrequired——
task_countintegerrequired——
execution_orderstring[]required——
root_tasksstring[]required——
warningsstring[]optional——
estimated_creditsanyOf<object | null>optional——
estimated_credits · variant 1objectoptional——
estimated_credits · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
limitqueryintegeroptional
default: 50min: 1max: 200
afterqueryanyOf<string | null>optional—
status_codequeryanyOf<integer | null>optional—
path_prefixqueryanyOf<string | null>optional—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
dataobject[]required——
data[]objectoptional——
data[].request_idstringrequired——
data[].methodstringrequired——
data[].pathstringrequired——
data[].status_codeintegerrequired——
data[].latency_msintegerrequired——
data[].api_key_idanyOf<string | null>optional——
data[].api_key_id · variant 1stringoptional——
data[].api_key_id · variant 2nulloptional——
data[].auth_typestringrequired——
data[].user_agentanyOf<string | null>optional——
data[].user_agent · variant 1stringoptional——
data[].user_agent · variant 2nulloptional——
data[].created_atstringrequired——
paginationobjectrequired——
pagination.nextanyOf<string | null>optional——
pagination.next · variant 1stringoptional——
pagination.next · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
request_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
request_idstringrequired——
methodstringrequired——
pathstringrequired——
status_codeintegerrequired——
latency_msintegerrequired——
api_key_idanyOf<string | null>optional——
api_key_id · variant 1stringoptional——
api_key_id · variant 2nulloptional——
auth_typestringrequired——
user_agentanyOf<string | null>optional——
user_agent · variant 1stringoptional——
user_agent · variant 2nulloptional——
created_atstringrequired——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
account_idstringrequired——
actor_idstringrequired——
auth_typestringrequired——
environmentstringrequired——
access_tierstringoptional—
enum: "sandbox", "paid"default: "paid"
scopesstring[]required——
roleanyOf<string | null>optional——
role · variant 1stringoptional——
role · variant 2nulloptional——
authorized_partyanyOf<string | null>optional——
authorized_party · variant 1stringoptional——
authorized_party · variant 2nulloptional——
limitsanyOf<object | null>optional——
limits · variant 1objectoptional——
limits · variant 1.monthly_callsanyOf<integer | null>optional——
limits · variant 1.monthly_calls · variant 1integeroptional——
limits · variant 1.monthly_calls · variant 2nulloptional——
limits · variant 1.rate_limit_per_minuteanyOf<integer | null>optional——
limits · variant 1.rate_limit_per_minute · variant 1integeroptional——
limits · variant 1.rate_limit_per_minute · variant 2nulloptional——
limits · variant 1.daily_requestsanyOf<integer | null>optional——
limits · variant 1.daily_requests · variant 1integeroptional——
limits · variant 1.daily_requests · variant 2nulloptional——
limits · variant 1.concurrencyanyOf<integer | null>optional——
limits · variant 1.concurrency · variant 1integeroptional——
limits · variant 1.concurrency · variant 2nulloptional——
limits · variant 1.max_file_mbanyOf<integer | null>optional——
limits · variant 1.max_file_mb · variant 1integeroptional——
limits · variant 1.max_file_mb · variant 2nulloptional——
limits · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
GET/v1/operationsOperationsDiscovery#

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

AuthenticationPublic / no operation-level security requirement

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
dataobject[]required——
data[]objectoptional——
data[].operationstringrequired——
data[].categorystringrequired—
enum: "import", "processing", "export"
data[].descriptionstringrequired——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
account_idstringrequired——
environmentstringrequired——
scopedbooleanrequired——
project_idanyOf<string | null>optional——
project_id · variant 1stringoptional——
project_id · variant 2nulloptional——
project_nameanyOf<string | null>optional——
project_name · variant 1stringoptional——
project_name · variant 2nulloptional——
project_sluganyOf<string | null>optional——
project_slug · variant 1stringoptional——
project_slug · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
GET/v1/project/legacy-migrationPreview Legacy MigrationAuthentication · Projects#

Preview account/environment resources still in the legacy namespace.

Authentication
ConverterHQBearerhttp / bearer

Responses

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

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

Authentication
ConverterHQBearerhttp / bearer

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
confirm_project_idstringrequired—
min length: 1max length: 64

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
bodyobjectrequired——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
tokenstringrequired——
expires_atstringrequired—
format: date-time
websocket_urlstringrequired——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
bodyobjectrequired——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
fixture_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
bodyobjectrequired——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
bodyobject[]required——
items[]objectoptional——
items[].idstringrequired——
items[].namestringrequired——
items[].workflow_idanyOf<string | null>optional——
items[].workflow_id · variant 1stringoptional——
items[].workflow_id · variant 2nulloptional——
items[].workflow_versionanyOf<integer | null>optional——
items[].workflow_version · variant 1integeroptional——
items[].workflow_version · variant 2nulloptional——
items[].inline_definitionanyOf<object | null>optional——
items[].inline_definition · variant 1objectoptional——
items[].inline_definition · variant 2nulloptional——
items[].variables_schemaobjectrequired——
items[].allowed_source_hostsstring[]required——
items[].max_file_size_bytesanyOf<integer | null>optional——
items[].max_file_size_bytes · variant 1integeroptional——
items[].max_file_size_bytes · variant 2nulloptional——
items[].max_credits_per_requestanyOf<string | null>optional——
items[].max_credits_per_request · variant 1stringoptional——
items[].max_credits_per_request · variant 2nulloptional——
items[].max_usesanyOf<integer | null>optional——
items[].max_uses · variant 1integeroptional——
items[].max_uses · variant 2nulloptional——
items[].use_countintegerrequired——
items[].cache_ttl_secondsintegerrequired——
items[].enabledbooleanrequired——
items[].created_atstringrequired—
format: date-time
items[].updated_atstringrequired—
format: date-time
items[].signing_secretanyOf<string | null>optional——
items[].signing_secret · variant 1stringoptional——
items[].signing_secret · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
namestringrequired—
min length: 1max length: 255
workflow_idanyOf<string | null>optional——
workflow_id · variant 1stringoptional——
workflow_id · variant 2nulloptional——
inline_definitionanyOf<object | null>optional——
inline_definition · variant 1objectoptional——
inline_definition · variant 1.tasksobjectrequired——
inline_definition · variant 1.taganyOf<string | null>optional——
inline_definition · variant 1.tag · variant 1stringoptional—
max length: 255
inline_definition · variant 1.tag · variant 2nulloptional——
inline_definition · variant 1.client_reference_idanyOf<string | null>optional——
inline_definition · variant 1.client_reference_id · variant 1stringoptional—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nulloptional——
inline_definition · variant 1.metadataobjectoptional——
inline_definition · variant 1.prioritystringoptional—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>optional——
inline_definition · variant 1.retention_seconds · variant 1integeroptional—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nulloptional——
inline_definition · variant 2nulloptional——
variables_schemaobjectoptional——
allowed_source_hostsstring[]optional——
max_file_size_bytesanyOf<integer | null>optional——
max_file_size_bytes · variant 1integeroptional——
max_file_size_bytes · variant 2nulloptional——
max_credits_per_requestanyOf<string | null>optional——
max_credits_per_request · variant 1stringoptional—
max length: 64
max_credits_per_request · variant 2nulloptional——
max_usesanyOf<integer | null>optional——
max_uses · variant 1integeroptional——
max_uses · variant 2nulloptional——
cache_ttl_secondsintegeroptional—
default: 0min: 0max: 86400

Responses

201Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
namestringrequired——
workflow_idanyOf<string | null>optional——
workflow_id · variant 1stringoptional——
workflow_id · variant 2nulloptional——
workflow_versionanyOf<integer | null>optional——
workflow_version · variant 1integeroptional——
workflow_version · variant 2nulloptional——
inline_definitionanyOf<object | null>optional——
inline_definition · variant 1objectoptional——
inline_definition · variant 2nulloptional——
variables_schemaobjectrequired——
allowed_source_hostsstring[]required——
max_file_size_bytesanyOf<integer | null>optional——
max_file_size_bytes · variant 1integeroptional——
max_file_size_bytes · variant 2nulloptional——
max_credits_per_requestanyOf<string | null>optional——
max_credits_per_request · variant 1stringoptional——
max_credits_per_request · variant 2nulloptional——
max_usesanyOf<integer | null>optional——
max_uses · variant 1integeroptional——
max_uses · variant 2nulloptional——
use_countintegerrequired——
cache_ttl_secondsintegerrequired——
enabledbooleanrequired——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
signing_secretanyOf<string | null>optional——
signing_secret · variant 1stringoptional——
signing_secret · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
base_idpathstringrequired—

Responses

204Successful Response

No response body.

400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
base_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
namestringrequired——
workflow_idanyOf<string | null>optional——
workflow_id · variant 1stringoptional——
workflow_id · variant 2nulloptional——
workflow_versionanyOf<integer | null>optional——
workflow_version · variant 1integeroptional——
workflow_version · variant 2nulloptional——
inline_definitionanyOf<object | null>optional——
inline_definition · variant 1objectoptional——
inline_definition · variant 2nulloptional——
variables_schemaobjectrequired——
allowed_source_hostsstring[]required——
max_file_size_bytesanyOf<integer | null>optional——
max_file_size_bytes · variant 1integeroptional——
max_file_size_bytes · variant 2nulloptional——
max_credits_per_requestanyOf<string | null>optional——
max_credits_per_request · variant 1stringoptional——
max_credits_per_request · variant 2nulloptional——
max_usesanyOf<integer | null>optional——
max_uses · variant 1integeroptional——
max_uses · variant 2nulloptional——
use_countintegerrequired——
cache_ttl_secondsintegerrequired——
enabledbooleanrequired——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
signing_secretanyOf<string | null>optional——
signing_secret · variant 1stringoptional——
signing_secret · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
base_idpathstringrequired—

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
nameanyOf<string | null>optional——
name · variant 1stringoptional—
min length: 1max length: 255
name · variant 2nulloptional——
workflow_idanyOf<string | null>optional——
workflow_id · variant 1stringoptional——
workflow_id · variant 2nulloptional——
inline_definitionanyOf<object | null>optional——
inline_definition · variant 1objectoptional——
inline_definition · variant 1.tasksobjectrequired——
inline_definition · variant 1.taganyOf<string | null>optional——
inline_definition · variant 1.tag · variant 1stringoptional—
max length: 255
inline_definition · variant 1.tag · variant 2nulloptional——
inline_definition · variant 1.client_reference_idanyOf<string | null>optional——
inline_definition · variant 1.client_reference_id · variant 1stringoptional—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nulloptional——
inline_definition · variant 1.metadataobjectoptional——
inline_definition · variant 1.prioritystringoptional—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>optional——
inline_definition · variant 1.retention_seconds · variant 1integeroptional—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nulloptional——
inline_definition · variant 2nulloptional——
variables_schemaanyOf<object | null>optional——
variables_schema · variant 1objectoptional——
variables_schema · variant 2nulloptional——
allowed_source_hostsanyOf<string[] | null>optional——
allowed_source_hosts · variant 1string[]optional——
allowed_source_hosts · variant 2nulloptional——
max_file_size_bytesanyOf<integer | null>optional——
max_file_size_bytes · variant 1integeroptional——
max_file_size_bytes · variant 2nulloptional——
max_credits_per_requestanyOf<string | null>optional——
max_credits_per_request · variant 1stringoptional—
max length: 64
max_credits_per_request · variant 2nulloptional——
max_usesanyOf<integer | null>optional——
max_uses · variant 1integeroptional——
max_uses · variant 2nulloptional——
cache_ttl_secondsanyOf<integer | null>optional——
cache_ttl_seconds · variant 1integeroptional—
min: 0max: 86400
cache_ttl_seconds · variant 2nulloptional——
enabledanyOf<boolean | null>optional——
enabled · variant 1booleanoptional——
enabled · variant 2nulloptional——

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
namestringrequired——
workflow_idanyOf<string | null>optional——
workflow_id · variant 1stringoptional——
workflow_id · variant 2nulloptional——
workflow_versionanyOf<integer | null>optional——
workflow_version · variant 1integeroptional——
workflow_version · variant 2nulloptional——
inline_definitionanyOf<object | null>optional——
inline_definition · variant 1objectoptional——
inline_definition · variant 2nulloptional——
variables_schemaobjectrequired——
allowed_source_hostsstring[]required——
max_file_size_bytesanyOf<integer | null>optional——
max_file_size_bytes · variant 1integeroptional——
max_file_size_bytes · variant 2nulloptional——
max_credits_per_requestanyOf<string | null>optional——
max_credits_per_request · variant 1stringoptional——
max_credits_per_request · variant 2nulloptional——
max_usesanyOf<integer | null>optional——
max_uses · variant 1integeroptional——
max_uses · variant 2nulloptional——
use_countintegerrequired——
cache_ttl_secondsintegerrequired——
enabledbooleanrequired——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
signing_secretanyOf<string | null>optional——
signing_secret · variant 1stringoptional——
signing_secret · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
base_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
namestringrequired——
workflow_idanyOf<string | null>optional——
workflow_id · variant 1stringoptional——
workflow_id · variant 2nulloptional——
workflow_versionanyOf<integer | null>optional——
workflow_version · variant 1integeroptional——
workflow_version · variant 2nulloptional——
inline_definitionanyOf<object | null>optional——
inline_definition · variant 1objectoptional——
inline_definition · variant 2nulloptional——
variables_schemaobjectrequired——
allowed_source_hostsstring[]required——
max_file_size_bytesanyOf<integer | null>optional——
max_file_size_bytes · variant 1integeroptional——
max_file_size_bytes · variant 2nulloptional——
max_credits_per_requestanyOf<string | null>optional——
max_credits_per_request · variant 1stringoptional——
max_credits_per_request · variant 2nulloptional——
max_usesanyOf<integer | null>optional——
max_uses · variant 1integeroptional——
max_uses · variant 2nulloptional——
use_countintegerrequired——
cache_ttl_secondsintegerrequired——
enabledbooleanrequired——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
signing_secretanyOf<string | null>optional——
signing_secret · variant 1stringoptional——
signing_secret · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
base_idpathstringrequired—

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
variablesobjectoptional——
expires_inintegeroptional—
default: 3600min: 60max: 86400
cache_keyanyOf<string | null>optional——
cache_key · variant 1stringoptional—
max length: 255
cache_key · variant 2nulloptional——

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
urlstringrequired——
expires_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

AuthenticationPublic / no operation-level security requirement

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
statusstringrequired—
enum: "ok", "degraded"
servicestringoptional—
default: "converterhq-api"
api_versionstringoptional—
default: "v1"
timestampstringrequired—
format: date-time
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

AuthenticationPublic / no operation-level security requirement

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
successful_conversionsintegerrequired——
input_bytes_processedintegerrequired——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
task_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
job_idstringrequired——
namestringrequired——
operationstringrequired——
statusstringrequired——
progressintegerrequired——
inputobjectrequired——
optionsobjectrequired——
resultobjectrequired——
requiredbooleanrequired——
runtime_classstringrequired——
prioritystringrequired——
attempt_countintegerrequired——
max_attemptsintegerrequired——
error_codeanyOf<string | null>optional——
error_code · variant 1stringoptional——
error_code · variant 2nulloptional——
error_messageanyOf<string | null>optional——
error_message · variant 1stringoptional——
error_message · variant 2nulloptional——
created_atstringrequired—
format: date-time
queued_atanyOf<string | null>optional——
queued_at · variant 1stringoptional—
format: date-time
queued_at · variant 2nulloptional——
started_atanyOf<string | null>optional——
started_at · variant 1stringoptional—
format: date-time
started_at · variant 2nulloptional——
completed_atanyOf<string | null>optional——
completed_at · variant 1stringoptional—
format: date-time
completed_at · variant 2nulloptional——
attemptsobject[]optional——
attempts[]objectoptional——
attempts[].idstringrequired——
attempts[].attempt_numberintegerrequired——
attempts[].statusstringrequired——
attempts[].worker_idanyOf<string | null>optional——
attempts[].worker_id · variant 1stringoptional——
attempts[].worker_id · variant 2nulloptional——
attempts[].runtime_classanyOf<string | null>optional——
attempts[].runtime_class · variant 1stringoptional——
attempts[].runtime_class · variant 2nulloptional——
attempts[].regionanyOf<string | null>optional——
attempts[].region · variant 1stringoptional——
attempts[].region · variant 2nulloptional——
attempts[].engineanyOf<string | null>optional——
attempts[].engine · variant 1stringoptional——
attempts[].engine · variant 2nulloptional——
attempts[].engine_versionanyOf<string | null>optional——
attempts[].engine_version · variant 1stringoptional——
attempts[].engine_version · variant 2nulloptional——
attempts[].input_bytesanyOf<integer | null>optional——
attempts[].input_bytes · variant 1integeroptional——
attempts[].input_bytes · variant 2nulloptional——
attempts[].output_bytesanyOf<integer | null>optional——
attempts[].output_bytes · variant 1integeroptional——
attempts[].output_bytes · variant 2nulloptional——
attempts[].wall_msanyOf<integer | null>optional——
attempts[].wall_ms · variant 1integeroptional——
attempts[].wall_ms · variant 2nulloptional——
attempts[].cpu_msanyOf<integer | null>optional——
attempts[].cpu_ms · variant 1integeroptional——
attempts[].cpu_ms · variant 2nulloptional——
attempts[].peak_memory_mbanyOf<integer | null>optional——
attempts[].peak_memory_mb · variant 1integeroptional——
attempts[].peak_memory_mb · variant 2nulloptional——
attempts[].temp_bytesanyOf<integer | null>optional——
attempts[].temp_bytes · variant 1integeroptional——
attempts[].temp_bytes · variant 2nulloptional——
attempts[].error_codeanyOf<string | null>optional——
attempts[].error_code · variant 1stringoptional——
attempts[].error_code · variant 2nulloptional——
attempts[].error_messageanyOf<string | null>optional——
attempts[].error_message · variant 1stringoptional——
attempts[].error_message · variant 2nulloptional——
attempts[].estimated_creditsanyOf<string | null>optional——
attempts[].estimated_credits · variant 1stringoptional——
attempts[].estimated_credits · variant 2nulloptional——
attempts[].settled_creditsanyOf<string | null>optional——
attempts[].settled_credits · variant 1stringoptional——
attempts[].settled_credits · variant 2nulloptional——
attempts[].external_side_effect_started_atanyOf<string | null>optional——
attempts[].external_side_effect_started_at · variant 1stringoptional—
format: date-time
attempts[].external_side_effect_started_at · variant 2nulloptional——
attempts[].external_side_effect_committed_atanyOf<string | null>optional——
attempts[].external_side_effect_committed_at · variant 1stringoptional—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nulloptional——
attempts[].started_atstringrequired—
format: date-time
attempts[].completed_atanyOf<string | null>optional——
attempts[].completed_at · variant 1stringoptional—
format: date-time
attempts[].completed_at · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
task_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
job_idstringrequired——
namestringrequired——
operationstringrequired——
statusstringrequired——
progressintegerrequired——
inputobjectrequired——
optionsobjectrequired——
resultobjectrequired——
requiredbooleanrequired——
runtime_classstringrequired——
prioritystringrequired——
attempt_countintegerrequired——
max_attemptsintegerrequired——
error_codeanyOf<string | null>optional——
error_code · variant 1stringoptional——
error_code · variant 2nulloptional——
error_messageanyOf<string | null>optional——
error_message · variant 1stringoptional——
error_message · variant 2nulloptional——
created_atstringrequired—
format: date-time
queued_atanyOf<string | null>optional——
queued_at · variant 1stringoptional—
format: date-time
queued_at · variant 2nulloptional——
started_atanyOf<string | null>optional——
started_at · variant 1stringoptional—
format: date-time
started_at · variant 2nulloptional——
completed_atanyOf<string | null>optional——
completed_at · variant 1stringoptional—
format: date-time
completed_at · variant 2nulloptional——
attemptsobject[]optional——
attempts[]objectoptional——
attempts[].idstringrequired——
attempts[].attempt_numberintegerrequired——
attempts[].statusstringrequired——
attempts[].worker_idanyOf<string | null>optional——
attempts[].worker_id · variant 1stringoptional——
attempts[].worker_id · variant 2nulloptional——
attempts[].runtime_classanyOf<string | null>optional——
attempts[].runtime_class · variant 1stringoptional——
attempts[].runtime_class · variant 2nulloptional——
attempts[].regionanyOf<string | null>optional——
attempts[].region · variant 1stringoptional——
attempts[].region · variant 2nulloptional——
attempts[].engineanyOf<string | null>optional——
attempts[].engine · variant 1stringoptional——
attempts[].engine · variant 2nulloptional——
attempts[].engine_versionanyOf<string | null>optional——
attempts[].engine_version · variant 1stringoptional——
attempts[].engine_version · variant 2nulloptional——
attempts[].input_bytesanyOf<integer | null>optional——
attempts[].input_bytes · variant 1integeroptional——
attempts[].input_bytes · variant 2nulloptional——
attempts[].output_bytesanyOf<integer | null>optional——
attempts[].output_bytes · variant 1integeroptional——
attempts[].output_bytes · variant 2nulloptional——
attempts[].wall_msanyOf<integer | null>optional——
attempts[].wall_ms · variant 1integeroptional——
attempts[].wall_ms · variant 2nulloptional——
attempts[].cpu_msanyOf<integer | null>optional——
attempts[].cpu_ms · variant 1integeroptional——
attempts[].cpu_ms · variant 2nulloptional——
attempts[].peak_memory_mbanyOf<integer | null>optional——
attempts[].peak_memory_mb · variant 1integeroptional——
attempts[].peak_memory_mb · variant 2nulloptional——
attempts[].temp_bytesanyOf<integer | null>optional——
attempts[].temp_bytes · variant 1integeroptional——
attempts[].temp_bytes · variant 2nulloptional——
attempts[].error_codeanyOf<string | null>optional——
attempts[].error_code · variant 1stringoptional——
attempts[].error_code · variant 2nulloptional——
attempts[].error_messageanyOf<string | null>optional——
attempts[].error_message · variant 1stringoptional——
attempts[].error_message · variant 2nulloptional——
attempts[].estimated_creditsanyOf<string | null>optional——
attempts[].estimated_credits · variant 1stringoptional——
attempts[].estimated_credits · variant 2nulloptional——
attempts[].settled_creditsanyOf<string | null>optional——
attempts[].settled_credits · variant 1stringoptional——
attempts[].settled_credits · variant 2nulloptional——
attempts[].external_side_effect_started_atanyOf<string | null>optional——
attempts[].external_side_effect_started_at · variant 1stringoptional—
format: date-time
attempts[].external_side_effect_started_at · variant 2nulloptional——
attempts[].external_side_effect_committed_atanyOf<string | null>optional——
attempts[].external_side_effect_committed_at · variant 1stringoptional—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nulloptional——
attempts[].started_atstringrequired—
format: date-time
attempts[].completed_atanyOf<string | null>optional——
attempts[].completed_at · variant 1stringoptional—
format: date-time
attempts[].completed_at · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
task_idpathstringrequired—
timeoutqueryintegeroptional
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>optional—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
bodyunknownrequired——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
task_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
job_idstringrequired——
namestringrequired——
operationstringrequired——
statusstringrequired——
progressintegerrequired——
inputobjectrequired——
optionsobjectrequired——
resultobjectrequired——
requiredbooleanrequired——
runtime_classstringrequired——
prioritystringrequired——
attempt_countintegerrequired——
max_attemptsintegerrequired——
error_codeanyOf<string | null>optional——
error_code · variant 1stringoptional——
error_code · variant 2nulloptional——
error_messageanyOf<string | null>optional——
error_message · variant 1stringoptional——
error_message · variant 2nulloptional——
created_atstringrequired—
format: date-time
queued_atanyOf<string | null>optional——
queued_at · variant 1stringoptional—
format: date-time
queued_at · variant 2nulloptional——
started_atanyOf<string | null>optional——
started_at · variant 1stringoptional—
format: date-time
started_at · variant 2nulloptional——
completed_atanyOf<string | null>optional——
completed_at · variant 1stringoptional—
format: date-time
completed_at · variant 2nulloptional——
attemptsobject[]optional——
attempts[]objectoptional——
attempts[].idstringrequired——
attempts[].attempt_numberintegerrequired——
attempts[].statusstringrequired——
attempts[].worker_idanyOf<string | null>optional——
attempts[].worker_id · variant 1stringoptional——
attempts[].worker_id · variant 2nulloptional——
attempts[].runtime_classanyOf<string | null>optional——
attempts[].runtime_class · variant 1stringoptional——
attempts[].runtime_class · variant 2nulloptional——
attempts[].regionanyOf<string | null>optional——
attempts[].region · variant 1stringoptional——
attempts[].region · variant 2nulloptional——
attempts[].engineanyOf<string | null>optional——
attempts[].engine · variant 1stringoptional——
attempts[].engine · variant 2nulloptional——
attempts[].engine_versionanyOf<string | null>optional——
attempts[].engine_version · variant 1stringoptional——
attempts[].engine_version · variant 2nulloptional——
attempts[].input_bytesanyOf<integer | null>optional——
attempts[].input_bytes · variant 1integeroptional——
attempts[].input_bytes · variant 2nulloptional——
attempts[].output_bytesanyOf<integer | null>optional——
attempts[].output_bytes · variant 1integeroptional——
attempts[].output_bytes · variant 2nulloptional——
attempts[].wall_msanyOf<integer | null>optional——
attempts[].wall_ms · variant 1integeroptional——
attempts[].wall_ms · variant 2nulloptional——
attempts[].cpu_msanyOf<integer | null>optional——
attempts[].cpu_ms · variant 1integeroptional——
attempts[].cpu_ms · variant 2nulloptional——
attempts[].peak_memory_mbanyOf<integer | null>optional——
attempts[].peak_memory_mb · variant 1integeroptional——
attempts[].peak_memory_mb · variant 2nulloptional——
attempts[].temp_bytesanyOf<integer | null>optional——
attempts[].temp_bytes · variant 1integeroptional——
attempts[].temp_bytes · variant 2nulloptional——
attempts[].error_codeanyOf<string | null>optional——
attempts[].error_code · variant 1stringoptional——
attempts[].error_code · variant 2nulloptional——
attempts[].error_messageanyOf<string | null>optional——
attempts[].error_message · variant 1stringoptional——
attempts[].error_message · variant 2nulloptional——
attempts[].estimated_creditsanyOf<string | null>optional——
attempts[].estimated_credits · variant 1stringoptional——
attempts[].estimated_credits · variant 2nulloptional——
attempts[].settled_creditsanyOf<string | null>optional——
attempts[].settled_credits · variant 1stringoptional——
attempts[].settled_credits · variant 2nulloptional——
attempts[].external_side_effect_started_atanyOf<string | null>optional——
attempts[].external_side_effect_started_at · variant 1stringoptional—
format: date-time
attempts[].external_side_effect_started_at · variant 2nulloptional——
attempts[].external_side_effect_committed_atanyOf<string | null>optional——
attempts[].external_side_effect_committed_at · variant 1stringoptional—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nulloptional——
attempts[].started_atstringrequired—
format: date-time
attempts[].completed_atanyOf<string | null>optional——
attempts[].completed_at · variant 1stringoptional—
format: date-time
attempts[].completed_at · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
limitqueryintegeroptional
default: 50min: 1max: 200
afterqueryanyOf<string | null>optional—
input_formatqueryanyOf<string | null>optional—
output_formatqueryanyOf<string | null>optional—
originqueryanyOf<string | null>optional—
outcomequeryanyOf<string | null>optional—
job_idqueryanyOf<string | null>optional—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
dataobject[]required——
data[]objectoptional——
data[].idstringrequired——
data[].api_key_idanyOf<string | null>optional——
data[].api_key_id · variant 1stringoptional——
data[].api_key_id · variant 2nulloptional——
data[].originstringrequired——
data[].outcomestringoptional—
default: "succeeded"
data[].job_idanyOf<string | null>optional——
data[].job_id · variant 1stringoptional——
data[].job_id · variant 2nulloptional——
data[].task_idanyOf<string | null>optional——
data[].task_id · variant 1stringoptional——
data[].task_id · variant 2nulloptional——
data[].input_formatanyOf<string | null>optional——
data[].input_format · variant 1stringoptional——
data[].input_format · variant 2nulloptional——
data[].output_formatanyOf<string | null>optional——
data[].output_format · variant 1stringoptional——
data[].output_format · variant 2nulloptional——
data[].engineanyOf<string | null>optional——
data[].engine · variant 1stringoptional——
data[].engine · variant 2nulloptional——
data[].engine_versionanyOf<string | null>optional——
data[].engine_version · variant 1stringoptional——
data[].engine_version · variant 2nulloptional——
data[].runtime_classanyOf<string | null>optional——
data[].runtime_class · variant 1stringoptional——
data[].runtime_class · variant 2nulloptional——
data[].input_bytesanyOf<integer | null>optional——
data[].input_bytes · variant 1integeroptional——
data[].input_bytes · variant 2nulloptional——
data[].output_bytesanyOf<integer | null>optional——
data[].output_bytes · variant 1integeroptional——
data[].output_bytes · variant 2nulloptional——
data[].wall_msanyOf<integer | null>optional——
data[].wall_ms · variant 1integeroptional——
data[].wall_ms · variant 2nulloptional——
data[].creditsanyOf<string | null>optional——
data[].credits · variant 1stringoptional——
data[].credits · variant 2nulloptional——
data[].created_atstringrequired—
format: date-time
paginationobjectrequired——
pagination.nextanyOf<string | null>optional——
pagination.next · variant 1stringoptional——
pagination.next · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
startqueryanyOf<string | null>optional—
endqueryanyOf<string | null>optional—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
startstringrequired—
format: date-time
endstringrequired—
format: date-time
conversionsintegerrequired——
creditsstringrequired——
input_bytesintegerrequired——
output_bytesintegerrequired——
wall_msintegerrequired——
by_originobject[]optional——
by_origin[]objectoptional——
by_origin[].keystringrequired——
by_origin[].conversionsintegerrequired——
by_origin[].creditsstringrequired——
top_pairsobject[]optional——
top_pairs[]objectoptional——
top_pairs[].keystringrequired——
top_pairs[].conversionsintegerrequired——
top_pairs[].creditsstringrequired——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
delivery_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
webhook_idstringrequired——
event_idstringrequired——
statusstringrequired——
attemptintegerrequired——
request_headersobjectrequired——
request_bodyobjectrequired——
response_statusanyOf<integer | null>optional——
response_status · variant 1integeroptional——
response_status · variant 2nulloptional——
response_bodyanyOf<string | null>optional——
response_body · variant 1stringoptional——
response_body · variant 2nulloptional——
latency_msanyOf<integer | null>optional——
latency_ms · variant 1integeroptional——
latency_ms · variant 2nulloptional——
error_messageanyOf<string | null>optional——
error_message · variant 1stringoptional——
error_message · variant 2nulloptional——
next_retry_atanyOf<string | null>optional——
next_retry_at · variant 1stringoptional—
format: date-time
next_retry_at · variant 2nulloptional——
delivered_atanyOf<string | null>optional——
delivered_at · variant 1stringoptional—
format: date-time
delivered_at · variant 2nulloptional——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
delivery_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
webhook_idstringrequired——
event_idstringrequired——
statusstringrequired——
attemptintegerrequired——
request_headersobjectrequired——
request_bodyobjectrequired——
response_statusanyOf<integer | null>optional——
response_status · variant 1integeroptional——
response_status · variant 2nulloptional——
response_bodyanyOf<string | null>optional——
response_body · variant 1stringoptional——
response_body · variant 2nulloptional——
latency_msanyOf<integer | null>optional——
latency_ms · variant 1integeroptional——
latency_ms · variant 2nulloptional——
error_messageanyOf<string | null>optional——
error_message · variant 1stringoptional——
error_message · variant 2nulloptional——
next_retry_atanyOf<string | null>optional——
next_retry_at · variant 1stringoptional—
format: date-time
next_retry_at · variant 2nulloptional——
delivered_atanyOf<string | null>optional——
delivered_at · variant 1stringoptional—
format: date-time
delivered_at · variant 2nulloptional——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
bodyobject[]required——
items[]objectoptional——
items[].idstringrequired——
items[].urlstringrequired——
items[].descriptionanyOf<string | null>optional——
items[].description · variant 1stringoptional——
items[].description · variant 2nulloptional——
items[].event_typesstring[]required——
items[].enabledbooleanrequired——
items[].failure_countintegerrequired——
items[].created_atstringrequired—
format: date-time
items[].updated_atstringrequired—
format: date-time
items[].signing_secretanyOf<string | null>optional——
items[].signing_secret · variant 1stringoptional——
items[].signing_secret · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
urlstringrequired—
min length: 1max length: 2048
descriptionanyOf<string | null>optional——
description · variant 1stringoptional—
max length: 512
description · variant 2nulloptional——
event_typesstring[]optional——

Responses

201Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
urlstringrequired——
descriptionanyOf<string | null>optional——
description · variant 1stringoptional——
description · variant 2nulloptional——
event_typesstring[]required——
enabledbooleanrequired——
failure_countintegerrequired——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
signing_secretanyOf<string | null>optional——
signing_secret · variant 1stringoptional——
signing_secret · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
webhook_idpathstringrequired—

Responses

204Successful Response

No response body.

400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
webhook_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
urlstringrequired——
descriptionanyOf<string | null>optional——
description · variant 1stringoptional——
description · variant 2nulloptional——
event_typesstring[]required——
enabledbooleanrequired——
failure_countintegerrequired——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
signing_secretanyOf<string | null>optional——
signing_secret · variant 1stringoptional——
signing_secret · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
webhook_idpathstringrequired—

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
urlanyOf<string | null>optional——
url · variant 1stringoptional—
min length: 1max length: 2048
url · variant 2nulloptional——
descriptionanyOf<string | null>optional——
description · variant 1stringoptional—
max length: 512
description · variant 2nulloptional——
event_typesanyOf<string[] | null>optional——
event_types · variant 1string[]optional——
event_types · variant 2nulloptional——
enabledanyOf<boolean | null>optional——
enabled · variant 1booleanoptional——
enabled · variant 2nulloptional——

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
urlstringrequired——
descriptionanyOf<string | null>optional——
description · variant 1stringoptional——
description · variant 2nulloptional——
event_typesstring[]required——
enabledbooleanrequired——
failure_countintegerrequired——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
signing_secretanyOf<string | null>optional——
signing_secret · variant 1stringoptional——
signing_secret · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
webhook_idpathstringrequired—
limitqueryintegeroptional
default: 50min: 1max: 100
afterqueryanyOf<string | null>optional—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
dataobject[]required——
data[]objectoptional——
data[].idstringrequired——
data[].webhook_idstringrequired——
data[].event_idstringrequired——
data[].statusstringrequired——
data[].attemptintegerrequired——
data[].request_headersobjectrequired——
data[].request_bodyobjectrequired——
data[].response_statusanyOf<integer | null>optional——
data[].response_status · variant 1integeroptional——
data[].response_status · variant 2nulloptional——
data[].response_bodyanyOf<string | null>optional——
data[].response_body · variant 1stringoptional——
data[].response_body · variant 2nulloptional——
data[].latency_msanyOf<integer | null>optional——
data[].latency_ms · variant 1integeroptional——
data[].latency_ms · variant 2nulloptional——
data[].error_messageanyOf<string | null>optional——
data[].error_message · variant 1stringoptional——
data[].error_message · variant 2nulloptional——
data[].next_retry_atanyOf<string | null>optional——
data[].next_retry_at · variant 1stringoptional—
format: date-time
data[].next_retry_at · variant 2nulloptional——
data[].delivered_atanyOf<string | null>optional——
data[].delivered_at · variant 1stringoptional—
format: date-time
data[].delivered_at · variant 2nulloptional——
data[].created_atstringrequired—
format: date-time
data[].updated_atstringrequired—
format: date-time
paginationobjectrequired——
pagination.nextanyOf<string | null>optional——
pagination.next · variant 1stringoptional——
pagination.next · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
webhook_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
signing_secretstringrequired——
previous_secret_valid_untilanyOf<string | null>optional——
previous_secret_valid_until · variant 1stringoptional—
format: date-time
previous_secret_valid_until · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
limitqueryintegeroptional
default: 50min: 1max: 200
afterqueryanyOf<string | null>optional—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
dataobject[]required——
data[]objectoptional——
data[].idstringrequired——
data[].namestringrequired——
data[].descriptionanyOf<string | null>optional——
data[].description · variant 1stringoptional——
data[].description · variant 2nulloptional——
data[].current_versionintegerrequired——
data[].definitionobjectrequired——
data[].variables_schemaobjectrequired——
data[].metadataobjectrequired——
data[].created_atstringrequired—
format: date-time
data[].updated_atstringrequired—
format: date-time
paginationobjectrequired——
pagination.nextanyOf<string | null>optional——
pagination.next · variant 1stringoptional——
pagination.next · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
namestringrequired—
min length: 1max length: 255
descriptionanyOf<string | null>optional——
description · variant 1stringoptional—
max length: 2000
description · variant 2nulloptional——
definitionobjectrequired——
definition.tasksobjectrequired——
definition.taganyOf<string | null>optional——
definition.tag · variant 1stringoptional—
max length: 255
definition.tag · variant 2nulloptional——
definition.client_reference_idanyOf<string | null>optional——
definition.client_reference_id · variant 1stringoptional—
max length: 255
definition.client_reference_id · variant 2nulloptional——
definition.metadataobjectoptional——
definition.prioritystringoptional—
enum: "low", "normal", "high"default: "normal"
definition.retention_secondsanyOf<integer | null>optional——
definition.retention_seconds · variant 1integeroptional—
min: 0max: 86400
definition.retention_seconds · variant 2nulloptional——
variables_schemaobjectoptional——
metadataobjectoptional——

Responses

201Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
namestringrequired——
descriptionanyOf<string | null>optional——
description · variant 1stringoptional——
description · variant 2nulloptional——
current_versionintegerrequired——
definitionobjectrequired——
variables_schemaobjectrequired——
metadataobjectrequired——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
workflow_idpathstringrequired—

Responses

204Successful Response

No response body.

400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
workflow_idpathstringrequired—

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
namestringrequired——
descriptionanyOf<string | null>optional——
description · variant 1stringoptional——
description · variant 2nulloptional——
current_versionintegerrequired——
definitionobjectrequired——
variables_schemaobjectrequired——
metadataobjectrequired——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
workflow_idpathstringrequired—

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
nameanyOf<string | null>optional——
name · variant 1stringoptional—
min length: 1max length: 255
name · variant 2nulloptional——
descriptionanyOf<string | null>optional——
description · variant 1stringoptional—
max length: 2000
description · variant 2nulloptional——
definitionanyOf<object | null>optional——
definition · variant 1objectoptional——
definition · variant 1.tasksobjectrequired——
definition · variant 1.taganyOf<string | null>optional——
definition · variant 1.tag · variant 1stringoptional—
max length: 255
definition · variant 1.tag · variant 2nulloptional——
definition · variant 1.client_reference_idanyOf<string | null>optional——
definition · variant 1.client_reference_id · variant 1stringoptional—
max length: 255
definition · variant 1.client_reference_id · variant 2nulloptional——
definition · variant 1.metadataobjectoptional——
definition · variant 1.prioritystringoptional—
enum: "low", "normal", "high"default: "normal"
definition · variant 1.retention_secondsanyOf<integer | null>optional——
definition · variant 1.retention_seconds · variant 1integeroptional—
min: 0max: 86400
definition · variant 1.retention_seconds · variant 2nulloptional——
definition · variant 2nulloptional——
variables_schemaanyOf<object | null>optional——
variables_schema · variant 1objectoptional——
variables_schema · variant 2nulloptional——
metadataanyOf<object | null>optional——
metadata · variant 1objectoptional——
metadata · variant 2nulloptional——

Responses

200Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
namestringrequired——
descriptionanyOf<string | null>optional——
description · variant 1stringoptional——
description · variant 2nulloptional——
current_versionintegerrequired——
definitionobjectrequired——
variables_schemaobjectrequired——
metadataobjectrequired——
created_atstringrequired—
format: date-time
updated_atstringrequired—
format: date-time
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
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.

Authentication
ConverterHQBearerhttp / bearer

Parameters

NameLocationTypeRequiredDescription / constraints
workflow_idpathstringrequired—
Idempotency-KeyheaderanyOf<string | null>optional—

Request body required

application/json
FieldTypeRequiredDescriptionConstraints
variablesobjectoptional——
client_reference_idanyOf<string | null>optional——
client_reference_id · variant 1stringoptional—
max length: 255
client_reference_id · variant 2nulloptional——
metadataobjectoptional——

Responses

201Successful Response
application/json
FieldTypeRequiredDescriptionConstraints
idstringrequired——
kindstringrequired——
statusstringrequired——
progressintegerrequired——
taganyOf<string | null>optional——
tag · variant 1stringoptional——
tag · variant 2nulloptional——
client_reference_idanyOf<string | null>optional——
client_reference_id · variant 1stringoptional——
client_reference_id · variant 2nulloptional——
metadataobjectoptional——
prioritystringrequired——
concurrency_limitintegeroptional—
default: 1
originstringrequired——
created_atstringrequired—
format: date-time
started_atanyOf<string | null>optional——
started_at · variant 1stringoptional—
format: date-time
started_at · variant 2nulloptional——
completed_atanyOf<string | null>optional——
completed_at · variant 1stringoptional—
format: date-time
completed_at · variant 2nulloptional——
error_codeanyOf<string | null>optional——
error_code · variant 1stringoptional——
error_code · variant 2nulloptional——
error_messageanyOf<string | null>optional——
error_message · variant 1stringoptional——
error_message · variant 2nulloptional——
tasksobject[]optional——
tasks[]objectoptional——
tasks[].idstringrequired——
tasks[].job_idstringrequired——
tasks[].namestringrequired——
tasks[].operationstringrequired——
tasks[].statusstringrequired——
tasks[].progressintegerrequired——
tasks[].inputobjectrequired——
tasks[].optionsobjectrequired——
tasks[].resultobjectrequired——
tasks[].requiredbooleanrequired——
tasks[].runtime_classstringrequired——
tasks[].prioritystringrequired——
tasks[].attempt_countintegerrequired——
tasks[].max_attemptsintegerrequired——
tasks[].error_codeanyOf<string | null>optional——
tasks[].error_code · variant 1stringoptional——
tasks[].error_code · variant 2nulloptional——
tasks[].error_messageanyOf<string | null>optional——
tasks[].error_message · variant 1stringoptional——
tasks[].error_message · variant 2nulloptional——
tasks[].created_atstringrequired—
format: date-time
tasks[].queued_atanyOf<string | null>optional——
tasks[].queued_at · variant 1stringoptional—
format: date-time
tasks[].queued_at · variant 2nulloptional——
tasks[].started_atanyOf<string | null>optional——
tasks[].started_at · variant 1stringoptional—
format: date-time
tasks[].started_at · variant 2nulloptional——
tasks[].completed_atanyOf<string | null>optional——
tasks[].completed_at · variant 1stringoptional—
format: date-time
tasks[].completed_at · variant 2nulloptional——
tasks[].attemptsobject[]optional——
tasks[].attempts[]objectoptional——
tasks[].attempts[].idstringrequired——
tasks[].attempts[].attempt_numberintegerrequired——
tasks[].attempts[].statusstringrequired——
tasks[].attempts[].worker_idanyOf<string | null>optional——
tasks[].attempts[].worker_id · variant 1stringoptional——
tasks[].attempts[].worker_id · variant 2nulloptional——
tasks[].attempts[].runtime_classanyOf<string | null>optional——
tasks[].attempts[].runtime_class · variant 1stringoptional——
tasks[].attempts[].runtime_class · variant 2nulloptional——
tasks[].attempts[].regionanyOf<string | null>optional——
tasks[].attempts[].region · variant 1stringoptional——
tasks[].attempts[].region · variant 2nulloptional——
tasks[].attempts[].engineanyOf<string | null>optional——
tasks[].attempts[].engine · variant 1stringoptional——
tasks[].attempts[].engine · variant 2nulloptional——
tasks[].attempts[].engine_versionanyOf<string | null>optional——
tasks[].attempts[].engine_version · variant 1stringoptional——
tasks[].attempts[].engine_version · variant 2nulloptional——
tasks[].attempts[].input_bytesanyOf<integer | null>optional——
tasks[].attempts[].input_bytes · variant 1integeroptional——
tasks[].attempts[].input_bytes · variant 2nulloptional——
tasks[].attempts[].output_bytesanyOf<integer | null>optional——
tasks[].attempts[].output_bytes · variant 1integeroptional——
tasks[].attempts[].output_bytes · variant 2nulloptional——
tasks[].attempts[].wall_msanyOf<integer | null>optional——
tasks[].attempts[].wall_ms · variant 1integeroptional——
tasks[].attempts[].wall_ms · variant 2nulloptional——
tasks[].attempts[].cpu_msanyOf<integer | null>optional——
tasks[].attempts[].cpu_ms · variant 1integeroptional——
tasks[].attempts[].cpu_ms · variant 2nulloptional——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>optional——
tasks[].attempts[].peak_memory_mb · variant 1integeroptional——
tasks[].attempts[].peak_memory_mb · variant 2nulloptional——
tasks[].attempts[].temp_bytesanyOf<integer | null>optional——
tasks[].attempts[].temp_bytes · variant 1integeroptional——
tasks[].attempts[].temp_bytes · variant 2nulloptional——
tasks[].attempts[].error_codeanyOf<string | null>optional——
tasks[].attempts[].error_code · variant 1stringoptional——
tasks[].attempts[].error_code · variant 2nulloptional——
tasks[].attempts[].error_messageanyOf<string | null>optional——
tasks[].attempts[].error_message · variant 1stringoptional——
tasks[].attempts[].error_message · variant 2nulloptional——
tasks[].attempts[].estimated_creditsanyOf<string | null>optional——
tasks[].attempts[].estimated_credits · variant 1stringoptional——
tasks[].attempts[].estimated_credits · variant 2nulloptional——
tasks[].attempts[].settled_creditsanyOf<string | null>optional——
tasks[].attempts[].settled_credits · variant 1stringoptional——
tasks[].attempts[].settled_credits · variant 2nulloptional——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>optional——
tasks[].attempts[].external_side_effect_started_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nulloptional——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>optional——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nulloptional——
tasks[].attempts[].started_atstringrequired—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>optional——
tasks[].attempts[].completed_at · variant 1stringoptional—
format: date-time
tasks[].attempts[].completed_at · variant 2nulloptional——
400The request could not be processed.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
401Authentication is missing or invalid.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
403The principal is not allowed to perform this operation.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
409The request conflicts with the current resource or idempotency state.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
422Validation Error
application/json
FieldTypeRequiredDescriptionConstraints
detailobject[]optional——
detail[]objectoptional——
detail[].locanyOf<string | integer>[]required——
detail[].loc[]anyOf<string | integer>optional——
detail[].loc[] · variant 1stringoptional——
detail[].loc[] · variant 2integeroptional——
detail[].msgstringrequired——
detail[].typestringrequired——
429The caller has exceeded an admission-control limit.
Response headersRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
500An unexpected server error occurred.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——
503A required service is temporarily unavailable.
application/problem+json
FieldTypeRequiredDescriptionConstraints
typestringrequired—
default: "about:blank"
titlestringrequired——
statusintegerrequired—
min: 400max: 599
codestringrequired——
detailstringrequired——
retryablebooleanrequired——
parameteranyOf<string | null>optional——
parameter · variant 1stringoptional——
parameter · variant 2nulloptional——
request_idanyOf<string | null>optional——
request_id · variant 1stringoptional——
request_id · variant 2nulloptional——