ConverterHQDevelopers
Wygenerowano z wybranego publicznego kontraktu OpenAPI

Referencja API REST

Sprawdzaj parametry, uwierzytelnianie, zagnieżdżone pola, schematy odpowiedzi, błędy i wykonywalne przykłady. Trasy konsumenckie, SEO i administracyjne są wyłączone.

74 wyświetlone endpointy74 operacje łącznie17 tagi3.1.0 schemat
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.

UwierzytelnianiePubliczne / brak uwierzytelniania właściwego dla operacji

Parametry

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

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
dataobject[]wymagane——
data[]objectopcjonalne——
data[].supportedbooleanwymagane——
data[].input_formatstringwymagane——
data[].output_formatstringwymagane——
data[].maturitystringopcjonalne—
enum: "stable", "disabled"default: "stable"
data[].settings_scopestringopcjonalneSettings 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[].routeobjectopcjonalne——
data[].route.multi_stepbooleanopcjonalneTrue 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[]opcjonalneSetting 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>opcjonalneStable 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 1stringopcjonalne——
data[].options_version · variant 2nullopcjonalne——
data[].optionsobject[]opcjonalneSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
data[].options[]objectopcjonalne——
data[].options[].namestringwymagane——
data[].options[].typestringwymagane——
data[].options[].labelstringwymagane——
data[].options[].descriptionanyOf<string | null>opcjonalne——
data[].options[].description · variant 1stringopcjonalne——
data[].options[].description · variant 2nullopcjonalne——
data[].options[].requiredbooleanopcjonalne—
default: false
data[].options[].advancedbooleanopcjonalne—
default: false
data[].options[].groupanyOf<string | null>opcjonalne——
data[].options[].group · variant 1stringopcjonalne——
data[].options[].group · variant 2nullopcjonalne——
data[].options[].defaultunknownopcjonalne——
data[].options[].possible_valuesanyOf<unknown[] | null>opcjonalne——
data[].options[].possible_values · variant 1unknown[]opcjonalne——
data[].options[].possible_values · variant 2nullopcjonalne——
data[].options[].minimumanyOf<integer | number | null>opcjonalne——
data[].options[].minimum · variant 1integeropcjonalne——
data[].options[].minimum · variant 2numberopcjonalne——
data[].options[].minimum · variant 3nullopcjonalne——
data[].options[].maximumanyOf<integer | number | null>opcjonalne——
data[].options[].maximum · variant 1integeropcjonalne——
data[].options[].maximum · variant 2numberopcjonalne——
data[].options[].maximum · variant 3nullopcjonalne——
data[].options[].depends_onobject[]opcjonalne——
data[].options[].conflicts_withstring[]opcjonalne——
data[].options[].schemaanyOf<object | null>opcjonalne——
data[].options[].schema · variant 1objectopcjonalne——
data[].options[].schema · variant 2nullopcjonalne——
data[].options_schemaobjectopcjonalneStrict JSON Schema for the settings accepted by this pair-level conversion task.—
data[].limitsobjectopcjonalne——
data[].billingobjectopcjonalne——
paginationobjectwymagane——
pagination.nextanyOf<string | null>opcjonalne——
pagination.next · variant 1stringopcjonalne——
pagination.next · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

UwierzytelnianiePubliczne / brak uwierzytelniania właściwego dla operacji

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
from_formatpathstringwymagane—
to_formatpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
supportedbooleanwymagane——
input_formatstringwymagane——
output_formatstringwymagane——
maturitystringopcjonalne—
enum: "stable", "disabled"default: "stable"
settings_scopestringopcjonalneSettings 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"
routeobjectopcjonalne——
route.multi_stepbooleanopcjonalneTrue 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[]opcjonalneSetting 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>opcjonalneStable 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 1stringopcjonalne——
options_version · variant 2nullopcjonalne——
optionsobject[]opcjonalneSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
options[]objectopcjonalne——
options[].namestringwymagane——
options[].typestringwymagane——
options[].labelstringwymagane——
options[].descriptionanyOf<string | null>opcjonalne——
options[].description · variant 1stringopcjonalne——
options[].description · variant 2nullopcjonalne——
options[].requiredbooleanopcjonalne—
default: false
options[].advancedbooleanopcjonalne—
default: false
options[].groupanyOf<string | null>opcjonalne——
options[].group · variant 1stringopcjonalne——
options[].group · variant 2nullopcjonalne——
options[].defaultunknownopcjonalne——
options[].possible_valuesanyOf<unknown[] | null>opcjonalne——
options[].possible_values · variant 1unknown[]opcjonalne——
options[].possible_values · variant 2nullopcjonalne——
options[].minimumanyOf<integer | number | null>opcjonalne——
options[].minimum · variant 1integeropcjonalne——
options[].minimum · variant 2numberopcjonalne——
options[].minimum · variant 3nullopcjonalne——
options[].maximumanyOf<integer | number | null>opcjonalne——
options[].maximum · variant 1integeropcjonalne——
options[].maximum · variant 2numberopcjonalne——
options[].maximum · variant 3nullopcjonalne——
options[].depends_onobject[]opcjonalne——
options[].conflicts_withstring[]opcjonalne——
options[].schemaanyOf<object | null>opcjonalne——
options[].schema · variant 1objectopcjonalne——
options[].schema · variant 2nullopcjonalne——
options_schemaobjectopcjonalneStrict JSON Schema for the settings accepted by this pair-level conversion task.—
limitsobjectopcjonalne——
billingobjectopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
account_idstringwymagane——
productstringwymagane——
api_enabledbooleanwymagane——
plansstring[]wymagane——
effective_planobjectwymagane——
effective_plan.codestringwymagane——
effective_plan.namestringwymagane——
effective_plan.familyanyOf<string | null>opcjonalne——
effective_plan.family · variant 1stringopcjonalne——
effective_plan.family · variant 2nullopcjonalne——
effective_plan.billing_intervalanyOf<string | null>opcjonalne——
effective_plan.billing_interval · variant 1stringopcjonalne——
effective_plan.billing_interval · variant 2nullopcjonalne——
creditsobjectwymagane——
credits.availablestringwymagane——
credits.reservedstringwymagane——
credits.debtstringwymagane——
quotaanyOf<object | null>opcjonalne——
quota · variant 1objectopcjonalne——
quota · variant 1.keystringwymagane——
quota · variant 1.periodstringwymagane——
quota · variant 1.period_keystringwymagane——
quota · variant 1.limitstringwymagane——
quota · variant 1.usedstringwymagane——
quota · variant 1.remainingstringwymagane——
quota · variant 1.period_startstringwymagane—
format: date-time
quota · variant 1.period_endstringwymagane—
format: date-time
quota · variant 2nullopcjonalne——
subscriptionsobject[]wymagane——
subscriptions[]objectopcjonalne——
subscriptions[].idstringwymagane——
subscriptions[].planstringwymagane——
subscriptions[].statusstringwymagane——
subscriptions[].billing_intervalanyOf<string | null>opcjonalne——
subscriptions[].billing_interval · variant 1stringopcjonalne——
subscriptions[].billing_interval · variant 2nullopcjonalne——
subscriptions[].current_period_startanyOf<string | null>opcjonalne——
subscriptions[].current_period_start · variant 1stringopcjonalne—
format: date-time
subscriptions[].current_period_start · variant 2nullopcjonalne——
subscriptions[].current_period_endanyOf<string | null>opcjonalne——
subscriptions[].current_period_end · variant 1stringopcjonalne—
format: date-time
subscriptions[].current_period_end · variant 2nullopcjonalne——
subscriptions[].next_billed_atanyOf<string | null>opcjonalne——
subscriptions[].next_billed_at · variant 1stringopcjonalne—
format: date-time
subscriptions[].next_billed_at · variant 2nullopcjonalne——
passesobject[]wymagane——
passes[]objectopcjonalne——
passes[].idstringwymagane——
passes[].offerstringwymagane——
passes[].planstringwymagane——
passes[].starts_atstringwymagane—
format: date-time
passes[].expires_atstringwymagane—
format: date-time
generated_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
limitqueryintegeropcjonalne
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcjonalne—
providerqueryanyOf<string | null>opcjonalne—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
dataobject[]wymagane——
data[]objectopcjonalne——
data[].idstringwymagane——
data[].namestringwymagane——
data[].providerstringwymagane—
enum: "s3", "gcs", "azure", "sftp"
data[].config_summaryobjectwymagane——
data[].enabledbooleanwymagane——
data[].created_atstringwymagane—
format: date-time
data[].updated_atstringwymagane—
format: date-time
paginationobjectwymagane——
pagination.nextanyOf<string | null>opcjonalne——
pagination.next · variant 1stringopcjonalne——
pagination.next · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
namestringwymagane—
min length: 1max length: 255
providerstringwymagane—
enum: "s3", "gcs", "azure", "sftp"
configobjectwymagane——

Odpowiedzi

201Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
namestringwymagane——
providerstringwymagane—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectwymagane——
enabledbooleanwymagane——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
connection_idpathstringwymagane—

Odpowiedzi

204Successful Response

Brak treści odpowiedzi.

400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
connection_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
namestringwymagane——
providerstringwymagane—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectwymagane——
enabledbooleanwymagane——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
connection_idpathstringwymagane—

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
nameanyOf<string | null>opcjonalne——
name · variant 1stringopcjonalne—
min length: 1max length: 255
name · variant 2nullopcjonalne——
configanyOf<object | null>opcjonalne——
config · variant 1objectopcjonalne——
config · variant 2nullopcjonalne——
enabledanyOf<boolean | null>opcjonalne——
enabled · variant 1booleanopcjonalne——
enabled · variant 2nullopcjonalne——

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
namestringwymagane——
providerstringwymagane—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectwymagane——
enabledbooleanwymagane——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
connection_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
okbooleanwymagane——
providerstringwymagane——
detailsobjectopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
PreferheaderanyOf<string | null>opcjonalne—
Idempotency-KeyheaderanyOf<string | null>opcjonalne—

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
inputobjectwymagane——
input.file_idanyOf<string | null>opcjonalne—
default: null
input.file_id · variant 1stringopcjonalne——
input.file_id · variant 2nullopcjonalne——
input.urlanyOf<string | null>opcjonalne—
default: null
input.url · variant 1stringopcjonalne——
input.url · variant 2nullopcjonalne——
input_formatanyOf<string | null>opcjonalne—
default: null
input_format · variant 1stringopcjonalne——
input_format · variant 2nullopcjonalne——
output_formatstringwymagane—
min length: 1max length: 64
optionsobjectopcjonalne——
filenameanyOf<string | null>opcjonalne—
default: null
filename · variant 1stringopcjonalne—
max length: 512
filename · variant 2nullopcjonalne——
metadataobjectopcjonalne——
client_reference_idanyOf<string | null>opcjonalne—
default: null
client_reference_id · variant 1stringopcjonalne—
max length: 255
client_reference_id · variant 2nullopcjonalne——
retention_secondsanyOf<integer | null>opcjonalne—
default: null
retention_seconds · variant 1integeropcjonalne—
min: 0max: 86400
retention_seconds · variant 2nullopcjonalne——
multipart/form-data
PoleTypWymaganeOpisOgraniczenia
filestringwymaganeInput file, up to 4 MiB.
format: binary
input_formatstringopcjonalneOptional source format when it cannot be detected.—
output_formatstringwymaganeRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringopcjonalneJSON object containing pair-specific conversion options.—
metadatastringopcjonalneJSON object copied to the created Job.—
filenamestringopcjonalneOptional output filename hint.—
client_reference_idstringopcjonalneOptional caller-defined reference.—
retention_secondsintegeropcjonalne—
min: 0max: 86400

Odpowiedzi

200Conversion completed within the requested wait window.
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
job_idstringwymagane——
statusstringwymagane——
progressintegerwymagane——
input_formatanyOf<string | null>opcjonalne——
input_format · variant 1stringopcjonalne——
input_format · variant 2nullopcjonalne——
output_formatstringwymagane——
output_fileanyOf<object | null>opcjonalne——
output_file · variant 1objectopcjonalne——
output_file · variant 1.idstringwymagane——
output_file · variant 1.statusstringwymagane——
output_file · variant 1.rolestringwymagane——
output_file · variant 1.filenamestringwymagane——
output_file · variant 1.content_typeanyOf<string | null>opcjonalne——
output_file · variant 1.content_type · variant 1stringopcjonalne——
output_file · variant 1.content_type · variant 2nullopcjonalne——
output_file · variant 1.detected_content_typeanyOf<string | null>opcjonalne——
output_file · variant 1.detected_content_type · variant 1stringopcjonalne——
output_file · variant 1.detected_content_type · variant 2nullopcjonalne——
output_file · variant 1.detected_formatanyOf<string | null>opcjonalne——
output_file · variant 1.detected_format · variant 1stringopcjonalne——
output_file · variant 1.detected_format · variant 2nullopcjonalne——
output_file · variant 1.size_bytesanyOf<integer | null>opcjonalne——
output_file · variant 1.size_bytes · variant 1integeropcjonalne——
output_file · variant 1.size_bytes · variant 2nullopcjonalne——
output_file · variant 1.checksum_sha256anyOf<string | null>opcjonalne——
output_file · variant 1.checksum_sha256 · variant 1stringopcjonalne——
output_file · variant 1.checksum_sha256 · variant 2nullopcjonalne——
output_file · variant 1.source_typestringwymagane——
output_file · variant 1.created_atstringwymagane—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>opcjonalne——
output_file · variant 1.ready_at · variant 1stringopcjonalne—
format: date-time
output_file · variant 1.ready_at · variant 2nullopcjonalne——
output_file · variant 1.expires_atanyOf<string | null>opcjonalne——
output_file · variant 1.expires_at · variant 1stringopcjonalne—
format: date-time
output_file · variant 1.expires_at · variant 2nullopcjonalne——
output_file · variant 1.metadataobjectopcjonalne——
output_file · variant 1.uploadanyOf<object | null>opcjonalne——
output_file · variant 1.upload · variant 1objectopcjonalne——
output_file · variant 1.upload · variant 1.methodstringopcjonalne—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringwymagane——
output_file · variant 1.upload · variant 1.expires_atstringwymagane—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectopcjonalne——
output_file · variant 1.upload · variant 2nullopcjonalne——
output_file · variant 1.download_urlanyOf<string | null>opcjonalne——
output_file · variant 1.download_url · variant 1stringopcjonalne——
output_file · variant 1.download_url · variant 2nullopcjonalne——
output_file · variant 1.download_expires_atanyOf<string | null>opcjonalne——
output_file · variant 1.download_expires_at · variant 1stringopcjonalne—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullopcjonalne——
output_file · variant 2nullopcjonalne——
created_atstringwymagane—
format: date-time
202Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
job_idstringwymagane——
statusstringwymagane——
progressintegerwymagane——
input_formatanyOf<string | null>opcjonalne——
input_format · variant 1stringopcjonalne——
input_format · variant 2nullopcjonalne——
output_formatstringwymagane——
output_fileanyOf<object | null>opcjonalne——
output_file · variant 1objectopcjonalne——
output_file · variant 1.idstringwymagane——
output_file · variant 1.statusstringwymagane——
output_file · variant 1.rolestringwymagane——
output_file · variant 1.filenamestringwymagane——
output_file · variant 1.content_typeanyOf<string | null>opcjonalne——
output_file · variant 1.content_type · variant 1stringopcjonalne——
output_file · variant 1.content_type · variant 2nullopcjonalne——
output_file · variant 1.detected_content_typeanyOf<string | null>opcjonalne——
output_file · variant 1.detected_content_type · variant 1stringopcjonalne——
output_file · variant 1.detected_content_type · variant 2nullopcjonalne——
output_file · variant 1.detected_formatanyOf<string | null>opcjonalne——
output_file · variant 1.detected_format · variant 1stringopcjonalne——
output_file · variant 1.detected_format · variant 2nullopcjonalne——
output_file · variant 1.size_bytesanyOf<integer | null>opcjonalne——
output_file · variant 1.size_bytes · variant 1integeropcjonalne——
output_file · variant 1.size_bytes · variant 2nullopcjonalne——
output_file · variant 1.checksum_sha256anyOf<string | null>opcjonalne——
output_file · variant 1.checksum_sha256 · variant 1stringopcjonalne——
output_file · variant 1.checksum_sha256 · variant 2nullopcjonalne——
output_file · variant 1.source_typestringwymagane——
output_file · variant 1.created_atstringwymagane—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>opcjonalne——
output_file · variant 1.ready_at · variant 1stringopcjonalne—
format: date-time
output_file · variant 1.ready_at · variant 2nullopcjonalne——
output_file · variant 1.expires_atanyOf<string | null>opcjonalne——
output_file · variant 1.expires_at · variant 1stringopcjonalne—
format: date-time
output_file · variant 1.expires_at · variant 2nullopcjonalne——
output_file · variant 1.metadataobjectopcjonalne——
output_file · variant 1.uploadanyOf<object | null>opcjonalne——
output_file · variant 1.upload · variant 1objectopcjonalne——
output_file · variant 1.upload · variant 1.methodstringopcjonalne—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringwymagane——
output_file · variant 1.upload · variant 1.expires_atstringwymagane—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectopcjonalne——
output_file · variant 1.upload · variant 2nullopcjonalne——
output_file · variant 1.download_urlanyOf<string | null>opcjonalne——
output_file · variant 1.download_url · variant 1stringopcjonalne——
output_file · variant 1.download_url · variant 2nullopcjonalne——
output_file · variant 1.download_expires_atanyOf<string | null>opcjonalne——
output_file · variant 1.download_expires_at · variant 1stringopcjonalne—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullopcjonalne——
output_file · variant 2nullopcjonalne——
created_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
from_formatpathstringwymagane—
to_formatpathstringwymagane—
PreferheaderanyOf<string | null>opcjonalne—
Idempotency-KeyheaderanyOf<string | null>opcjonalne—

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
inputobjectwymagane——
input.file_idanyOf<string | null>opcjonalne—
default: null
input.file_id · variant 1stringopcjonalne——
input.file_id · variant 2nullopcjonalne——
input.urlanyOf<string | null>opcjonalne—
default: null
input.url · variant 1stringopcjonalne——
input.url · variant 2nullopcjonalne——
input_formatanyOf<string | null>opcjonalne—
default: null
input_format · variant 1stringopcjonalne——
input_format · variant 2nullopcjonalne——
output_formatstringwymagane—
min length: 1max length: 64
optionsobjectopcjonalne——
filenameanyOf<string | null>opcjonalne—
default: null
filename · variant 1stringopcjonalne—
max length: 512
filename · variant 2nullopcjonalne——
metadataobjectopcjonalne——
client_reference_idanyOf<string | null>opcjonalne—
default: null
client_reference_id · variant 1stringopcjonalne—
max length: 255
client_reference_id · variant 2nullopcjonalne——
retention_secondsanyOf<integer | null>opcjonalne—
default: null
retention_seconds · variant 1integeropcjonalne—
min: 0max: 86400
retention_seconds · variant 2nullopcjonalne——
multipart/form-data
PoleTypWymaganeOpisOgraniczenia
filestringwymaganeInput file, up to 4 MiB.
format: binary
input_formatstringopcjonalneOptional source format when it cannot be detected.—
output_formatstringopcjonalneRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringopcjonalneJSON object containing pair-specific conversion options.—
metadatastringopcjonalneJSON object copied to the created Job.—
filenamestringopcjonalneOptional output filename hint.—
client_reference_idstringopcjonalneOptional caller-defined reference.—
retention_secondsintegeropcjonalne—
min: 0max: 86400

Odpowiedzi

200Conversion completed within the requested wait window.
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
job_idstringwymagane——
statusstringwymagane——
progressintegerwymagane——
input_formatanyOf<string | null>opcjonalne——
input_format · variant 1stringopcjonalne——
input_format · variant 2nullopcjonalne——
output_formatstringwymagane——
output_fileanyOf<object | null>opcjonalne——
output_file · variant 1objectopcjonalne——
output_file · variant 1.idstringwymagane——
output_file · variant 1.statusstringwymagane——
output_file · variant 1.rolestringwymagane——
output_file · variant 1.filenamestringwymagane——
output_file · variant 1.content_typeanyOf<string | null>opcjonalne——
output_file · variant 1.content_type · variant 1stringopcjonalne——
output_file · variant 1.content_type · variant 2nullopcjonalne——
output_file · variant 1.detected_content_typeanyOf<string | null>opcjonalne——
output_file · variant 1.detected_content_type · variant 1stringopcjonalne——
output_file · variant 1.detected_content_type · variant 2nullopcjonalne——
output_file · variant 1.detected_formatanyOf<string | null>opcjonalne——
output_file · variant 1.detected_format · variant 1stringopcjonalne——
output_file · variant 1.detected_format · variant 2nullopcjonalne——
output_file · variant 1.size_bytesanyOf<integer | null>opcjonalne——
output_file · variant 1.size_bytes · variant 1integeropcjonalne——
output_file · variant 1.size_bytes · variant 2nullopcjonalne——
output_file · variant 1.checksum_sha256anyOf<string | null>opcjonalne——
output_file · variant 1.checksum_sha256 · variant 1stringopcjonalne——
output_file · variant 1.checksum_sha256 · variant 2nullopcjonalne——
output_file · variant 1.source_typestringwymagane——
output_file · variant 1.created_atstringwymagane—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>opcjonalne——
output_file · variant 1.ready_at · variant 1stringopcjonalne—
format: date-time
output_file · variant 1.ready_at · variant 2nullopcjonalne——
output_file · variant 1.expires_atanyOf<string | null>opcjonalne——
output_file · variant 1.expires_at · variant 1stringopcjonalne—
format: date-time
output_file · variant 1.expires_at · variant 2nullopcjonalne——
output_file · variant 1.metadataobjectopcjonalne——
output_file · variant 1.uploadanyOf<object | null>opcjonalne——
output_file · variant 1.upload · variant 1objectopcjonalne——
output_file · variant 1.upload · variant 1.methodstringopcjonalne—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringwymagane——
output_file · variant 1.upload · variant 1.expires_atstringwymagane—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectopcjonalne——
output_file · variant 1.upload · variant 2nullopcjonalne——
output_file · variant 1.download_urlanyOf<string | null>opcjonalne——
output_file · variant 1.download_url · variant 1stringopcjonalne——
output_file · variant 1.download_url · variant 2nullopcjonalne——
output_file · variant 1.download_expires_atanyOf<string | null>opcjonalne——
output_file · variant 1.download_expires_at · variant 1stringopcjonalne—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullopcjonalne——
output_file · variant 2nullopcjonalne——
created_atstringwymagane—
format: date-time
202Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
job_idstringwymagane——
statusstringwymagane——
progressintegerwymagane——
input_formatanyOf<string | null>opcjonalne——
input_format · variant 1stringopcjonalne——
input_format · variant 2nullopcjonalne——
output_formatstringwymagane——
output_fileanyOf<object | null>opcjonalne——
output_file · variant 1objectopcjonalne——
output_file · variant 1.idstringwymagane——
output_file · variant 1.statusstringwymagane——
output_file · variant 1.rolestringwymagane——
output_file · variant 1.filenamestringwymagane——
output_file · variant 1.content_typeanyOf<string | null>opcjonalne——
output_file · variant 1.content_type · variant 1stringopcjonalne——
output_file · variant 1.content_type · variant 2nullopcjonalne——
output_file · variant 1.detected_content_typeanyOf<string | null>opcjonalne——
output_file · variant 1.detected_content_type · variant 1stringopcjonalne——
output_file · variant 1.detected_content_type · variant 2nullopcjonalne——
output_file · variant 1.detected_formatanyOf<string | null>opcjonalne——
output_file · variant 1.detected_format · variant 1stringopcjonalne——
output_file · variant 1.detected_format · variant 2nullopcjonalne——
output_file · variant 1.size_bytesanyOf<integer | null>opcjonalne——
output_file · variant 1.size_bytes · variant 1integeropcjonalne——
output_file · variant 1.size_bytes · variant 2nullopcjonalne——
output_file · variant 1.checksum_sha256anyOf<string | null>opcjonalne——
output_file · variant 1.checksum_sha256 · variant 1stringopcjonalne——
output_file · variant 1.checksum_sha256 · variant 2nullopcjonalne——
output_file · variant 1.source_typestringwymagane——
output_file · variant 1.created_atstringwymagane—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>opcjonalne——
output_file · variant 1.ready_at · variant 1stringopcjonalne—
format: date-time
output_file · variant 1.ready_at · variant 2nullopcjonalne——
output_file · variant 1.expires_atanyOf<string | null>opcjonalne——
output_file · variant 1.expires_at · variant 1stringopcjonalne—
format: date-time
output_file · variant 1.expires_at · variant 2nullopcjonalne——
output_file · variant 1.metadataobjectopcjonalne——
output_file · variant 1.uploadanyOf<object | null>opcjonalne——
output_file · variant 1.upload · variant 1objectopcjonalne——
output_file · variant 1.upload · variant 1.methodstringopcjonalne—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringwymagane——
output_file · variant 1.upload · variant 1.expires_atstringwymagane—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectopcjonalne——
output_file · variant 1.upload · variant 2nullopcjonalne——
output_file · variant 1.download_urlanyOf<string | null>opcjonalne——
output_file · variant 1.download_url · variant 1stringopcjonalne——
output_file · variant 1.download_url · variant 2nullopcjonalne——
output_file · variant 1.download_expires_atanyOf<string | null>opcjonalne——
output_file · variant 1.download_expires_at · variant 1stringopcjonalne—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullopcjonalne——
output_file · variant 2nullopcjonalne——
created_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
input_formatstringwymagane——
output_formatstringwymagane——
size_bytesanyOf<integer | null>opcjonalne——
size_bytes · variant 1integeropcjonalne—
min: 0
size_bytes · variant 2nullopcjonalne——
page_countanyOf<integer | null>opcjonalne——
page_count · variant 1integeropcjonalne—
min: 0
page_count · variant 2nullopcjonalne——
duration_secondsanyOf<number | null>opcjonalne——
duration_seconds · variant 1numberopcjonalne—
min: 0
duration_seconds · variant 2nullopcjonalne——
optionsobjectopcjonalne——

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
supportedbooleanwymagane——
recommended_modestringwymagane—
enum: "sync", "async"
creditsobjectwymagane——
warningsstring[]opcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
GET/v1/event-typesEvent TypesDiscovery#

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

UwierzytelnianiePubliczne / brak uwierzytelniania właściwego dla operacji

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
dataobject[]wymagane——
data[]objectopcjonalne——
data[].typestringwymagane——
data[].descriptionstringwymagane——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
limitqueryintegeropcjonalne
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcjonalne—
statusqueryanyOf<string | null>opcjonalne—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
dataobject[]wymagane——
data[]objectopcjonalne——
data[].idstringwymagane——
data[].statusstringwymagane——
data[].rolestringwymagane——
data[].filenamestringwymagane——
data[].content_typeanyOf<string | null>opcjonalne——
data[].content_type · variant 1stringopcjonalne——
data[].content_type · variant 2nullopcjonalne——
data[].detected_content_typeanyOf<string | null>opcjonalne——
data[].detected_content_type · variant 1stringopcjonalne——
data[].detected_content_type · variant 2nullopcjonalne——
data[].detected_formatanyOf<string | null>opcjonalne——
data[].detected_format · variant 1stringopcjonalne——
data[].detected_format · variant 2nullopcjonalne——
data[].size_bytesanyOf<integer | null>opcjonalne——
data[].size_bytes · variant 1integeropcjonalne——
data[].size_bytes · variant 2nullopcjonalne——
data[].checksum_sha256anyOf<string | null>opcjonalne——
data[].checksum_sha256 · variant 1stringopcjonalne——
data[].checksum_sha256 · variant 2nullopcjonalne——
data[].source_typestringwymagane——
data[].created_atstringwymagane—
format: date-time
data[].ready_atanyOf<string | null>opcjonalne——
data[].ready_at · variant 1stringopcjonalne—
format: date-time
data[].ready_at · variant 2nullopcjonalne——
data[].expires_atanyOf<string | null>opcjonalne——
data[].expires_at · variant 1stringopcjonalne—
format: date-time
data[].expires_at · variant 2nullopcjonalne——
data[].metadataobjectopcjonalne——
data[].uploadanyOf<object | null>opcjonalne——
data[].upload · variant 1objectopcjonalne——
data[].upload · variant 1.methodstringopcjonalne—
default: "PUT"
data[].upload · variant 1.urlstringwymagane——
data[].upload · variant 1.expires_atstringwymagane—
format: date-time
data[].upload · variant 1.headersobjectopcjonalne——
data[].upload · variant 2nullopcjonalne——
data[].download_urlanyOf<string | null>opcjonalne——
data[].download_url · variant 1stringopcjonalne——
data[].download_url · variant 2nullopcjonalne——
data[].download_expires_atanyOf<string | null>opcjonalne——
data[].download_expires_at · variant 1stringopcjonalne—
format: date-time
data[].download_expires_at · variant 2nullopcjonalne——
paginationobjectwymagane——
pagination.nextanyOf<string | null>opcjonalne——
pagination.next · variant 1stringopcjonalne——
pagination.next · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
filenamestringwymagane—
min length: 1max length: 512
size_bytesanyOf<integer | null>opcjonalne——
size_bytes · variant 1integeropcjonalne—
min: 0
size_bytes · variant 2nullopcjonalne——
content_typeanyOf<string | null>opcjonalne——
content_type · variant 1stringopcjonalne—
max length: 255
content_type · variant 2nullopcjonalne——
checksum_sha256anyOf<string | null>opcjonalne——
checksum_sha256 · variant 1stringopcjonalne—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullopcjonalne——
retention_secondsanyOf<integer | null>opcjonalne——
retention_seconds · variant 1integeropcjonalne—
min: 0max: 86400
retention_seconds · variant 2nullopcjonalne——
metadataobjectopcjonalne——

Odpowiedzi

201Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
statusstringwymagane——
rolestringwymagane——
filenamestringwymagane——
content_typeanyOf<string | null>opcjonalne——
content_type · variant 1stringopcjonalne——
content_type · variant 2nullopcjonalne——
detected_content_typeanyOf<string | null>opcjonalne——
detected_content_type · variant 1stringopcjonalne——
detected_content_type · variant 2nullopcjonalne——
detected_formatanyOf<string | null>opcjonalne——
detected_format · variant 1stringopcjonalne——
detected_format · variant 2nullopcjonalne——
size_bytesanyOf<integer | null>opcjonalne——
size_bytes · variant 1integeropcjonalne——
size_bytes · variant 2nullopcjonalne——
checksum_sha256anyOf<string | null>opcjonalne——
checksum_sha256 · variant 1stringopcjonalne——
checksum_sha256 · variant 2nullopcjonalne——
source_typestringwymagane——
created_atstringwymagane—
format: date-time
ready_atanyOf<string | null>opcjonalne——
ready_at · variant 1stringopcjonalne—
format: date-time
ready_at · variant 2nullopcjonalne——
expires_atanyOf<string | null>opcjonalne——
expires_at · variant 1stringopcjonalne—
format: date-time
expires_at · variant 2nullopcjonalne——
metadataobjectopcjonalne——
uploadanyOf<object | null>opcjonalne——
upload · variant 1objectopcjonalne——
upload · variant 1.methodstringopcjonalne—
default: "PUT"
upload · variant 1.urlstringwymagane——
upload · variant 1.expires_atstringwymagane—
format: date-time
upload · variant 1.headersobjectopcjonalne——
upload · variant 2nullopcjonalne——
download_urlanyOf<string | null>opcjonalne——
download_url · variant 1stringopcjonalne——
download_url · variant 2nullopcjonalne——
download_expires_atanyOf<string | null>opcjonalne——
download_expires_at · variant 1stringopcjonalne—
format: date-time
download_expires_at · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
file_idpathstringwymagane—

Odpowiedzi

204Successful Response

Brak treści odpowiedzi.

400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
file_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
statusstringwymagane——
rolestringwymagane——
filenamestringwymagane——
content_typeanyOf<string | null>opcjonalne——
content_type · variant 1stringopcjonalne——
content_type · variant 2nullopcjonalne——
detected_content_typeanyOf<string | null>opcjonalne——
detected_content_type · variant 1stringopcjonalne——
detected_content_type · variant 2nullopcjonalne——
detected_formatanyOf<string | null>opcjonalne——
detected_format · variant 1stringopcjonalne——
detected_format · variant 2nullopcjonalne——
size_bytesanyOf<integer | null>opcjonalne——
size_bytes · variant 1integeropcjonalne——
size_bytes · variant 2nullopcjonalne——
checksum_sha256anyOf<string | null>opcjonalne——
checksum_sha256 · variant 1stringopcjonalne——
checksum_sha256 · variant 2nullopcjonalne——
source_typestringwymagane——
created_atstringwymagane—
format: date-time
ready_atanyOf<string | null>opcjonalne——
ready_at · variant 1stringopcjonalne—
format: date-time
ready_at · variant 2nullopcjonalne——
expires_atanyOf<string | null>opcjonalne——
expires_at · variant 1stringopcjonalne—
format: date-time
expires_at · variant 2nullopcjonalne——
metadataobjectopcjonalne——
uploadanyOf<object | null>opcjonalne——
upload · variant 1objectopcjonalne——
upload · variant 1.methodstringopcjonalne—
default: "PUT"
upload · variant 1.urlstringwymagane——
upload · variant 1.expires_atstringwymagane—
format: date-time
upload · variant 1.headersobjectopcjonalne——
upload · variant 2nullopcjonalne——
download_urlanyOf<string | null>opcjonalne——
download_url · variant 1stringopcjonalne——
download_url · variant 2nullopcjonalne——
download_expires_atanyOf<string | null>opcjonalne——
download_expires_at · variant 1stringopcjonalne—
format: date-time
download_expires_at · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
file_idpathstringwymagane—

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
checksum_sha256anyOf<string | null>opcjonalne——
checksum_sha256 · variant 1stringopcjonalne—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullopcjonalne——

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
statusstringwymagane——
rolestringwymagane——
filenamestringwymagane——
content_typeanyOf<string | null>opcjonalne——
content_type · variant 1stringopcjonalne——
content_type · variant 2nullopcjonalne——
detected_content_typeanyOf<string | null>opcjonalne——
detected_content_type · variant 1stringopcjonalne——
detected_content_type · variant 2nullopcjonalne——
detected_formatanyOf<string | null>opcjonalne——
detected_format · variant 1stringopcjonalne——
detected_format · variant 2nullopcjonalne——
size_bytesanyOf<integer | null>opcjonalne——
size_bytes · variant 1integeropcjonalne——
size_bytes · variant 2nullopcjonalne——
checksum_sha256anyOf<string | null>opcjonalne——
checksum_sha256 · variant 1stringopcjonalne——
checksum_sha256 · variant 2nullopcjonalne——
source_typestringwymagane——
created_atstringwymagane—
format: date-time
ready_atanyOf<string | null>opcjonalne——
ready_at · variant 1stringopcjonalne—
format: date-time
ready_at · variant 2nullopcjonalne——
expires_atanyOf<string | null>opcjonalne——
expires_at · variant 1stringopcjonalne—
format: date-time
expires_at · variant 2nullopcjonalne——
metadataobjectopcjonalne——
uploadanyOf<object | null>opcjonalne——
upload · variant 1objectopcjonalne——
upload · variant 1.methodstringopcjonalne—
default: "PUT"
upload · variant 1.urlstringwymagane——
upload · variant 1.expires_atstringwymagane—
format: date-time
upload · variant 1.headersobjectopcjonalne——
upload · variant 2nullopcjonalne——
download_urlanyOf<string | null>opcjonalne——
download_url · variant 1stringopcjonalne——
download_url · variant 2nullopcjonalne——
download_expires_atanyOf<string | null>opcjonalne——
download_expires_at · variant 1stringopcjonalne—
format: date-time
download_expires_at · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
file_idpathstringwymagane—

Odpowiedzi

204Successful Response

Brak treści odpowiedzi.

400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
file_idpathstringwymagane—

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
part_sizeanyOf<integer | null>opcjonalne——
part_size · variant 1integeropcjonalne—
min: 5242880max: 5368709120
part_size · variant 2nullopcjonalne——

Odpowiedzi

201Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
file_idstringwymagane——
upload_idstringwymagane——
part_sizeintegerwymagane——
max_partsintegeropcjonalne—
default: 10000
expires_atstringwymagane—
format: date-time
partsobject[]opcjonalne——
parts[]objectopcjonalne——
parts[].part_numberintegerwymagane——
parts[].urlstringwymagane——
parts[].expires_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
file_idpathstringwymagane—

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
partsobject[]wymagane—
min items: 1max items: 10000
parts[]objectopcjonalne——
parts[].part_numberintegerwymagane—
min: 1max: 10000
parts[].etagstringwymagane—
min length: 1max length: 512
checksum_sha256anyOf<string | null>opcjonalne——
checksum_sha256 · variant 1stringopcjonalne—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullopcjonalne——

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
statusstringwymagane——
rolestringwymagane——
filenamestringwymagane——
content_typeanyOf<string | null>opcjonalne——
content_type · variant 1stringopcjonalne——
content_type · variant 2nullopcjonalne——
detected_content_typeanyOf<string | null>opcjonalne——
detected_content_type · variant 1stringopcjonalne——
detected_content_type · variant 2nullopcjonalne——
detected_formatanyOf<string | null>opcjonalne——
detected_format · variant 1stringopcjonalne——
detected_format · variant 2nullopcjonalne——
size_bytesanyOf<integer | null>opcjonalne——
size_bytes · variant 1integeropcjonalne——
size_bytes · variant 2nullopcjonalne——
checksum_sha256anyOf<string | null>opcjonalne——
checksum_sha256 · variant 1stringopcjonalne——
checksum_sha256 · variant 2nullopcjonalne——
source_typestringwymagane——
created_atstringwymagane—
format: date-time
ready_atanyOf<string | null>opcjonalne——
ready_at · variant 1stringopcjonalne—
format: date-time
ready_at · variant 2nullopcjonalne——
expires_atanyOf<string | null>opcjonalne——
expires_at · variant 1stringopcjonalne—
format: date-time
expires_at · variant 2nullopcjonalne——
metadataobjectopcjonalne——
uploadanyOf<object | null>opcjonalne——
upload · variant 1objectopcjonalne——
upload · variant 1.methodstringopcjonalne—
default: "PUT"
upload · variant 1.urlstringwymagane——
upload · variant 1.expires_atstringwymagane—
format: date-time
upload · variant 1.headersobjectopcjonalne——
upload · variant 2nullopcjonalne——
download_urlanyOf<string | null>opcjonalne——
download_url · variant 1stringopcjonalne——
download_url · variant 2nullopcjonalne——
download_expires_atanyOf<string | null>opcjonalne——
download_expires_at · variant 1stringopcjonalne—
format: date-time
download_expires_at · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
file_idpathstringwymagane—

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
part_numbersinteger[]wymagane—
min items: 1max items: 1000

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
file_idstringwymagane——
upload_idstringwymagane——
part_sizeintegerwymagane——
max_partsintegeropcjonalne—
default: 10000
expires_atstringwymagane—
format: date-time
partsobject[]opcjonalne——
parts[]objectopcjonalne——
parts[].part_numberintegerwymagane——
parts[].urlstringwymagane——
parts[].expires_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

UwierzytelnianiePubliczne / brak uwierzytelniania właściwego dla operacji

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
limitqueryintegeropcjonalne
default: 500min: 1max: 500

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
dataobject[]wymagane——
data[]objectopcjonalne——
data[].slugstringwymagane——
data[].labelstringwymagane——
data[].categorystringwymagane——
data[].mime_typesstring[]wymagane——
data[].extensionsstring[]wymagane——
paginationobjectwymagane——
pagination.nextanyOf<string | null>opcjonalne——
pagination.next · variant 1stringopcjonalne——
pagination.next · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

UwierzytelnianiePubliczne / brak uwierzytelniania właściwego dla operacji

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
slugpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
slugstringwymagane——
labelstringwymagane——
categorystringwymagane——
mime_typesstring[]wymagane——
extensionsstring[]wymagane——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

UwierzytelnianiePubliczne / brak uwierzytelniania właściwego dla operacji

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
slugpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
dataobject[]wymagane——
data[]objectopcjonalne——
data[].slugstringwymagane——
data[].labelstringwymagane——
data[].categorystringwymagane——
data[].mime_typesstring[]wymagane——
data[].extensionsstring[]wymagane——
paginationobjectwymagane——
pagination.nextanyOf<string | null>opcjonalne——
pagination.next · variant 1stringopcjonalne——
pagination.next · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

UwierzytelnianiePubliczne / brak uwierzytelniania właściwego dla operacji

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
slugpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
dataobject[]wymagane——
data[]objectopcjonalne——
data[].slugstringwymagane——
data[].labelstringwymagane——
data[].categorystringwymagane——
data[].mime_typesstring[]wymagane——
data[].extensionsstring[]wymagane——
paginationobjectwymagane——
pagination.nextanyOf<string | null>opcjonalne——
pagination.next · variant 1stringopcjonalne——
pagination.next · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
limitqueryintegeropcjonalne
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcjonalne—
statusqueryanyOf<string | null>opcjonalne—
tagqueryanyOf<string | null>opcjonalne—
originqueryanyOf<string | null>opcjonalne—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
dataobject[]wymagane——
data[]objectopcjonalne——
data[].idstringwymagane——
data[].kindstringwymagane——
data[].statusstringwymagane——
data[].progressintegerwymagane——
data[].taganyOf<string | null>opcjonalne——
data[].tag · variant 1stringopcjonalne——
data[].tag · variant 2nullopcjonalne——
data[].client_reference_idanyOf<string | null>opcjonalne——
data[].client_reference_id · variant 1stringopcjonalne——
data[].client_reference_id · variant 2nullopcjonalne——
data[].metadataobjectopcjonalne——
data[].prioritystringwymagane——
data[].concurrency_limitintegeropcjonalne—
default: 1
data[].originstringwymagane——
data[].created_atstringwymagane—
format: date-time
data[].started_atanyOf<string | null>opcjonalne——
data[].started_at · variant 1stringopcjonalne—
format: date-time
data[].started_at · variant 2nullopcjonalne——
data[].completed_atanyOf<string | null>opcjonalne——
data[].completed_at · variant 1stringopcjonalne—
format: date-time
data[].completed_at · variant 2nullopcjonalne——
data[].error_codeanyOf<string | null>opcjonalne——
data[].error_code · variant 1stringopcjonalne——
data[].error_code · variant 2nullopcjonalne——
data[].error_messageanyOf<string | null>opcjonalne——
data[].error_message · variant 1stringopcjonalne——
data[].error_message · variant 2nullopcjonalne——
data[].tasksobject[]opcjonalne——
data[].tasks[]objectopcjonalne——
data[].tasks[].idstringwymagane——
data[].tasks[].job_idstringwymagane——
data[].tasks[].namestringwymagane——
data[].tasks[].operationstringwymagane——
data[].tasks[].statusstringwymagane——
data[].tasks[].progressintegerwymagane——
data[].tasks[].inputobjectwymagane——
data[].tasks[].optionsobjectwymagane——
data[].tasks[].resultobjectwymagane——
data[].tasks[].requiredbooleanwymagane——
data[].tasks[].runtime_classstringwymagane——
data[].tasks[].prioritystringwymagane——
data[].tasks[].attempt_countintegerwymagane——
data[].tasks[].max_attemptsintegerwymagane——
data[].tasks[].error_codeanyOf<string | null>opcjonalne——
data[].tasks[].error_code · variant 1stringopcjonalne——
data[].tasks[].error_code · variant 2nullopcjonalne——
data[].tasks[].error_messageanyOf<string | null>opcjonalne——
data[].tasks[].error_message · variant 1stringopcjonalne——
data[].tasks[].error_message · variant 2nullopcjonalne——
data[].tasks[].created_atstringwymagane—
format: date-time
data[].tasks[].queued_atanyOf<string | null>opcjonalne——
data[].tasks[].queued_at · variant 1stringopcjonalne—
format: date-time
data[].tasks[].queued_at · variant 2nullopcjonalne——
data[].tasks[].started_atanyOf<string | null>opcjonalne——
data[].tasks[].started_at · variant 1stringopcjonalne—
format: date-time
data[].tasks[].started_at · variant 2nullopcjonalne——
data[].tasks[].completed_atanyOf<string | null>opcjonalne——
data[].tasks[].completed_at · variant 1stringopcjonalne—
format: date-time
data[].tasks[].completed_at · variant 2nullopcjonalne——
data[].tasks[].attemptsobject[]opcjonalne——
data[].tasks[].attempts[]objectopcjonalne——
data[].tasks[].attempts[].idstringwymagane——
data[].tasks[].attempts[].attempt_numberintegerwymagane——
data[].tasks[].attempts[].statusstringwymagane——
data[].tasks[].attempts[].worker_idanyOf<string | null>opcjonalne——
data[].tasks[].attempts[].worker_id · variant 1stringopcjonalne——
data[].tasks[].attempts[].worker_id · variant 2nullopcjonalne——
data[].tasks[].attempts[].runtime_classanyOf<string | null>opcjonalne——
data[].tasks[].attempts[].runtime_class · variant 1stringopcjonalne——
data[].tasks[].attempts[].runtime_class · variant 2nullopcjonalne——
data[].tasks[].attempts[].regionanyOf<string | null>opcjonalne——
data[].tasks[].attempts[].region · variant 1stringopcjonalne——
data[].tasks[].attempts[].region · variant 2nullopcjonalne——
data[].tasks[].attempts[].engineanyOf<string | null>opcjonalne——
data[].tasks[].attempts[].engine · variant 1stringopcjonalne——
data[].tasks[].attempts[].engine · variant 2nullopcjonalne——
data[].tasks[].attempts[].engine_versionanyOf<string | null>opcjonalne——
data[].tasks[].attempts[].engine_version · variant 1stringopcjonalne——
data[].tasks[].attempts[].engine_version · variant 2nullopcjonalne——
data[].tasks[].attempts[].input_bytesanyOf<integer | null>opcjonalne——
data[].tasks[].attempts[].input_bytes · variant 1integeropcjonalne——
data[].tasks[].attempts[].input_bytes · variant 2nullopcjonalne——
data[].tasks[].attempts[].output_bytesanyOf<integer | null>opcjonalne——
data[].tasks[].attempts[].output_bytes · variant 1integeropcjonalne——
data[].tasks[].attempts[].output_bytes · variant 2nullopcjonalne——
data[].tasks[].attempts[].wall_msanyOf<integer | null>opcjonalne——
data[].tasks[].attempts[].wall_ms · variant 1integeropcjonalne——
data[].tasks[].attempts[].wall_ms · variant 2nullopcjonalne——
data[].tasks[].attempts[].cpu_msanyOf<integer | null>opcjonalne——
data[].tasks[].attempts[].cpu_ms · variant 1integeropcjonalne——
data[].tasks[].attempts[].cpu_ms · variant 2nullopcjonalne——
data[].tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcjonalne——
data[].tasks[].attempts[].peak_memory_mb · variant 1integeropcjonalne——
data[].tasks[].attempts[].peak_memory_mb · variant 2nullopcjonalne——
data[].tasks[].attempts[].temp_bytesanyOf<integer | null>opcjonalne——
data[].tasks[].attempts[].temp_bytes · variant 1integeropcjonalne——
data[].tasks[].attempts[].temp_bytes · variant 2nullopcjonalne——
data[].tasks[].attempts[].error_codeanyOf<string | null>opcjonalne——
data[].tasks[].attempts[].error_code · variant 1stringopcjonalne——
data[].tasks[].attempts[].error_code · variant 2nullopcjonalne——
data[].tasks[].attempts[].error_messageanyOf<string | null>opcjonalne——
data[].tasks[].attempts[].error_message · variant 1stringopcjonalne——
data[].tasks[].attempts[].error_message · variant 2nullopcjonalne——
data[].tasks[].attempts[].estimated_creditsanyOf<string | null>opcjonalne——
data[].tasks[].attempts[].estimated_credits · variant 1stringopcjonalne——
data[].tasks[].attempts[].estimated_credits · variant 2nullopcjonalne——
data[].tasks[].attempts[].settled_creditsanyOf<string | null>opcjonalne——
data[].tasks[].attempts[].settled_credits · variant 1stringopcjonalne——
data[].tasks[].attempts[].settled_credits · variant 2nullopcjonalne——
data[].tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcjonalne——
data[].tasks[].attempts[].external_side_effect_started_at · variant 1stringopcjonalne—
format: date-time
data[].tasks[].attempts[].external_side_effect_started_at · variant 2nullopcjonalne——
data[].tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcjonalne——
data[].tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcjonalne—
format: date-time
data[].tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcjonalne——
data[].tasks[].attempts[].started_atstringwymagane—
format: date-time
data[].tasks[].attempts[].completed_atanyOf<string | null>opcjonalne——
data[].tasks[].attempts[].completed_at · variant 1stringopcjonalne—
format: date-time
data[].tasks[].attempts[].completed_at · variant 2nullopcjonalne——
paginationobjectwymagane——
pagination.nextanyOf<string | null>opcjonalne——
pagination.next · variant 1stringopcjonalne——
pagination.next · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
Idempotency-KeyheaderanyOf<string | null>opcjonalne—

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
tasksobjectwymagane——
taganyOf<string | null>opcjonalne——
tag · variant 1stringopcjonalne—
max length: 255
tag · variant 2nullopcjonalne——
client_reference_idanyOf<string | null>opcjonalne——
client_reference_id · variant 1stringopcjonalne—
max length: 255
client_reference_id · variant 2nullopcjonalne——
metadataobjectopcjonalne——
prioritystringopcjonalne—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>opcjonalne——
retention_seconds · variant 1integeropcjonalne—
min: 0max: 86400
retention_seconds · variant 2nullopcjonalne——

Odpowiedzi

201Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
kindstringwymagane——
statusstringwymagane——
progressintegerwymagane——
taganyOf<string | null>opcjonalne——
tag · variant 1stringopcjonalne——
tag · variant 2nullopcjonalne——
client_reference_idanyOf<string | null>opcjonalne——
client_reference_id · variant 1stringopcjonalne——
client_reference_id · variant 2nullopcjonalne——
metadataobjectopcjonalne——
prioritystringwymagane——
concurrency_limitintegeropcjonalne—
default: 1
originstringwymagane——
created_atstringwymagane—
format: date-time
started_atanyOf<string | null>opcjonalne——
started_at · variant 1stringopcjonalne—
format: date-time
started_at · variant 2nullopcjonalne——
completed_atanyOf<string | null>opcjonalne——
completed_at · variant 1stringopcjonalne—
format: date-time
completed_at · variant 2nullopcjonalne——
error_codeanyOf<string | null>opcjonalne——
error_code · variant 1stringopcjonalne——
error_code · variant 2nullopcjonalne——
error_messageanyOf<string | null>opcjonalne——
error_message · variant 1stringopcjonalne——
error_message · variant 2nullopcjonalne——
tasksobject[]opcjonalne——
tasks[]objectopcjonalne——
tasks[].idstringwymagane——
tasks[].job_idstringwymagane——
tasks[].namestringwymagane——
tasks[].operationstringwymagane——
tasks[].statusstringwymagane——
tasks[].progressintegerwymagane——
tasks[].inputobjectwymagane——
tasks[].optionsobjectwymagane——
tasks[].resultobjectwymagane——
tasks[].requiredbooleanwymagane——
tasks[].runtime_classstringwymagane——
tasks[].prioritystringwymagane——
tasks[].attempt_countintegerwymagane——
tasks[].max_attemptsintegerwymagane——
tasks[].error_codeanyOf<string | null>opcjonalne——
tasks[].error_code · variant 1stringopcjonalne——
tasks[].error_code · variant 2nullopcjonalne——
tasks[].error_messageanyOf<string | null>opcjonalne——
tasks[].error_message · variant 1stringopcjonalne——
tasks[].error_message · variant 2nullopcjonalne——
tasks[].created_atstringwymagane—
format: date-time
tasks[].queued_atanyOf<string | null>opcjonalne——
tasks[].queued_at · variant 1stringopcjonalne—
format: date-time
tasks[].queued_at · variant 2nullopcjonalne——
tasks[].started_atanyOf<string | null>opcjonalne——
tasks[].started_at · variant 1stringopcjonalne—
format: date-time
tasks[].started_at · variant 2nullopcjonalne——
tasks[].completed_atanyOf<string | null>opcjonalne——
tasks[].completed_at · variant 1stringopcjonalne—
format: date-time
tasks[].completed_at · variant 2nullopcjonalne——
tasks[].attemptsobject[]opcjonalne——
tasks[].attempts[]objectopcjonalne——
tasks[].attempts[].idstringwymagane——
tasks[].attempts[].attempt_numberintegerwymagane——
tasks[].attempts[].statusstringwymagane——
tasks[].attempts[].worker_idanyOf<string | null>opcjonalne——
tasks[].attempts[].worker_id · variant 1stringopcjonalne——
tasks[].attempts[].worker_id · variant 2nullopcjonalne——
tasks[].attempts[].runtime_classanyOf<string | null>opcjonalne——
tasks[].attempts[].runtime_class · variant 1stringopcjonalne——
tasks[].attempts[].runtime_class · variant 2nullopcjonalne——
tasks[].attempts[].regionanyOf<string | null>opcjonalne——
tasks[].attempts[].region · variant 1stringopcjonalne——
tasks[].attempts[].region · variant 2nullopcjonalne——
tasks[].attempts[].engineanyOf<string | null>opcjonalne——
tasks[].attempts[].engine · variant 1stringopcjonalne——
tasks[].attempts[].engine · variant 2nullopcjonalne——
tasks[].attempts[].engine_versionanyOf<string | null>opcjonalne——
tasks[].attempts[].engine_version · variant 1stringopcjonalne——
tasks[].attempts[].engine_version · variant 2nullopcjonalne——
tasks[].attempts[].input_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].input_bytes · variant 1integeropcjonalne——
tasks[].attempts[].input_bytes · variant 2nullopcjonalne——
tasks[].attempts[].output_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].output_bytes · variant 1integeropcjonalne——
tasks[].attempts[].output_bytes · variant 2nullopcjonalne——
tasks[].attempts[].wall_msanyOf<integer | null>opcjonalne——
tasks[].attempts[].wall_ms · variant 1integeropcjonalne——
tasks[].attempts[].wall_ms · variant 2nullopcjonalne——
tasks[].attempts[].cpu_msanyOf<integer | null>opcjonalne——
tasks[].attempts[].cpu_ms · variant 1integeropcjonalne——
tasks[].attempts[].cpu_ms · variant 2nullopcjonalne——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcjonalne——
tasks[].attempts[].peak_memory_mb · variant 1integeropcjonalne——
tasks[].attempts[].peak_memory_mb · variant 2nullopcjonalne——
tasks[].attempts[].temp_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].temp_bytes · variant 1integeropcjonalne——
tasks[].attempts[].temp_bytes · variant 2nullopcjonalne——
tasks[].attempts[].error_codeanyOf<string | null>opcjonalne——
tasks[].attempts[].error_code · variant 1stringopcjonalne——
tasks[].attempts[].error_code · variant 2nullopcjonalne——
tasks[].attempts[].error_messageanyOf<string | null>opcjonalne——
tasks[].attempts[].error_message · variant 1stringopcjonalne——
tasks[].attempts[].error_message · variant 2nullopcjonalne——
tasks[].attempts[].estimated_creditsanyOf<string | null>opcjonalne——
tasks[].attempts[].estimated_credits · variant 1stringopcjonalne——
tasks[].attempts[].estimated_credits · variant 2nullopcjonalne——
tasks[].attempts[].settled_creditsanyOf<string | null>opcjonalne——
tasks[].attempts[].settled_credits · variant 1stringopcjonalne——
tasks[].attempts[].settled_credits · variant 2nullopcjonalne——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcjonalne——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopcjonalne——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcjonalne——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcjonalne——
tasks[].attempts[].started_atstringwymagane—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opcjonalne——
tasks[].attempts[].completed_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
job_idpathstringwymagane—
include_attemptsquerybooleanopcjonalne
default: false

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
kindstringwymagane——
statusstringwymagane——
progressintegerwymagane——
taganyOf<string | null>opcjonalne——
tag · variant 1stringopcjonalne——
tag · variant 2nullopcjonalne——
client_reference_idanyOf<string | null>opcjonalne——
client_reference_id · variant 1stringopcjonalne——
client_reference_id · variant 2nullopcjonalne——
metadataobjectopcjonalne——
prioritystringwymagane——
concurrency_limitintegeropcjonalne—
default: 1
originstringwymagane——
created_atstringwymagane—
format: date-time
started_atanyOf<string | null>opcjonalne——
started_at · variant 1stringopcjonalne—
format: date-time
started_at · variant 2nullopcjonalne——
completed_atanyOf<string | null>opcjonalne——
completed_at · variant 1stringopcjonalne—
format: date-time
completed_at · variant 2nullopcjonalne——
error_codeanyOf<string | null>opcjonalne——
error_code · variant 1stringopcjonalne——
error_code · variant 2nullopcjonalne——
error_messageanyOf<string | null>opcjonalne——
error_message · variant 1stringopcjonalne——
error_message · variant 2nullopcjonalne——
tasksobject[]opcjonalne——
tasks[]objectopcjonalne——
tasks[].idstringwymagane——
tasks[].job_idstringwymagane——
tasks[].namestringwymagane——
tasks[].operationstringwymagane——
tasks[].statusstringwymagane——
tasks[].progressintegerwymagane——
tasks[].inputobjectwymagane——
tasks[].optionsobjectwymagane——
tasks[].resultobjectwymagane——
tasks[].requiredbooleanwymagane——
tasks[].runtime_classstringwymagane——
tasks[].prioritystringwymagane——
tasks[].attempt_countintegerwymagane——
tasks[].max_attemptsintegerwymagane——
tasks[].error_codeanyOf<string | null>opcjonalne——
tasks[].error_code · variant 1stringopcjonalne——
tasks[].error_code · variant 2nullopcjonalne——
tasks[].error_messageanyOf<string | null>opcjonalne——
tasks[].error_message · variant 1stringopcjonalne——
tasks[].error_message · variant 2nullopcjonalne——
tasks[].created_atstringwymagane—
format: date-time
tasks[].queued_atanyOf<string | null>opcjonalne——
tasks[].queued_at · variant 1stringopcjonalne—
format: date-time
tasks[].queued_at · variant 2nullopcjonalne——
tasks[].started_atanyOf<string | null>opcjonalne——
tasks[].started_at · variant 1stringopcjonalne—
format: date-time
tasks[].started_at · variant 2nullopcjonalne——
tasks[].completed_atanyOf<string | null>opcjonalne——
tasks[].completed_at · variant 1stringopcjonalne—
format: date-time
tasks[].completed_at · variant 2nullopcjonalne——
tasks[].attemptsobject[]opcjonalne——
tasks[].attempts[]objectopcjonalne——
tasks[].attempts[].idstringwymagane——
tasks[].attempts[].attempt_numberintegerwymagane——
tasks[].attempts[].statusstringwymagane——
tasks[].attempts[].worker_idanyOf<string | null>opcjonalne——
tasks[].attempts[].worker_id · variant 1stringopcjonalne——
tasks[].attempts[].worker_id · variant 2nullopcjonalne——
tasks[].attempts[].runtime_classanyOf<string | null>opcjonalne——
tasks[].attempts[].runtime_class · variant 1stringopcjonalne——
tasks[].attempts[].runtime_class · variant 2nullopcjonalne——
tasks[].attempts[].regionanyOf<string | null>opcjonalne——
tasks[].attempts[].region · variant 1stringopcjonalne——
tasks[].attempts[].region · variant 2nullopcjonalne——
tasks[].attempts[].engineanyOf<string | null>opcjonalne——
tasks[].attempts[].engine · variant 1stringopcjonalne——
tasks[].attempts[].engine · variant 2nullopcjonalne——
tasks[].attempts[].engine_versionanyOf<string | null>opcjonalne——
tasks[].attempts[].engine_version · variant 1stringopcjonalne——
tasks[].attempts[].engine_version · variant 2nullopcjonalne——
tasks[].attempts[].input_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].input_bytes · variant 1integeropcjonalne——
tasks[].attempts[].input_bytes · variant 2nullopcjonalne——
tasks[].attempts[].output_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].output_bytes · variant 1integeropcjonalne——
tasks[].attempts[].output_bytes · variant 2nullopcjonalne——
tasks[].attempts[].wall_msanyOf<integer | null>opcjonalne——
tasks[].attempts[].wall_ms · variant 1integeropcjonalne——
tasks[].attempts[].wall_ms · variant 2nullopcjonalne——
tasks[].attempts[].cpu_msanyOf<integer | null>opcjonalne——
tasks[].attempts[].cpu_ms · variant 1integeropcjonalne——
tasks[].attempts[].cpu_ms · variant 2nullopcjonalne——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcjonalne——
tasks[].attempts[].peak_memory_mb · variant 1integeropcjonalne——
tasks[].attempts[].peak_memory_mb · variant 2nullopcjonalne——
tasks[].attempts[].temp_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].temp_bytes · variant 1integeropcjonalne——
tasks[].attempts[].temp_bytes · variant 2nullopcjonalne——
tasks[].attempts[].error_codeanyOf<string | null>opcjonalne——
tasks[].attempts[].error_code · variant 1stringopcjonalne——
tasks[].attempts[].error_code · variant 2nullopcjonalne——
tasks[].attempts[].error_messageanyOf<string | null>opcjonalne——
tasks[].attempts[].error_message · variant 1stringopcjonalne——
tasks[].attempts[].error_message · variant 2nullopcjonalne——
tasks[].attempts[].estimated_creditsanyOf<string | null>opcjonalne——
tasks[].attempts[].estimated_credits · variant 1stringopcjonalne——
tasks[].attempts[].estimated_credits · variant 2nullopcjonalne——
tasks[].attempts[].settled_creditsanyOf<string | null>opcjonalne——
tasks[].attempts[].settled_credits · variant 1stringopcjonalne——
tasks[].attempts[].settled_credits · variant 2nullopcjonalne——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcjonalne——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopcjonalne——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcjonalne——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcjonalne——
tasks[].attempts[].started_atstringwymagane—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opcjonalne——
tasks[].attempts[].completed_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
job_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
kindstringwymagane——
statusstringwymagane——
progressintegerwymagane——
taganyOf<string | null>opcjonalne——
tag · variant 1stringopcjonalne——
tag · variant 2nullopcjonalne——
client_reference_idanyOf<string | null>opcjonalne——
client_reference_id · variant 1stringopcjonalne——
client_reference_id · variant 2nullopcjonalne——
metadataobjectopcjonalne——
prioritystringwymagane——
concurrency_limitintegeropcjonalne—
default: 1
originstringwymagane——
created_atstringwymagane—
format: date-time
started_atanyOf<string | null>opcjonalne——
started_at · variant 1stringopcjonalne—
format: date-time
started_at · variant 2nullopcjonalne——
completed_atanyOf<string | null>opcjonalne——
completed_at · variant 1stringopcjonalne—
format: date-time
completed_at · variant 2nullopcjonalne——
error_codeanyOf<string | null>opcjonalne——
error_code · variant 1stringopcjonalne——
error_code · variant 2nullopcjonalne——
error_messageanyOf<string | null>opcjonalne——
error_message · variant 1stringopcjonalne——
error_message · variant 2nullopcjonalne——
tasksobject[]opcjonalne——
tasks[]objectopcjonalne——
tasks[].idstringwymagane——
tasks[].job_idstringwymagane——
tasks[].namestringwymagane——
tasks[].operationstringwymagane——
tasks[].statusstringwymagane——
tasks[].progressintegerwymagane——
tasks[].inputobjectwymagane——
tasks[].optionsobjectwymagane——
tasks[].resultobjectwymagane——
tasks[].requiredbooleanwymagane——
tasks[].runtime_classstringwymagane——
tasks[].prioritystringwymagane——
tasks[].attempt_countintegerwymagane——
tasks[].max_attemptsintegerwymagane——
tasks[].error_codeanyOf<string | null>opcjonalne——
tasks[].error_code · variant 1stringopcjonalne——
tasks[].error_code · variant 2nullopcjonalne——
tasks[].error_messageanyOf<string | null>opcjonalne——
tasks[].error_message · variant 1stringopcjonalne——
tasks[].error_message · variant 2nullopcjonalne——
tasks[].created_atstringwymagane—
format: date-time
tasks[].queued_atanyOf<string | null>opcjonalne——
tasks[].queued_at · variant 1stringopcjonalne—
format: date-time
tasks[].queued_at · variant 2nullopcjonalne——
tasks[].started_atanyOf<string | null>opcjonalne——
tasks[].started_at · variant 1stringopcjonalne—
format: date-time
tasks[].started_at · variant 2nullopcjonalne——
tasks[].completed_atanyOf<string | null>opcjonalne——
tasks[].completed_at · variant 1stringopcjonalne—
format: date-time
tasks[].completed_at · variant 2nullopcjonalne——
tasks[].attemptsobject[]opcjonalne——
tasks[].attempts[]objectopcjonalne——
tasks[].attempts[].idstringwymagane——
tasks[].attempts[].attempt_numberintegerwymagane——
tasks[].attempts[].statusstringwymagane——
tasks[].attempts[].worker_idanyOf<string | null>opcjonalne——
tasks[].attempts[].worker_id · variant 1stringopcjonalne——
tasks[].attempts[].worker_id · variant 2nullopcjonalne——
tasks[].attempts[].runtime_classanyOf<string | null>opcjonalne——
tasks[].attempts[].runtime_class · variant 1stringopcjonalne——
tasks[].attempts[].runtime_class · variant 2nullopcjonalne——
tasks[].attempts[].regionanyOf<string | null>opcjonalne——
tasks[].attempts[].region · variant 1stringopcjonalne——
tasks[].attempts[].region · variant 2nullopcjonalne——
tasks[].attempts[].engineanyOf<string | null>opcjonalne——
tasks[].attempts[].engine · variant 1stringopcjonalne——
tasks[].attempts[].engine · variant 2nullopcjonalne——
tasks[].attempts[].engine_versionanyOf<string | null>opcjonalne——
tasks[].attempts[].engine_version · variant 1stringopcjonalne——
tasks[].attempts[].engine_version · variant 2nullopcjonalne——
tasks[].attempts[].input_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].input_bytes · variant 1integeropcjonalne——
tasks[].attempts[].input_bytes · variant 2nullopcjonalne——
tasks[].attempts[].output_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].output_bytes · variant 1integeropcjonalne——
tasks[].attempts[].output_bytes · variant 2nullopcjonalne——
tasks[].attempts[].wall_msanyOf<integer | null>opcjonalne——
tasks[].attempts[].wall_ms · variant 1integeropcjonalne——
tasks[].attempts[].wall_ms · variant 2nullopcjonalne——
tasks[].attempts[].cpu_msanyOf<integer | null>opcjonalne——
tasks[].attempts[].cpu_ms · variant 1integeropcjonalne——
tasks[].attempts[].cpu_ms · variant 2nullopcjonalne——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcjonalne——
tasks[].attempts[].peak_memory_mb · variant 1integeropcjonalne——
tasks[].attempts[].peak_memory_mb · variant 2nullopcjonalne——
tasks[].attempts[].temp_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].temp_bytes · variant 1integeropcjonalne——
tasks[].attempts[].temp_bytes · variant 2nullopcjonalne——
tasks[].attempts[].error_codeanyOf<string | null>opcjonalne——
tasks[].attempts[].error_code · variant 1stringopcjonalne——
tasks[].attempts[].error_code · variant 2nullopcjonalne——
tasks[].attempts[].error_messageanyOf<string | null>opcjonalne——
tasks[].attempts[].error_message · variant 1stringopcjonalne——
tasks[].attempts[].error_message · variant 2nullopcjonalne——
tasks[].attempts[].estimated_creditsanyOf<string | null>opcjonalne——
tasks[].attempts[].estimated_credits · variant 1stringopcjonalne——
tasks[].attempts[].estimated_credits · variant 2nullopcjonalne——
tasks[].attempts[].settled_creditsanyOf<string | null>opcjonalne——
tasks[].attempts[].settled_credits · variant 1stringopcjonalne——
tasks[].attempts[].settled_credits · variant 2nullopcjonalne——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcjonalne——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopcjonalne——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcjonalne——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcjonalne——
tasks[].attempts[].started_atstringwymagane—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opcjonalne——
tasks[].attempts[].completed_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
job_idpathstringwymagane—
timeoutqueryintegeropcjonalne
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>opcjonalne—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
bodyunknownwymagane——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
job_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
kindstringwymagane——
statusstringwymagane——
progressintegerwymagane——
taganyOf<string | null>opcjonalne——
tag · variant 1stringopcjonalne——
tag · variant 2nullopcjonalne——
client_reference_idanyOf<string | null>opcjonalne——
client_reference_id · variant 1stringopcjonalne——
client_reference_id · variant 2nullopcjonalne——
metadataobjectopcjonalne——
prioritystringwymagane——
concurrency_limitintegeropcjonalne—
default: 1
originstringwymagane——
created_atstringwymagane—
format: date-time
started_atanyOf<string | null>opcjonalne——
started_at · variant 1stringopcjonalne—
format: date-time
started_at · variant 2nullopcjonalne——
completed_atanyOf<string | null>opcjonalne——
completed_at · variant 1stringopcjonalne—
format: date-time
completed_at · variant 2nullopcjonalne——
error_codeanyOf<string | null>opcjonalne——
error_code · variant 1stringopcjonalne——
error_code · variant 2nullopcjonalne——
error_messageanyOf<string | null>opcjonalne——
error_message · variant 1stringopcjonalne——
error_message · variant 2nullopcjonalne——
tasksobject[]opcjonalne——
tasks[]objectopcjonalne——
tasks[].idstringwymagane——
tasks[].job_idstringwymagane——
tasks[].namestringwymagane——
tasks[].operationstringwymagane——
tasks[].statusstringwymagane——
tasks[].progressintegerwymagane——
tasks[].inputobjectwymagane——
tasks[].optionsobjectwymagane——
tasks[].resultobjectwymagane——
tasks[].requiredbooleanwymagane——
tasks[].runtime_classstringwymagane——
tasks[].prioritystringwymagane——
tasks[].attempt_countintegerwymagane——
tasks[].max_attemptsintegerwymagane——
tasks[].error_codeanyOf<string | null>opcjonalne——
tasks[].error_code · variant 1stringopcjonalne——
tasks[].error_code · variant 2nullopcjonalne——
tasks[].error_messageanyOf<string | null>opcjonalne——
tasks[].error_message · variant 1stringopcjonalne——
tasks[].error_message · variant 2nullopcjonalne——
tasks[].created_atstringwymagane—
format: date-time
tasks[].queued_atanyOf<string | null>opcjonalne——
tasks[].queued_at · variant 1stringopcjonalne—
format: date-time
tasks[].queued_at · variant 2nullopcjonalne——
tasks[].started_atanyOf<string | null>opcjonalne——
tasks[].started_at · variant 1stringopcjonalne—
format: date-time
tasks[].started_at · variant 2nullopcjonalne——
tasks[].completed_atanyOf<string | null>opcjonalne——
tasks[].completed_at · variant 1stringopcjonalne—
format: date-time
tasks[].completed_at · variant 2nullopcjonalne——
tasks[].attemptsobject[]opcjonalne——
tasks[].attempts[]objectopcjonalne——
tasks[].attempts[].idstringwymagane——
tasks[].attempts[].attempt_numberintegerwymagane——
tasks[].attempts[].statusstringwymagane——
tasks[].attempts[].worker_idanyOf<string | null>opcjonalne——
tasks[].attempts[].worker_id · variant 1stringopcjonalne——
tasks[].attempts[].worker_id · variant 2nullopcjonalne——
tasks[].attempts[].runtime_classanyOf<string | null>opcjonalne——
tasks[].attempts[].runtime_class · variant 1stringopcjonalne——
tasks[].attempts[].runtime_class · variant 2nullopcjonalne——
tasks[].attempts[].regionanyOf<string | null>opcjonalne——
tasks[].attempts[].region · variant 1stringopcjonalne——
tasks[].attempts[].region · variant 2nullopcjonalne——
tasks[].attempts[].engineanyOf<string | null>opcjonalne——
tasks[].attempts[].engine · variant 1stringopcjonalne——
tasks[].attempts[].engine · variant 2nullopcjonalne——
tasks[].attempts[].engine_versionanyOf<string | null>opcjonalne——
tasks[].attempts[].engine_version · variant 1stringopcjonalne——
tasks[].attempts[].engine_version · variant 2nullopcjonalne——
tasks[].attempts[].input_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].input_bytes · variant 1integeropcjonalne——
tasks[].attempts[].input_bytes · variant 2nullopcjonalne——
tasks[].attempts[].output_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].output_bytes · variant 1integeropcjonalne——
tasks[].attempts[].output_bytes · variant 2nullopcjonalne——
tasks[].attempts[].wall_msanyOf<integer | null>opcjonalne——
tasks[].attempts[].wall_ms · variant 1integeropcjonalne——
tasks[].attempts[].wall_ms · variant 2nullopcjonalne——
tasks[].attempts[].cpu_msanyOf<integer | null>opcjonalne——
tasks[].attempts[].cpu_ms · variant 1integeropcjonalne——
tasks[].attempts[].cpu_ms · variant 2nullopcjonalne——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcjonalne——
tasks[].attempts[].peak_memory_mb · variant 1integeropcjonalne——
tasks[].attempts[].peak_memory_mb · variant 2nullopcjonalne——
tasks[].attempts[].temp_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].temp_bytes · variant 1integeropcjonalne——
tasks[].attempts[].temp_bytes · variant 2nullopcjonalne——
tasks[].attempts[].error_codeanyOf<string | null>opcjonalne——
tasks[].attempts[].error_code · variant 1stringopcjonalne——
tasks[].attempts[].error_code · variant 2nullopcjonalne——
tasks[].attempts[].error_messageanyOf<string | null>opcjonalne——
tasks[].attempts[].error_message · variant 1stringopcjonalne——
tasks[].attempts[].error_message · variant 2nullopcjonalne——
tasks[].attempts[].estimated_creditsanyOf<string | null>opcjonalne——
tasks[].attempts[].estimated_credits · variant 1stringopcjonalne——
tasks[].attempts[].estimated_credits · variant 2nullopcjonalne——
tasks[].attempts[].settled_creditsanyOf<string | null>opcjonalne——
tasks[].attempts[].settled_credits · variant 1stringopcjonalne——
tasks[].attempts[].settled_credits · variant 2nullopcjonalne——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcjonalne——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopcjonalne——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcjonalne——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcjonalne——
tasks[].attempts[].started_atstringwymagane—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opcjonalne——
tasks[].attempts[].completed_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
job_idpathstringwymagane—
timeoutqueryintegeropcjonalne
default: 20min: 0max: 30

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
kindstringwymagane——
statusstringwymagane——
progressintegerwymagane——
taganyOf<string | null>opcjonalne——
tag · variant 1stringopcjonalne——
tag · variant 2nullopcjonalne——
client_reference_idanyOf<string | null>opcjonalne——
client_reference_id · variant 1stringopcjonalne——
client_reference_id · variant 2nullopcjonalne——
metadataobjectopcjonalne——
prioritystringwymagane——
concurrency_limitintegeropcjonalne—
default: 1
originstringwymagane——
created_atstringwymagane—
format: date-time
started_atanyOf<string | null>opcjonalne——
started_at · variant 1stringopcjonalne—
format: date-time
started_at · variant 2nullopcjonalne——
completed_atanyOf<string | null>opcjonalne——
completed_at · variant 1stringopcjonalne—
format: date-time
completed_at · variant 2nullopcjonalne——
error_codeanyOf<string | null>opcjonalne——
error_code · variant 1stringopcjonalne——
error_code · variant 2nullopcjonalne——
error_messageanyOf<string | null>opcjonalne——
error_message · variant 1stringopcjonalne——
error_message · variant 2nullopcjonalne——
tasksobject[]opcjonalne——
tasks[]objectopcjonalne——
tasks[].idstringwymagane——
tasks[].job_idstringwymagane——
tasks[].namestringwymagane——
tasks[].operationstringwymagane——
tasks[].statusstringwymagane——
tasks[].progressintegerwymagane——
tasks[].inputobjectwymagane——
tasks[].optionsobjectwymagane——
tasks[].resultobjectwymagane——
tasks[].requiredbooleanwymagane——
tasks[].runtime_classstringwymagane——
tasks[].prioritystringwymagane——
tasks[].attempt_countintegerwymagane——
tasks[].max_attemptsintegerwymagane——
tasks[].error_codeanyOf<string | null>opcjonalne——
tasks[].error_code · variant 1stringopcjonalne——
tasks[].error_code · variant 2nullopcjonalne——
tasks[].error_messageanyOf<string | null>opcjonalne——
tasks[].error_message · variant 1stringopcjonalne——
tasks[].error_message · variant 2nullopcjonalne——
tasks[].created_atstringwymagane—
format: date-time
tasks[].queued_atanyOf<string | null>opcjonalne——
tasks[].queued_at · variant 1stringopcjonalne—
format: date-time
tasks[].queued_at · variant 2nullopcjonalne——
tasks[].started_atanyOf<string | null>opcjonalne——
tasks[].started_at · variant 1stringopcjonalne—
format: date-time
tasks[].started_at · variant 2nullopcjonalne——
tasks[].completed_atanyOf<string | null>opcjonalne——
tasks[].completed_at · variant 1stringopcjonalne—
format: date-time
tasks[].completed_at · variant 2nullopcjonalne——
tasks[].attemptsobject[]opcjonalne——
tasks[].attempts[]objectopcjonalne——
tasks[].attempts[].idstringwymagane——
tasks[].attempts[].attempt_numberintegerwymagane——
tasks[].attempts[].statusstringwymagane——
tasks[].attempts[].worker_idanyOf<string | null>opcjonalne——
tasks[].attempts[].worker_id · variant 1stringopcjonalne——
tasks[].attempts[].worker_id · variant 2nullopcjonalne——
tasks[].attempts[].runtime_classanyOf<string | null>opcjonalne——
tasks[].attempts[].runtime_class · variant 1stringopcjonalne——
tasks[].attempts[].runtime_class · variant 2nullopcjonalne——
tasks[].attempts[].regionanyOf<string | null>opcjonalne——
tasks[].attempts[].region · variant 1stringopcjonalne——
tasks[].attempts[].region · variant 2nullopcjonalne——
tasks[].attempts[].engineanyOf<string | null>opcjonalne——
tasks[].attempts[].engine · variant 1stringopcjonalne——
tasks[].attempts[].engine · variant 2nullopcjonalne——
tasks[].attempts[].engine_versionanyOf<string | null>opcjonalne——
tasks[].attempts[].engine_version · variant 1stringopcjonalne——
tasks[].attempts[].engine_version · variant 2nullopcjonalne——
tasks[].attempts[].input_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].input_bytes · variant 1integeropcjonalne——
tasks[].attempts[].input_bytes · variant 2nullopcjonalne——
tasks[].attempts[].output_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].output_bytes · variant 1integeropcjonalne——
tasks[].attempts[].output_bytes · variant 2nullopcjonalne——
tasks[].attempts[].wall_msanyOf<integer | null>opcjonalne——
tasks[].attempts[].wall_ms · variant 1integeropcjonalne——
tasks[].attempts[].wall_ms · variant 2nullopcjonalne——
tasks[].attempts[].cpu_msanyOf<integer | null>opcjonalne——
tasks[].attempts[].cpu_ms · variant 1integeropcjonalne——
tasks[].attempts[].cpu_ms · variant 2nullopcjonalne——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcjonalne——
tasks[].attempts[].peak_memory_mb · variant 1integeropcjonalne——
tasks[].attempts[].peak_memory_mb · variant 2nullopcjonalne——
tasks[].attempts[].temp_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].temp_bytes · variant 1integeropcjonalne——
tasks[].attempts[].temp_bytes · variant 2nullopcjonalne——
tasks[].attempts[].error_codeanyOf<string | null>opcjonalne——
tasks[].attempts[].error_code · variant 1stringopcjonalne——
tasks[].attempts[].error_code · variant 2nullopcjonalne——
tasks[].attempts[].error_messageanyOf<string | null>opcjonalne——
tasks[].attempts[].error_message · variant 1stringopcjonalne——
tasks[].attempts[].error_message · variant 2nullopcjonalne——
tasks[].attempts[].estimated_creditsanyOf<string | null>opcjonalne——
tasks[].attempts[].estimated_credits · variant 1stringopcjonalne——
tasks[].attempts[].estimated_credits · variant 2nullopcjonalne——
tasks[].attempts[].settled_creditsanyOf<string | null>opcjonalne——
tasks[].attempts[].settled_credits · variant 1stringopcjonalne——
tasks[].attempts[].settled_credits · variant 2nullopcjonalne——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcjonalne——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopcjonalne——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcjonalne——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcjonalne——
tasks[].attempts[].started_atstringwymagane—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opcjonalne——
tasks[].attempts[].completed_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
tasksobjectwymagane——
taganyOf<string | null>opcjonalne——
tag · variant 1stringopcjonalne—
max length: 255
tag · variant 2nullopcjonalne——
client_reference_idanyOf<string | null>opcjonalne——
client_reference_id · variant 1stringopcjonalne—
max length: 255
client_reference_id · variant 2nullopcjonalne——
metadataobjectopcjonalne——
prioritystringopcjonalne—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>opcjonalne——
retention_seconds · variant 1integeropcjonalne—
min: 0max: 86400
retention_seconds · variant 2nullopcjonalne——

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
validbooleanwymagane——
task_countintegerwymagane——
execution_orderstring[]wymagane——
root_tasksstring[]wymagane——
warningsstring[]opcjonalne——
estimated_creditsanyOf<object | null>opcjonalne——
estimated_credits · variant 1objectopcjonalne——
estimated_credits · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
limitqueryintegeropcjonalne
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcjonalne—
status_codequeryanyOf<integer | null>opcjonalne—
path_prefixqueryanyOf<string | null>opcjonalne—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
dataobject[]wymagane——
data[]objectopcjonalne——
data[].request_idstringwymagane——
data[].methodstringwymagane——
data[].pathstringwymagane——
data[].status_codeintegerwymagane——
data[].latency_msintegerwymagane——
data[].api_key_idanyOf<string | null>opcjonalne——
data[].api_key_id · variant 1stringopcjonalne——
data[].api_key_id · variant 2nullopcjonalne——
data[].auth_typestringwymagane——
data[].user_agentanyOf<string | null>opcjonalne——
data[].user_agent · variant 1stringopcjonalne——
data[].user_agent · variant 2nullopcjonalne——
data[].created_atstringwymagane——
paginationobjectwymagane——
pagination.nextanyOf<string | null>opcjonalne——
pagination.next · variant 1stringopcjonalne——
pagination.next · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
request_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
request_idstringwymagane——
methodstringwymagane——
pathstringwymagane——
status_codeintegerwymagane——
latency_msintegerwymagane——
api_key_idanyOf<string | null>opcjonalne——
api_key_id · variant 1stringopcjonalne——
api_key_id · variant 2nullopcjonalne——
auth_typestringwymagane——
user_agentanyOf<string | null>opcjonalne——
user_agent · variant 1stringopcjonalne——
user_agent · variant 2nullopcjonalne——
created_atstringwymagane——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
account_idstringwymagane——
actor_idstringwymagane——
auth_typestringwymagane——
environmentstringwymagane——
access_tierstringopcjonalne—
enum: "sandbox", "paid"default: "paid"
scopesstring[]wymagane——
roleanyOf<string | null>opcjonalne——
role · variant 1stringopcjonalne——
role · variant 2nullopcjonalne——
authorized_partyanyOf<string | null>opcjonalne——
authorized_party · variant 1stringopcjonalne——
authorized_party · variant 2nullopcjonalne——
limitsanyOf<object | null>opcjonalne——
limits · variant 1objectopcjonalne——
limits · variant 1.monthly_callsanyOf<integer | null>opcjonalne——
limits · variant 1.monthly_calls · variant 1integeropcjonalne——
limits · variant 1.monthly_calls · variant 2nullopcjonalne——
limits · variant 1.rate_limit_per_minuteanyOf<integer | null>opcjonalne——
limits · variant 1.rate_limit_per_minute · variant 1integeropcjonalne——
limits · variant 1.rate_limit_per_minute · variant 2nullopcjonalne——
limits · variant 1.daily_requestsanyOf<integer | null>opcjonalne——
limits · variant 1.daily_requests · variant 1integeropcjonalne——
limits · variant 1.daily_requests · variant 2nullopcjonalne——
limits · variant 1.concurrencyanyOf<integer | null>opcjonalne——
limits · variant 1.concurrency · variant 1integeropcjonalne——
limits · variant 1.concurrency · variant 2nullopcjonalne——
limits · variant 1.max_file_mbanyOf<integer | null>opcjonalne——
limits · variant 1.max_file_mb · variant 1integeropcjonalne——
limits · variant 1.max_file_mb · variant 2nullopcjonalne——
limits · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
GET/v1/operationsOperationsDiscovery#

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

UwierzytelnianiePubliczne / brak uwierzytelniania właściwego dla operacji

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
dataobject[]wymagane——
data[]objectopcjonalne——
data[].operationstringwymagane——
data[].categorystringwymagane—
enum: "import", "processing", "export"
data[].descriptionstringwymagane——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
account_idstringwymagane——
environmentstringwymagane——
scopedbooleanwymagane——
project_idanyOf<string | null>opcjonalne——
project_id · variant 1stringopcjonalne——
project_id · variant 2nullopcjonalne——
project_nameanyOf<string | null>opcjonalne——
project_name · variant 1stringopcjonalne——
project_name · variant 2nullopcjonalne——
project_sluganyOf<string | null>opcjonalne——
project_slug · variant 1stringopcjonalne——
project_slug · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
GET/v1/project/legacy-migrationPreview Legacy MigrationAuthentication · Projects#

Preview account/environment resources still in the legacy namespace.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
bodyobjectwymagane——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
POST/v1/project/legacy-migrationMigrate Legacy Project ResourcesAuthentication · Projects#

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

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
confirm_project_idstringwymagane—
min length: 1max length: 64

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
bodyobjectwymagane——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
tokenstringwymagane——
expires_atstringwymagane—
format: date-time
websocket_urlstringwymagane——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
bodyobjectwymagane——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
fixture_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
bodyobjectwymagane——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
bodyobject[]wymagane——
items[]objectopcjonalne——
items[].idstringwymagane——
items[].namestringwymagane——
items[].workflow_idanyOf<string | null>opcjonalne——
items[].workflow_id · variant 1stringopcjonalne——
items[].workflow_id · variant 2nullopcjonalne——
items[].workflow_versionanyOf<integer | null>opcjonalne——
items[].workflow_version · variant 1integeropcjonalne——
items[].workflow_version · variant 2nullopcjonalne——
items[].inline_definitionanyOf<object | null>opcjonalne——
items[].inline_definition · variant 1objectopcjonalne——
items[].inline_definition · variant 2nullopcjonalne——
items[].variables_schemaobjectwymagane——
items[].allowed_source_hostsstring[]wymagane——
items[].max_file_size_bytesanyOf<integer | null>opcjonalne——
items[].max_file_size_bytes · variant 1integeropcjonalne——
items[].max_file_size_bytes · variant 2nullopcjonalne——
items[].max_credits_per_requestanyOf<string | null>opcjonalne——
items[].max_credits_per_request · variant 1stringopcjonalne——
items[].max_credits_per_request · variant 2nullopcjonalne——
items[].max_usesanyOf<integer | null>opcjonalne——
items[].max_uses · variant 1integeropcjonalne——
items[].max_uses · variant 2nullopcjonalne——
items[].use_countintegerwymagane——
items[].cache_ttl_secondsintegerwymagane——
items[].enabledbooleanwymagane——
items[].created_atstringwymagane—
format: date-time
items[].updated_atstringwymagane—
format: date-time
items[].signing_secretanyOf<string | null>opcjonalne——
items[].signing_secret · variant 1stringopcjonalne——
items[].signing_secret · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
namestringwymagane—
min length: 1max length: 255
workflow_idanyOf<string | null>opcjonalne——
workflow_id · variant 1stringopcjonalne——
workflow_id · variant 2nullopcjonalne——
inline_definitionanyOf<object | null>opcjonalne——
inline_definition · variant 1objectopcjonalne——
inline_definition · variant 1.tasksobjectwymagane——
inline_definition · variant 1.taganyOf<string | null>opcjonalne——
inline_definition · variant 1.tag · variant 1stringopcjonalne—
max length: 255
inline_definition · variant 1.tag · variant 2nullopcjonalne——
inline_definition · variant 1.client_reference_idanyOf<string | null>opcjonalne——
inline_definition · variant 1.client_reference_id · variant 1stringopcjonalne—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nullopcjonalne——
inline_definition · variant 1.metadataobjectopcjonalne——
inline_definition · variant 1.prioritystringopcjonalne—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>opcjonalne——
inline_definition · variant 1.retention_seconds · variant 1integeropcjonalne—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nullopcjonalne——
inline_definition · variant 2nullopcjonalne——
variables_schemaobjectopcjonalne——
allowed_source_hostsstring[]opcjonalne——
max_file_size_bytesanyOf<integer | null>opcjonalne——
max_file_size_bytes · variant 1integeropcjonalne——
max_file_size_bytes · variant 2nullopcjonalne——
max_credits_per_requestanyOf<string | null>opcjonalne——
max_credits_per_request · variant 1stringopcjonalne—
max length: 64
max_credits_per_request · variant 2nullopcjonalne——
max_usesanyOf<integer | null>opcjonalne——
max_uses · variant 1integeropcjonalne——
max_uses · variant 2nullopcjonalne——
cache_ttl_secondsintegeropcjonalne—
default: 0min: 0max: 86400

Odpowiedzi

201Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
namestringwymagane——
workflow_idanyOf<string | null>opcjonalne——
workflow_id · variant 1stringopcjonalne——
workflow_id · variant 2nullopcjonalne——
workflow_versionanyOf<integer | null>opcjonalne——
workflow_version · variant 1integeropcjonalne——
workflow_version · variant 2nullopcjonalne——
inline_definitionanyOf<object | null>opcjonalne——
inline_definition · variant 1objectopcjonalne——
inline_definition · variant 2nullopcjonalne——
variables_schemaobjectwymagane——
allowed_source_hostsstring[]wymagane——
max_file_size_bytesanyOf<integer | null>opcjonalne——
max_file_size_bytes · variant 1integeropcjonalne——
max_file_size_bytes · variant 2nullopcjonalne——
max_credits_per_requestanyOf<string | null>opcjonalne——
max_credits_per_request · variant 1stringopcjonalne——
max_credits_per_request · variant 2nullopcjonalne——
max_usesanyOf<integer | null>opcjonalne——
max_uses · variant 1integeropcjonalne——
max_uses · variant 2nullopcjonalne——
use_countintegerwymagane——
cache_ttl_secondsintegerwymagane——
enabledbooleanwymagane——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
signing_secretanyOf<string | null>opcjonalne——
signing_secret · variant 1stringopcjonalne——
signing_secret · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
base_idpathstringwymagane—

Odpowiedzi

204Successful Response

Brak treści odpowiedzi.

400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
base_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
namestringwymagane——
workflow_idanyOf<string | null>opcjonalne——
workflow_id · variant 1stringopcjonalne——
workflow_id · variant 2nullopcjonalne——
workflow_versionanyOf<integer | null>opcjonalne——
workflow_version · variant 1integeropcjonalne——
workflow_version · variant 2nullopcjonalne——
inline_definitionanyOf<object | null>opcjonalne——
inline_definition · variant 1objectopcjonalne——
inline_definition · variant 2nullopcjonalne——
variables_schemaobjectwymagane——
allowed_source_hostsstring[]wymagane——
max_file_size_bytesanyOf<integer | null>opcjonalne——
max_file_size_bytes · variant 1integeropcjonalne——
max_file_size_bytes · variant 2nullopcjonalne——
max_credits_per_requestanyOf<string | null>opcjonalne——
max_credits_per_request · variant 1stringopcjonalne——
max_credits_per_request · variant 2nullopcjonalne——
max_usesanyOf<integer | null>opcjonalne——
max_uses · variant 1integeropcjonalne——
max_uses · variant 2nullopcjonalne——
use_countintegerwymagane——
cache_ttl_secondsintegerwymagane——
enabledbooleanwymagane——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
signing_secretanyOf<string | null>opcjonalne——
signing_secret · variant 1stringopcjonalne——
signing_secret · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
base_idpathstringwymagane—

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
nameanyOf<string | null>opcjonalne——
name · variant 1stringopcjonalne—
min length: 1max length: 255
name · variant 2nullopcjonalne——
workflow_idanyOf<string | null>opcjonalne——
workflow_id · variant 1stringopcjonalne——
workflow_id · variant 2nullopcjonalne——
inline_definitionanyOf<object | null>opcjonalne——
inline_definition · variant 1objectopcjonalne——
inline_definition · variant 1.tasksobjectwymagane——
inline_definition · variant 1.taganyOf<string | null>opcjonalne——
inline_definition · variant 1.tag · variant 1stringopcjonalne—
max length: 255
inline_definition · variant 1.tag · variant 2nullopcjonalne——
inline_definition · variant 1.client_reference_idanyOf<string | null>opcjonalne——
inline_definition · variant 1.client_reference_id · variant 1stringopcjonalne—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nullopcjonalne——
inline_definition · variant 1.metadataobjectopcjonalne——
inline_definition · variant 1.prioritystringopcjonalne—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>opcjonalne——
inline_definition · variant 1.retention_seconds · variant 1integeropcjonalne—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nullopcjonalne——
inline_definition · variant 2nullopcjonalne——
variables_schemaanyOf<object | null>opcjonalne——
variables_schema · variant 1objectopcjonalne——
variables_schema · variant 2nullopcjonalne——
allowed_source_hostsanyOf<string[] | null>opcjonalne——
allowed_source_hosts · variant 1string[]opcjonalne——
allowed_source_hosts · variant 2nullopcjonalne——
max_file_size_bytesanyOf<integer | null>opcjonalne——
max_file_size_bytes · variant 1integeropcjonalne——
max_file_size_bytes · variant 2nullopcjonalne——
max_credits_per_requestanyOf<string | null>opcjonalne——
max_credits_per_request · variant 1stringopcjonalne—
max length: 64
max_credits_per_request · variant 2nullopcjonalne——
max_usesanyOf<integer | null>opcjonalne——
max_uses · variant 1integeropcjonalne——
max_uses · variant 2nullopcjonalne——
cache_ttl_secondsanyOf<integer | null>opcjonalne——
cache_ttl_seconds · variant 1integeropcjonalne—
min: 0max: 86400
cache_ttl_seconds · variant 2nullopcjonalne——
enabledanyOf<boolean | null>opcjonalne——
enabled · variant 1booleanopcjonalne——
enabled · variant 2nullopcjonalne——

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
namestringwymagane——
workflow_idanyOf<string | null>opcjonalne——
workflow_id · variant 1stringopcjonalne——
workflow_id · variant 2nullopcjonalne——
workflow_versionanyOf<integer | null>opcjonalne——
workflow_version · variant 1integeropcjonalne——
workflow_version · variant 2nullopcjonalne——
inline_definitionanyOf<object | null>opcjonalne——
inline_definition · variant 1objectopcjonalne——
inline_definition · variant 2nullopcjonalne——
variables_schemaobjectwymagane——
allowed_source_hostsstring[]wymagane——
max_file_size_bytesanyOf<integer | null>opcjonalne——
max_file_size_bytes · variant 1integeropcjonalne——
max_file_size_bytes · variant 2nullopcjonalne——
max_credits_per_requestanyOf<string | null>opcjonalne——
max_credits_per_request · variant 1stringopcjonalne——
max_credits_per_request · variant 2nullopcjonalne——
max_usesanyOf<integer | null>opcjonalne——
max_uses · variant 1integeropcjonalne——
max_uses · variant 2nullopcjonalne——
use_countintegerwymagane——
cache_ttl_secondsintegerwymagane——
enabledbooleanwymagane——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
signing_secretanyOf<string | null>opcjonalne——
signing_secret · variant 1stringopcjonalne——
signing_secret · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
base_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
namestringwymagane——
workflow_idanyOf<string | null>opcjonalne——
workflow_id · variant 1stringopcjonalne——
workflow_id · variant 2nullopcjonalne——
workflow_versionanyOf<integer | null>opcjonalne——
workflow_version · variant 1integeropcjonalne——
workflow_version · variant 2nullopcjonalne——
inline_definitionanyOf<object | null>opcjonalne——
inline_definition · variant 1objectopcjonalne——
inline_definition · variant 2nullopcjonalne——
variables_schemaobjectwymagane——
allowed_source_hostsstring[]wymagane——
max_file_size_bytesanyOf<integer | null>opcjonalne——
max_file_size_bytes · variant 1integeropcjonalne——
max_file_size_bytes · variant 2nullopcjonalne——
max_credits_per_requestanyOf<string | null>opcjonalne——
max_credits_per_request · variant 1stringopcjonalne——
max_credits_per_request · variant 2nullopcjonalne——
max_usesanyOf<integer | null>opcjonalne——
max_uses · variant 1integeropcjonalne——
max_uses · variant 2nullopcjonalne——
use_countintegerwymagane——
cache_ttl_secondsintegerwymagane——
enabledbooleanwymagane——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
signing_secretanyOf<string | null>opcjonalne——
signing_secret · variant 1stringopcjonalne——
signing_secret · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
base_idpathstringwymagane—

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
variablesobjectopcjonalne——
expires_inintegeropcjonalne—
default: 3600min: 60max: 86400
cache_keyanyOf<string | null>opcjonalne——
cache_key · variant 1stringopcjonalne—
max length: 255
cache_key · variant 2nullopcjonalne——

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
urlstringwymagane——
expires_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

UwierzytelnianiePubliczne / brak uwierzytelniania właściwego dla operacji

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
statusstringwymagane—
enum: "ok", "degraded"
servicestringopcjonalne—
default: "converterhq-api"
api_versionstringopcjonalne—
default: "v1"
timestampstringwymagane—
format: date-time
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

UwierzytelnianiePubliczne / brak uwierzytelniania właściwego dla operacji

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
successful_conversionsintegerwymagane——
input_bytes_processedintegerwymagane——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
task_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
job_idstringwymagane——
namestringwymagane——
operationstringwymagane——
statusstringwymagane——
progressintegerwymagane——
inputobjectwymagane——
optionsobjectwymagane——
resultobjectwymagane——
requiredbooleanwymagane——
runtime_classstringwymagane——
prioritystringwymagane——
attempt_countintegerwymagane——
max_attemptsintegerwymagane——
error_codeanyOf<string | null>opcjonalne——
error_code · variant 1stringopcjonalne——
error_code · variant 2nullopcjonalne——
error_messageanyOf<string | null>opcjonalne——
error_message · variant 1stringopcjonalne——
error_message · variant 2nullopcjonalne——
created_atstringwymagane—
format: date-time
queued_atanyOf<string | null>opcjonalne——
queued_at · variant 1stringopcjonalne—
format: date-time
queued_at · variant 2nullopcjonalne——
started_atanyOf<string | null>opcjonalne——
started_at · variant 1stringopcjonalne—
format: date-time
started_at · variant 2nullopcjonalne——
completed_atanyOf<string | null>opcjonalne——
completed_at · variant 1stringopcjonalne—
format: date-time
completed_at · variant 2nullopcjonalne——
attemptsobject[]opcjonalne——
attempts[]objectopcjonalne——
attempts[].idstringwymagane——
attempts[].attempt_numberintegerwymagane——
attempts[].statusstringwymagane——
attempts[].worker_idanyOf<string | null>opcjonalne——
attempts[].worker_id · variant 1stringopcjonalne——
attempts[].worker_id · variant 2nullopcjonalne——
attempts[].runtime_classanyOf<string | null>opcjonalne——
attempts[].runtime_class · variant 1stringopcjonalne——
attempts[].runtime_class · variant 2nullopcjonalne——
attempts[].regionanyOf<string | null>opcjonalne——
attempts[].region · variant 1stringopcjonalne——
attempts[].region · variant 2nullopcjonalne——
attempts[].engineanyOf<string | null>opcjonalne——
attempts[].engine · variant 1stringopcjonalne——
attempts[].engine · variant 2nullopcjonalne——
attempts[].engine_versionanyOf<string | null>opcjonalne——
attempts[].engine_version · variant 1stringopcjonalne——
attempts[].engine_version · variant 2nullopcjonalne——
attempts[].input_bytesanyOf<integer | null>opcjonalne——
attempts[].input_bytes · variant 1integeropcjonalne——
attempts[].input_bytes · variant 2nullopcjonalne——
attempts[].output_bytesanyOf<integer | null>opcjonalne——
attempts[].output_bytes · variant 1integeropcjonalne——
attempts[].output_bytes · variant 2nullopcjonalne——
attempts[].wall_msanyOf<integer | null>opcjonalne——
attempts[].wall_ms · variant 1integeropcjonalne——
attempts[].wall_ms · variant 2nullopcjonalne——
attempts[].cpu_msanyOf<integer | null>opcjonalne——
attempts[].cpu_ms · variant 1integeropcjonalne——
attempts[].cpu_ms · variant 2nullopcjonalne——
attempts[].peak_memory_mbanyOf<integer | null>opcjonalne——
attempts[].peak_memory_mb · variant 1integeropcjonalne——
attempts[].peak_memory_mb · variant 2nullopcjonalne——
attempts[].temp_bytesanyOf<integer | null>opcjonalne——
attempts[].temp_bytes · variant 1integeropcjonalne——
attempts[].temp_bytes · variant 2nullopcjonalne——
attempts[].error_codeanyOf<string | null>opcjonalne——
attempts[].error_code · variant 1stringopcjonalne——
attempts[].error_code · variant 2nullopcjonalne——
attempts[].error_messageanyOf<string | null>opcjonalne——
attempts[].error_message · variant 1stringopcjonalne——
attempts[].error_message · variant 2nullopcjonalne——
attempts[].estimated_creditsanyOf<string | null>opcjonalne——
attempts[].estimated_credits · variant 1stringopcjonalne——
attempts[].estimated_credits · variant 2nullopcjonalne——
attempts[].settled_creditsanyOf<string | null>opcjonalne——
attempts[].settled_credits · variant 1stringopcjonalne——
attempts[].settled_credits · variant 2nullopcjonalne——
attempts[].external_side_effect_started_atanyOf<string | null>opcjonalne——
attempts[].external_side_effect_started_at · variant 1stringopcjonalne—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullopcjonalne——
attempts[].external_side_effect_committed_atanyOf<string | null>opcjonalne——
attempts[].external_side_effect_committed_at · variant 1stringopcjonalne—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullopcjonalne——
attempts[].started_atstringwymagane—
format: date-time
attempts[].completed_atanyOf<string | null>opcjonalne——
attempts[].completed_at · variant 1stringopcjonalne—
format: date-time
attempts[].completed_at · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
task_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
job_idstringwymagane——
namestringwymagane——
operationstringwymagane——
statusstringwymagane——
progressintegerwymagane——
inputobjectwymagane——
optionsobjectwymagane——
resultobjectwymagane——
requiredbooleanwymagane——
runtime_classstringwymagane——
prioritystringwymagane——
attempt_countintegerwymagane——
max_attemptsintegerwymagane——
error_codeanyOf<string | null>opcjonalne——
error_code · variant 1stringopcjonalne——
error_code · variant 2nullopcjonalne——
error_messageanyOf<string | null>opcjonalne——
error_message · variant 1stringopcjonalne——
error_message · variant 2nullopcjonalne——
created_atstringwymagane—
format: date-time
queued_atanyOf<string | null>opcjonalne——
queued_at · variant 1stringopcjonalne—
format: date-time
queued_at · variant 2nullopcjonalne——
started_atanyOf<string | null>opcjonalne——
started_at · variant 1stringopcjonalne—
format: date-time
started_at · variant 2nullopcjonalne——
completed_atanyOf<string | null>opcjonalne——
completed_at · variant 1stringopcjonalne—
format: date-time
completed_at · variant 2nullopcjonalne——
attemptsobject[]opcjonalne——
attempts[]objectopcjonalne——
attempts[].idstringwymagane——
attempts[].attempt_numberintegerwymagane——
attempts[].statusstringwymagane——
attempts[].worker_idanyOf<string | null>opcjonalne——
attempts[].worker_id · variant 1stringopcjonalne——
attempts[].worker_id · variant 2nullopcjonalne——
attempts[].runtime_classanyOf<string | null>opcjonalne——
attempts[].runtime_class · variant 1stringopcjonalne——
attempts[].runtime_class · variant 2nullopcjonalne——
attempts[].regionanyOf<string | null>opcjonalne——
attempts[].region · variant 1stringopcjonalne——
attempts[].region · variant 2nullopcjonalne——
attempts[].engineanyOf<string | null>opcjonalne——
attempts[].engine · variant 1stringopcjonalne——
attempts[].engine · variant 2nullopcjonalne——
attempts[].engine_versionanyOf<string | null>opcjonalne——
attempts[].engine_version · variant 1stringopcjonalne——
attempts[].engine_version · variant 2nullopcjonalne——
attempts[].input_bytesanyOf<integer | null>opcjonalne——
attempts[].input_bytes · variant 1integeropcjonalne——
attempts[].input_bytes · variant 2nullopcjonalne——
attempts[].output_bytesanyOf<integer | null>opcjonalne——
attempts[].output_bytes · variant 1integeropcjonalne——
attempts[].output_bytes · variant 2nullopcjonalne——
attempts[].wall_msanyOf<integer | null>opcjonalne——
attempts[].wall_ms · variant 1integeropcjonalne——
attempts[].wall_ms · variant 2nullopcjonalne——
attempts[].cpu_msanyOf<integer | null>opcjonalne——
attempts[].cpu_ms · variant 1integeropcjonalne——
attempts[].cpu_ms · variant 2nullopcjonalne——
attempts[].peak_memory_mbanyOf<integer | null>opcjonalne——
attempts[].peak_memory_mb · variant 1integeropcjonalne——
attempts[].peak_memory_mb · variant 2nullopcjonalne——
attempts[].temp_bytesanyOf<integer | null>opcjonalne——
attempts[].temp_bytes · variant 1integeropcjonalne——
attempts[].temp_bytes · variant 2nullopcjonalne——
attempts[].error_codeanyOf<string | null>opcjonalne——
attempts[].error_code · variant 1stringopcjonalne——
attempts[].error_code · variant 2nullopcjonalne——
attempts[].error_messageanyOf<string | null>opcjonalne——
attempts[].error_message · variant 1stringopcjonalne——
attempts[].error_message · variant 2nullopcjonalne——
attempts[].estimated_creditsanyOf<string | null>opcjonalne——
attempts[].estimated_credits · variant 1stringopcjonalne——
attempts[].estimated_credits · variant 2nullopcjonalne——
attempts[].settled_creditsanyOf<string | null>opcjonalne——
attempts[].settled_credits · variant 1stringopcjonalne——
attempts[].settled_credits · variant 2nullopcjonalne——
attempts[].external_side_effect_started_atanyOf<string | null>opcjonalne——
attempts[].external_side_effect_started_at · variant 1stringopcjonalne—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullopcjonalne——
attempts[].external_side_effect_committed_atanyOf<string | null>opcjonalne——
attempts[].external_side_effect_committed_at · variant 1stringopcjonalne—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullopcjonalne——
attempts[].started_atstringwymagane—
format: date-time
attempts[].completed_atanyOf<string | null>opcjonalne——
attempts[].completed_at · variant 1stringopcjonalne—
format: date-time
attempts[].completed_at · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
task_idpathstringwymagane—
timeoutqueryintegeropcjonalne
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>opcjonalne—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
bodyunknownwymagane——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
task_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
job_idstringwymagane——
namestringwymagane——
operationstringwymagane——
statusstringwymagane——
progressintegerwymagane——
inputobjectwymagane——
optionsobjectwymagane——
resultobjectwymagane——
requiredbooleanwymagane——
runtime_classstringwymagane——
prioritystringwymagane——
attempt_countintegerwymagane——
max_attemptsintegerwymagane——
error_codeanyOf<string | null>opcjonalne——
error_code · variant 1stringopcjonalne——
error_code · variant 2nullopcjonalne——
error_messageanyOf<string | null>opcjonalne——
error_message · variant 1stringopcjonalne——
error_message · variant 2nullopcjonalne——
created_atstringwymagane—
format: date-time
queued_atanyOf<string | null>opcjonalne——
queued_at · variant 1stringopcjonalne—
format: date-time
queued_at · variant 2nullopcjonalne——
started_atanyOf<string | null>opcjonalne——
started_at · variant 1stringopcjonalne—
format: date-time
started_at · variant 2nullopcjonalne——
completed_atanyOf<string | null>opcjonalne——
completed_at · variant 1stringopcjonalne—
format: date-time
completed_at · variant 2nullopcjonalne——
attemptsobject[]opcjonalne——
attempts[]objectopcjonalne——
attempts[].idstringwymagane——
attempts[].attempt_numberintegerwymagane——
attempts[].statusstringwymagane——
attempts[].worker_idanyOf<string | null>opcjonalne——
attempts[].worker_id · variant 1stringopcjonalne——
attempts[].worker_id · variant 2nullopcjonalne——
attempts[].runtime_classanyOf<string | null>opcjonalne——
attempts[].runtime_class · variant 1stringopcjonalne——
attempts[].runtime_class · variant 2nullopcjonalne——
attempts[].regionanyOf<string | null>opcjonalne——
attempts[].region · variant 1stringopcjonalne——
attempts[].region · variant 2nullopcjonalne——
attempts[].engineanyOf<string | null>opcjonalne——
attempts[].engine · variant 1stringopcjonalne——
attempts[].engine · variant 2nullopcjonalne——
attempts[].engine_versionanyOf<string | null>opcjonalne——
attempts[].engine_version · variant 1stringopcjonalne——
attempts[].engine_version · variant 2nullopcjonalne——
attempts[].input_bytesanyOf<integer | null>opcjonalne——
attempts[].input_bytes · variant 1integeropcjonalne——
attempts[].input_bytes · variant 2nullopcjonalne——
attempts[].output_bytesanyOf<integer | null>opcjonalne——
attempts[].output_bytes · variant 1integeropcjonalne——
attempts[].output_bytes · variant 2nullopcjonalne——
attempts[].wall_msanyOf<integer | null>opcjonalne——
attempts[].wall_ms · variant 1integeropcjonalne——
attempts[].wall_ms · variant 2nullopcjonalne——
attempts[].cpu_msanyOf<integer | null>opcjonalne——
attempts[].cpu_ms · variant 1integeropcjonalne——
attempts[].cpu_ms · variant 2nullopcjonalne——
attempts[].peak_memory_mbanyOf<integer | null>opcjonalne——
attempts[].peak_memory_mb · variant 1integeropcjonalne——
attempts[].peak_memory_mb · variant 2nullopcjonalne——
attempts[].temp_bytesanyOf<integer | null>opcjonalne——
attempts[].temp_bytes · variant 1integeropcjonalne——
attempts[].temp_bytes · variant 2nullopcjonalne——
attempts[].error_codeanyOf<string | null>opcjonalne——
attempts[].error_code · variant 1stringopcjonalne——
attempts[].error_code · variant 2nullopcjonalne——
attempts[].error_messageanyOf<string | null>opcjonalne——
attempts[].error_message · variant 1stringopcjonalne——
attempts[].error_message · variant 2nullopcjonalne——
attempts[].estimated_creditsanyOf<string | null>opcjonalne——
attempts[].estimated_credits · variant 1stringopcjonalne——
attempts[].estimated_credits · variant 2nullopcjonalne——
attempts[].settled_creditsanyOf<string | null>opcjonalne——
attempts[].settled_credits · variant 1stringopcjonalne——
attempts[].settled_credits · variant 2nullopcjonalne——
attempts[].external_side_effect_started_atanyOf<string | null>opcjonalne——
attempts[].external_side_effect_started_at · variant 1stringopcjonalne—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullopcjonalne——
attempts[].external_side_effect_committed_atanyOf<string | null>opcjonalne——
attempts[].external_side_effect_committed_at · variant 1stringopcjonalne—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullopcjonalne——
attempts[].started_atstringwymagane—
format: date-time
attempts[].completed_atanyOf<string | null>opcjonalne——
attempts[].completed_at · variant 1stringopcjonalne—
format: date-time
attempts[].completed_at · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
limitqueryintegeropcjonalne
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcjonalne—
input_formatqueryanyOf<string | null>opcjonalne—
output_formatqueryanyOf<string | null>opcjonalne—
originqueryanyOf<string | null>opcjonalne—
outcomequeryanyOf<string | null>opcjonalne—
job_idqueryanyOf<string | null>opcjonalne—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
dataobject[]wymagane——
data[]objectopcjonalne——
data[].idstringwymagane——
data[].api_key_idanyOf<string | null>opcjonalne——
data[].api_key_id · variant 1stringopcjonalne——
data[].api_key_id · variant 2nullopcjonalne——
data[].originstringwymagane——
data[].outcomestringopcjonalne—
default: "succeeded"
data[].job_idanyOf<string | null>opcjonalne——
data[].job_id · variant 1stringopcjonalne——
data[].job_id · variant 2nullopcjonalne——
data[].task_idanyOf<string | null>opcjonalne——
data[].task_id · variant 1stringopcjonalne——
data[].task_id · variant 2nullopcjonalne——
data[].input_formatanyOf<string | null>opcjonalne——
data[].input_format · variant 1stringopcjonalne——
data[].input_format · variant 2nullopcjonalne——
data[].output_formatanyOf<string | null>opcjonalne——
data[].output_format · variant 1stringopcjonalne——
data[].output_format · variant 2nullopcjonalne——
data[].engineanyOf<string | null>opcjonalne——
data[].engine · variant 1stringopcjonalne——
data[].engine · variant 2nullopcjonalne——
data[].engine_versionanyOf<string | null>opcjonalne——
data[].engine_version · variant 1stringopcjonalne——
data[].engine_version · variant 2nullopcjonalne——
data[].runtime_classanyOf<string | null>opcjonalne——
data[].runtime_class · variant 1stringopcjonalne——
data[].runtime_class · variant 2nullopcjonalne——
data[].input_bytesanyOf<integer | null>opcjonalne——
data[].input_bytes · variant 1integeropcjonalne——
data[].input_bytes · variant 2nullopcjonalne——
data[].output_bytesanyOf<integer | null>opcjonalne——
data[].output_bytes · variant 1integeropcjonalne——
data[].output_bytes · variant 2nullopcjonalne——
data[].wall_msanyOf<integer | null>opcjonalne——
data[].wall_ms · variant 1integeropcjonalne——
data[].wall_ms · variant 2nullopcjonalne——
data[].creditsanyOf<string | null>opcjonalne——
data[].credits · variant 1stringopcjonalne——
data[].credits · variant 2nullopcjonalne——
data[].created_atstringwymagane—
format: date-time
paginationobjectwymagane——
pagination.nextanyOf<string | null>opcjonalne——
pagination.next · variant 1stringopcjonalne——
pagination.next · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
startqueryanyOf<string | null>opcjonalne—
endqueryanyOf<string | null>opcjonalne—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
startstringwymagane—
format: date-time
endstringwymagane—
format: date-time
conversionsintegerwymagane——
creditsstringwymagane——
input_bytesintegerwymagane——
output_bytesintegerwymagane——
wall_msintegerwymagane——
by_originobject[]opcjonalne——
by_origin[]objectopcjonalne——
by_origin[].keystringwymagane——
by_origin[].conversionsintegerwymagane——
by_origin[].creditsstringwymagane——
top_pairsobject[]opcjonalne——
top_pairs[]objectopcjonalne——
top_pairs[].keystringwymagane——
top_pairs[].conversionsintegerwymagane——
top_pairs[].creditsstringwymagane——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
delivery_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
webhook_idstringwymagane——
event_idstringwymagane——
statusstringwymagane——
attemptintegerwymagane——
request_headersobjectwymagane——
request_bodyobjectwymagane——
response_statusanyOf<integer | null>opcjonalne——
response_status · variant 1integeropcjonalne——
response_status · variant 2nullopcjonalne——
response_bodyanyOf<string | null>opcjonalne——
response_body · variant 1stringopcjonalne——
response_body · variant 2nullopcjonalne——
latency_msanyOf<integer | null>opcjonalne——
latency_ms · variant 1integeropcjonalne——
latency_ms · variant 2nullopcjonalne——
error_messageanyOf<string | null>opcjonalne——
error_message · variant 1stringopcjonalne——
error_message · variant 2nullopcjonalne——
next_retry_atanyOf<string | null>opcjonalne——
next_retry_at · variant 1stringopcjonalne—
format: date-time
next_retry_at · variant 2nullopcjonalne——
delivered_atanyOf<string | null>opcjonalne——
delivered_at · variant 1stringopcjonalne—
format: date-time
delivered_at · variant 2nullopcjonalne——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
delivery_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
webhook_idstringwymagane——
event_idstringwymagane——
statusstringwymagane——
attemptintegerwymagane——
request_headersobjectwymagane——
request_bodyobjectwymagane——
response_statusanyOf<integer | null>opcjonalne——
response_status · variant 1integeropcjonalne——
response_status · variant 2nullopcjonalne——
response_bodyanyOf<string | null>opcjonalne——
response_body · variant 1stringopcjonalne——
response_body · variant 2nullopcjonalne——
latency_msanyOf<integer | null>opcjonalne——
latency_ms · variant 1integeropcjonalne——
latency_ms · variant 2nullopcjonalne——
error_messageanyOf<string | null>opcjonalne——
error_message · variant 1stringopcjonalne——
error_message · variant 2nullopcjonalne——
next_retry_atanyOf<string | null>opcjonalne——
next_retry_at · variant 1stringopcjonalne—
format: date-time
next_retry_at · variant 2nullopcjonalne——
delivered_atanyOf<string | null>opcjonalne——
delivered_at · variant 1stringopcjonalne—
format: date-time
delivered_at · variant 2nullopcjonalne——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
bodyobject[]wymagane——
items[]objectopcjonalne——
items[].idstringwymagane——
items[].urlstringwymagane——
items[].descriptionanyOf<string | null>opcjonalne——
items[].description · variant 1stringopcjonalne——
items[].description · variant 2nullopcjonalne——
items[].event_typesstring[]wymagane——
items[].enabledbooleanwymagane——
items[].failure_countintegerwymagane——
items[].created_atstringwymagane—
format: date-time
items[].updated_atstringwymagane—
format: date-time
items[].signing_secretanyOf<string | null>opcjonalne——
items[].signing_secret · variant 1stringopcjonalne——
items[].signing_secret · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
urlstringwymagane—
min length: 1max length: 2048
descriptionanyOf<string | null>opcjonalne——
description · variant 1stringopcjonalne—
max length: 512
description · variant 2nullopcjonalne——
event_typesstring[]opcjonalne——

Odpowiedzi

201Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
urlstringwymagane——
descriptionanyOf<string | null>opcjonalne——
description · variant 1stringopcjonalne——
description · variant 2nullopcjonalne——
event_typesstring[]wymagane——
enabledbooleanwymagane——
failure_countintegerwymagane——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
signing_secretanyOf<string | null>opcjonalne——
signing_secret · variant 1stringopcjonalne——
signing_secret · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
webhook_idpathstringwymagane—

Odpowiedzi

204Successful Response

Brak treści odpowiedzi.

400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
webhook_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
urlstringwymagane——
descriptionanyOf<string | null>opcjonalne——
description · variant 1stringopcjonalne——
description · variant 2nullopcjonalne——
event_typesstring[]wymagane——
enabledbooleanwymagane——
failure_countintegerwymagane——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
signing_secretanyOf<string | null>opcjonalne——
signing_secret · variant 1stringopcjonalne——
signing_secret · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
webhook_idpathstringwymagane—

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
urlanyOf<string | null>opcjonalne——
url · variant 1stringopcjonalne—
min length: 1max length: 2048
url · variant 2nullopcjonalne——
descriptionanyOf<string | null>opcjonalne——
description · variant 1stringopcjonalne—
max length: 512
description · variant 2nullopcjonalne——
event_typesanyOf<string[] | null>opcjonalne——
event_types · variant 1string[]opcjonalne——
event_types · variant 2nullopcjonalne——
enabledanyOf<boolean | null>opcjonalne——
enabled · variant 1booleanopcjonalne——
enabled · variant 2nullopcjonalne——

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
urlstringwymagane——
descriptionanyOf<string | null>opcjonalne——
description · variant 1stringopcjonalne——
description · variant 2nullopcjonalne——
event_typesstring[]wymagane——
enabledbooleanwymagane——
failure_countintegerwymagane——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
signing_secretanyOf<string | null>opcjonalne——
signing_secret · variant 1stringopcjonalne——
signing_secret · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
webhook_idpathstringwymagane—
limitqueryintegeropcjonalne
default: 50min: 1max: 100
afterqueryanyOf<string | null>opcjonalne—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
dataobject[]wymagane——
data[]objectopcjonalne——
data[].idstringwymagane——
data[].webhook_idstringwymagane——
data[].event_idstringwymagane——
data[].statusstringwymagane——
data[].attemptintegerwymagane——
data[].request_headersobjectwymagane——
data[].request_bodyobjectwymagane——
data[].response_statusanyOf<integer | null>opcjonalne——
data[].response_status · variant 1integeropcjonalne——
data[].response_status · variant 2nullopcjonalne——
data[].response_bodyanyOf<string | null>opcjonalne——
data[].response_body · variant 1stringopcjonalne——
data[].response_body · variant 2nullopcjonalne——
data[].latency_msanyOf<integer | null>opcjonalne——
data[].latency_ms · variant 1integeropcjonalne——
data[].latency_ms · variant 2nullopcjonalne——
data[].error_messageanyOf<string | null>opcjonalne——
data[].error_message · variant 1stringopcjonalne——
data[].error_message · variant 2nullopcjonalne——
data[].next_retry_atanyOf<string | null>opcjonalne——
data[].next_retry_at · variant 1stringopcjonalne—
format: date-time
data[].next_retry_at · variant 2nullopcjonalne——
data[].delivered_atanyOf<string | null>opcjonalne——
data[].delivered_at · variant 1stringopcjonalne—
format: date-time
data[].delivered_at · variant 2nullopcjonalne——
data[].created_atstringwymagane—
format: date-time
data[].updated_atstringwymagane—
format: date-time
paginationobjectwymagane——
pagination.nextanyOf<string | null>opcjonalne——
pagination.next · variant 1stringopcjonalne——
pagination.next · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
webhook_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
signing_secretstringwymagane——
previous_secret_valid_untilanyOf<string | null>opcjonalne——
previous_secret_valid_until · variant 1stringopcjonalne—
format: date-time
previous_secret_valid_until · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
limitqueryintegeropcjonalne
default: 50min: 1max: 200
afterqueryanyOf<string | null>opcjonalne—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
dataobject[]wymagane——
data[]objectopcjonalne——
data[].idstringwymagane——
data[].namestringwymagane——
data[].descriptionanyOf<string | null>opcjonalne——
data[].description · variant 1stringopcjonalne——
data[].description · variant 2nullopcjonalne——
data[].current_versionintegerwymagane——
data[].definitionobjectwymagane——
data[].variables_schemaobjectwymagane——
data[].metadataobjectwymagane——
data[].created_atstringwymagane—
format: date-time
data[].updated_atstringwymagane—
format: date-time
paginationobjectwymagane——
pagination.nextanyOf<string | null>opcjonalne——
pagination.next · variant 1stringopcjonalne——
pagination.next · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
namestringwymagane—
min length: 1max length: 255
descriptionanyOf<string | null>opcjonalne——
description · variant 1stringopcjonalne—
max length: 2000
description · variant 2nullopcjonalne——
definitionobjectwymagane——
definition.tasksobjectwymagane——
definition.taganyOf<string | null>opcjonalne——
definition.tag · variant 1stringopcjonalne—
max length: 255
definition.tag · variant 2nullopcjonalne——
definition.client_reference_idanyOf<string | null>opcjonalne——
definition.client_reference_id · variant 1stringopcjonalne—
max length: 255
definition.client_reference_id · variant 2nullopcjonalne——
definition.metadataobjectopcjonalne——
definition.prioritystringopcjonalne—
enum: "low", "normal", "high"default: "normal"
definition.retention_secondsanyOf<integer | null>opcjonalne——
definition.retention_seconds · variant 1integeropcjonalne—
min: 0max: 86400
definition.retention_seconds · variant 2nullopcjonalne——
variables_schemaobjectopcjonalne——
metadataobjectopcjonalne——

Odpowiedzi

201Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
namestringwymagane——
descriptionanyOf<string | null>opcjonalne——
description · variant 1stringopcjonalne——
description · variant 2nullopcjonalne——
current_versionintegerwymagane——
definitionobjectwymagane——
variables_schemaobjectwymagane——
metadataobjectwymagane——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
workflow_idpathstringwymagane—

Odpowiedzi

204Successful Response

Brak treści odpowiedzi.

400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
workflow_idpathstringwymagane—

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
namestringwymagane——
descriptionanyOf<string | null>opcjonalne——
description · variant 1stringopcjonalne——
description · variant 2nullopcjonalne——
current_versionintegerwymagane——
definitionobjectwymagane——
variables_schemaobjectwymagane——
metadataobjectwymagane——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
workflow_idpathstringwymagane—

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
nameanyOf<string | null>opcjonalne——
name · variant 1stringopcjonalne—
min length: 1max length: 255
name · variant 2nullopcjonalne——
descriptionanyOf<string | null>opcjonalne——
description · variant 1stringopcjonalne—
max length: 2000
description · variant 2nullopcjonalne——
definitionanyOf<object | null>opcjonalne——
definition · variant 1objectopcjonalne——
definition · variant 1.tasksobjectwymagane——
definition · variant 1.taganyOf<string | null>opcjonalne——
definition · variant 1.tag · variant 1stringopcjonalne—
max length: 255
definition · variant 1.tag · variant 2nullopcjonalne——
definition · variant 1.client_reference_idanyOf<string | null>opcjonalne——
definition · variant 1.client_reference_id · variant 1stringopcjonalne—
max length: 255
definition · variant 1.client_reference_id · variant 2nullopcjonalne——
definition · variant 1.metadataobjectopcjonalne——
definition · variant 1.prioritystringopcjonalne—
enum: "low", "normal", "high"default: "normal"
definition · variant 1.retention_secondsanyOf<integer | null>opcjonalne——
definition · variant 1.retention_seconds · variant 1integeropcjonalne—
min: 0max: 86400
definition · variant 1.retention_seconds · variant 2nullopcjonalne——
definition · variant 2nullopcjonalne——
variables_schemaanyOf<object | null>opcjonalne——
variables_schema · variant 1objectopcjonalne——
variables_schema · variant 2nullopcjonalne——
metadataanyOf<object | null>opcjonalne——
metadata · variant 1objectopcjonalne——
metadata · variant 2nullopcjonalne——

Odpowiedzi

200Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
namestringwymagane——
descriptionanyOf<string | null>opcjonalne——
description · variant 1stringopcjonalne——
description · variant 2nullopcjonalne——
current_versionintegerwymagane——
definitionobjectwymagane——
variables_schemaobjectwymagane——
metadataobjectwymagane——
created_atstringwymagane—
format: date-time
updated_atstringwymagane—
format: date-time
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
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.

Uwierzytelnianie
ConverterHQBearerhttp / bearer

Parametry

NazwaLokalizacjaTypWymaganeOpis / ograniczenia
workflow_idpathstringwymagane—
Idempotency-KeyheaderanyOf<string | null>opcjonalne—

Treść żądania wymagane

application/json
PoleTypWymaganeOpisOgraniczenia
variablesobjectopcjonalne——
client_reference_idanyOf<string | null>opcjonalne——
client_reference_id · variant 1stringopcjonalne—
max length: 255
client_reference_id · variant 2nullopcjonalne——
metadataobjectopcjonalne——

Odpowiedzi

201Successful Response
application/json
PoleTypWymaganeOpisOgraniczenia
idstringwymagane——
kindstringwymagane——
statusstringwymagane——
progressintegerwymagane——
taganyOf<string | null>opcjonalne——
tag · variant 1stringopcjonalne——
tag · variant 2nullopcjonalne——
client_reference_idanyOf<string | null>opcjonalne——
client_reference_id · variant 1stringopcjonalne——
client_reference_id · variant 2nullopcjonalne——
metadataobjectopcjonalne——
prioritystringwymagane——
concurrency_limitintegeropcjonalne—
default: 1
originstringwymagane——
created_atstringwymagane—
format: date-time
started_atanyOf<string | null>opcjonalne——
started_at · variant 1stringopcjonalne—
format: date-time
started_at · variant 2nullopcjonalne——
completed_atanyOf<string | null>opcjonalne——
completed_at · variant 1stringopcjonalne—
format: date-time
completed_at · variant 2nullopcjonalne——
error_codeanyOf<string | null>opcjonalne——
error_code · variant 1stringopcjonalne——
error_code · variant 2nullopcjonalne——
error_messageanyOf<string | null>opcjonalne——
error_message · variant 1stringopcjonalne——
error_message · variant 2nullopcjonalne——
tasksobject[]opcjonalne——
tasks[]objectopcjonalne——
tasks[].idstringwymagane——
tasks[].job_idstringwymagane——
tasks[].namestringwymagane——
tasks[].operationstringwymagane——
tasks[].statusstringwymagane——
tasks[].progressintegerwymagane——
tasks[].inputobjectwymagane——
tasks[].optionsobjectwymagane——
tasks[].resultobjectwymagane——
tasks[].requiredbooleanwymagane——
tasks[].runtime_classstringwymagane——
tasks[].prioritystringwymagane——
tasks[].attempt_countintegerwymagane——
tasks[].max_attemptsintegerwymagane——
tasks[].error_codeanyOf<string | null>opcjonalne——
tasks[].error_code · variant 1stringopcjonalne——
tasks[].error_code · variant 2nullopcjonalne——
tasks[].error_messageanyOf<string | null>opcjonalne——
tasks[].error_message · variant 1stringopcjonalne——
tasks[].error_message · variant 2nullopcjonalne——
tasks[].created_atstringwymagane—
format: date-time
tasks[].queued_atanyOf<string | null>opcjonalne——
tasks[].queued_at · variant 1stringopcjonalne—
format: date-time
tasks[].queued_at · variant 2nullopcjonalne——
tasks[].started_atanyOf<string | null>opcjonalne——
tasks[].started_at · variant 1stringopcjonalne—
format: date-time
tasks[].started_at · variant 2nullopcjonalne——
tasks[].completed_atanyOf<string | null>opcjonalne——
tasks[].completed_at · variant 1stringopcjonalne—
format: date-time
tasks[].completed_at · variant 2nullopcjonalne——
tasks[].attemptsobject[]opcjonalne——
tasks[].attempts[]objectopcjonalne——
tasks[].attempts[].idstringwymagane——
tasks[].attempts[].attempt_numberintegerwymagane——
tasks[].attempts[].statusstringwymagane——
tasks[].attempts[].worker_idanyOf<string | null>opcjonalne——
tasks[].attempts[].worker_id · variant 1stringopcjonalne——
tasks[].attempts[].worker_id · variant 2nullopcjonalne——
tasks[].attempts[].runtime_classanyOf<string | null>opcjonalne——
tasks[].attempts[].runtime_class · variant 1stringopcjonalne——
tasks[].attempts[].runtime_class · variant 2nullopcjonalne——
tasks[].attempts[].regionanyOf<string | null>opcjonalne——
tasks[].attempts[].region · variant 1stringopcjonalne——
tasks[].attempts[].region · variant 2nullopcjonalne——
tasks[].attempts[].engineanyOf<string | null>opcjonalne——
tasks[].attempts[].engine · variant 1stringopcjonalne——
tasks[].attempts[].engine · variant 2nullopcjonalne——
tasks[].attempts[].engine_versionanyOf<string | null>opcjonalne——
tasks[].attempts[].engine_version · variant 1stringopcjonalne——
tasks[].attempts[].engine_version · variant 2nullopcjonalne——
tasks[].attempts[].input_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].input_bytes · variant 1integeropcjonalne——
tasks[].attempts[].input_bytes · variant 2nullopcjonalne——
tasks[].attempts[].output_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].output_bytes · variant 1integeropcjonalne——
tasks[].attempts[].output_bytes · variant 2nullopcjonalne——
tasks[].attempts[].wall_msanyOf<integer | null>opcjonalne——
tasks[].attempts[].wall_ms · variant 1integeropcjonalne——
tasks[].attempts[].wall_ms · variant 2nullopcjonalne——
tasks[].attempts[].cpu_msanyOf<integer | null>opcjonalne——
tasks[].attempts[].cpu_ms · variant 1integeropcjonalne——
tasks[].attempts[].cpu_ms · variant 2nullopcjonalne——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>opcjonalne——
tasks[].attempts[].peak_memory_mb · variant 1integeropcjonalne——
tasks[].attempts[].peak_memory_mb · variant 2nullopcjonalne——
tasks[].attempts[].temp_bytesanyOf<integer | null>opcjonalne——
tasks[].attempts[].temp_bytes · variant 1integeropcjonalne——
tasks[].attempts[].temp_bytes · variant 2nullopcjonalne——
tasks[].attempts[].error_codeanyOf<string | null>opcjonalne——
tasks[].attempts[].error_code · variant 1stringopcjonalne——
tasks[].attempts[].error_code · variant 2nullopcjonalne——
tasks[].attempts[].error_messageanyOf<string | null>opcjonalne——
tasks[].attempts[].error_message · variant 1stringopcjonalne——
tasks[].attempts[].error_message · variant 2nullopcjonalne——
tasks[].attempts[].estimated_creditsanyOf<string | null>opcjonalne——
tasks[].attempts[].estimated_credits · variant 1stringopcjonalne——
tasks[].attempts[].estimated_credits · variant 2nullopcjonalne——
tasks[].attempts[].settled_creditsanyOf<string | null>opcjonalne——
tasks[].attempts[].settled_credits · variant 1stringopcjonalne——
tasks[].attempts[].settled_credits · variant 2nullopcjonalne——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>opcjonalne——
tasks[].attempts[].external_side_effect_started_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullopcjonalne——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>opcjonalne——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullopcjonalne——
tasks[].attempts[].started_atstringwymagane—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>opcjonalne——
tasks[].attempts[].completed_at · variant 1stringopcjonalne—
format: date-time
tasks[].attempts[].completed_at · variant 2nullopcjonalne——
400The request could not be processed.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
401Authentication is missing or invalid.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
403The principal is not allowed to perform this operation.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
409The request conflicts with the current resource or idempotency state.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
422Validation Error
application/json
PoleTypWymaganeOpisOgraniczenia
detailobject[]opcjonalne——
detail[]objectopcjonalne——
detail[].locanyOf<string | integer>[]wymagane——
detail[].loc[]anyOf<string | integer>opcjonalne——
detail[].loc[] · variant 1stringopcjonalne——
detail[].loc[] · variant 2integeropcjonalne——
detail[].msgstringwymagane——
detail[].typestringwymagane——
429The caller has exceeded an admission-control limit.
Nagłówki odpowiedziRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
500An unexpected server error occurred.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——
503A required service is temporarily unavailable.
application/problem+json
PoleTypWymaganeOpisOgraniczenia
typestringwymagane—
default: "about:blank"
titlestringwymagane——
statusintegerwymagane—
min: 400max: 599
codestringwymagane——
detailstringwymagane——
retryablebooleanwymagane——
parameteranyOf<string | null>opcjonalne——
parameter · variant 1stringopcjonalne——
parameter · variant 2nullopcjonalne——
request_idanyOf<string | null>opcjonalne——
request_id · variant 1stringopcjonalne——
request_id · variant 2nullopcjonalne——