ConverterHQDevelopers
Seçilen genel OpenAPI sözleşmesinden oluşturuldu

REST API referansı

Parametreleri, kimlik doğrulamayı, iç içe alanları, yanıt şemalarını, hataları ve çalıştırılabilir örnekleri inceleyin. Son kullanıcı, SEO ve yönetim yolları kapsam dışıdır.

74 gösterilen uç noktalar74 toplam işlem17 etiketler3.1.0 şema
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.

Kimlik doğrulamaGenel / işleme özgü kimlik doğrulama gerekmez

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
input_formatqueryanyOf<string | null>isteğe bağlı—
output_formatqueryanyOf<string | null>isteğe bağlı—
includequeryanyOf<string | null>isteğe bağlı
Comma-separated expansions. Use `options` or `options.details` for pair-specific option metadata.
—
limitqueryintegeristeğe bağlı
default: 50min: 1max: 200
afterqueryanyOf<string | null>isteğe bağlı—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
dataobject[]gerekli——
data[]objectisteğe bağlı——
data[].supportedbooleangerekli——
data[].input_formatstringgerekli——
data[].output_formatstringgerekli——
data[].maturitystringisteğe bağlı—
enum: "stable", "disabled"default: "stable"
data[].settings_scopestringisteğe bağlıSettings 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[].routeobjectisteğe bağlı——
data[].route.multi_stepbooleanisteğe bağlıTrue 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[]isteğe bağlıSetting 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>isteğe bağlıStable 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 1stringisteğe bağlı——
data[].options_version · variant 2nullisteğe bağlı——
data[].optionsobject[]isteğe bağlıSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
data[].options[]objectisteğe bağlı——
data[].options[].namestringgerekli——
data[].options[].typestringgerekli——
data[].options[].labelstringgerekli——
data[].options[].descriptionanyOf<string | null>isteğe bağlı——
data[].options[].description · variant 1stringisteğe bağlı——
data[].options[].description · variant 2nullisteğe bağlı——
data[].options[].requiredbooleanisteğe bağlı—
default: false
data[].options[].advancedbooleanisteğe bağlı—
default: false
data[].options[].groupanyOf<string | null>isteğe bağlı——
data[].options[].group · variant 1stringisteğe bağlı——
data[].options[].group · variant 2nullisteğe bağlı——
data[].options[].defaultunknownisteğe bağlı——
data[].options[].possible_valuesanyOf<unknown[] | null>isteğe bağlı——
data[].options[].possible_values · variant 1unknown[]isteğe bağlı——
data[].options[].possible_values · variant 2nullisteğe bağlı——
data[].options[].minimumanyOf<integer | number | null>isteğe bağlı——
data[].options[].minimum · variant 1integeristeğe bağlı——
data[].options[].minimum · variant 2numberisteğe bağlı——
data[].options[].minimum · variant 3nullisteğe bağlı——
data[].options[].maximumanyOf<integer | number | null>isteğe bağlı——
data[].options[].maximum · variant 1integeristeğe bağlı——
data[].options[].maximum · variant 2numberisteğe bağlı——
data[].options[].maximum · variant 3nullisteğe bağlı——
data[].options[].depends_onobject[]isteğe bağlı——
data[].options[].conflicts_withstring[]isteğe bağlı——
data[].options[].schemaanyOf<object | null>isteğe bağlı——
data[].options[].schema · variant 1objectisteğe bağlı——
data[].options[].schema · variant 2nullisteğe bağlı——
data[].options_schemaobjectisteğe bağlıStrict JSON Schema for the settings accepted by this pair-level conversion task.—
data[].limitsobjectisteğe bağlı——
data[].billingobjectisteğe bağlı——
paginationobjectgerekli——
pagination.nextanyOf<string | null>isteğe bağlı——
pagination.next · variant 1stringisteğe bağlı——
pagination.next · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulamaGenel / işleme özgü kimlik doğrulama gerekmez

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
from_formatpathstringgerekli—
to_formatpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
supportedbooleangerekli——
input_formatstringgerekli——
output_formatstringgerekli——
maturitystringisteğe bağlı—
enum: "stable", "disabled"default: "stable"
settings_scopestringisteğe bağlıSettings 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"
routeobjectisteğe bağlı——
route.multi_stepbooleanisteğe bağlıTrue 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[]isteğe bağlıSetting 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>isteğe bağlıStable 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 1stringisteğe bağlı——
options_version · variant 2nullisteğe bağlı——
optionsobject[]isteğe bağlıSettings accepted by this pair-level conversion task. Ambiguous hidden-stage settings are intentionally omitted.—
options[]objectisteğe bağlı——
options[].namestringgerekli——
options[].typestringgerekli——
options[].labelstringgerekli——
options[].descriptionanyOf<string | null>isteğe bağlı——
options[].description · variant 1stringisteğe bağlı——
options[].description · variant 2nullisteğe bağlı——
options[].requiredbooleanisteğe bağlı—
default: false
options[].advancedbooleanisteğe bağlı—
default: false
options[].groupanyOf<string | null>isteğe bağlı——
options[].group · variant 1stringisteğe bağlı——
options[].group · variant 2nullisteğe bağlı——
options[].defaultunknownisteğe bağlı——
options[].possible_valuesanyOf<unknown[] | null>isteğe bağlı——
options[].possible_values · variant 1unknown[]isteğe bağlı——
options[].possible_values · variant 2nullisteğe bağlı——
options[].minimumanyOf<integer | number | null>isteğe bağlı——
options[].minimum · variant 1integeristeğe bağlı——
options[].minimum · variant 2numberisteğe bağlı——
options[].minimum · variant 3nullisteğe bağlı——
options[].maximumanyOf<integer | number | null>isteğe bağlı——
options[].maximum · variant 1integeristeğe bağlı——
options[].maximum · variant 2numberisteğe bağlı——
options[].maximum · variant 3nullisteğe bağlı——
options[].depends_onobject[]isteğe bağlı——
options[].conflicts_withstring[]isteğe bağlı——
options[].schemaanyOf<object | null>isteğe bağlı——
options[].schema · variant 1objectisteğe bağlı——
options[].schema · variant 2nullisteğe bağlı——
options_schemaobjectisteğe bağlıStrict JSON Schema for the settings accepted by this pair-level conversion task.—
limitsobjectisteğe bağlı——
billingobjectisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
account_idstringgerekli——
productstringgerekli——
api_enabledbooleangerekli——
plansstring[]gerekli——
effective_planobjectgerekli——
effective_plan.codestringgerekli——
effective_plan.namestringgerekli——
effective_plan.familyanyOf<string | null>isteğe bağlı——
effective_plan.family · variant 1stringisteğe bağlı——
effective_plan.family · variant 2nullisteğe bağlı——
effective_plan.billing_intervalanyOf<string | null>isteğe bağlı——
effective_plan.billing_interval · variant 1stringisteğe bağlı——
effective_plan.billing_interval · variant 2nullisteğe bağlı——
creditsobjectgerekli——
credits.availablestringgerekli——
credits.reservedstringgerekli——
credits.debtstringgerekli——
quotaanyOf<object | null>isteğe bağlı——
quota · variant 1objectisteğe bağlı——
quota · variant 1.keystringgerekli——
quota · variant 1.periodstringgerekli——
quota · variant 1.period_keystringgerekli——
quota · variant 1.limitstringgerekli——
quota · variant 1.usedstringgerekli——
quota · variant 1.remainingstringgerekli——
quota · variant 1.period_startstringgerekli—
format: date-time
quota · variant 1.period_endstringgerekli—
format: date-time
quota · variant 2nullisteğe bağlı——
subscriptionsobject[]gerekli——
subscriptions[]objectisteğe bağlı——
subscriptions[].idstringgerekli——
subscriptions[].planstringgerekli——
subscriptions[].statusstringgerekli——
subscriptions[].billing_intervalanyOf<string | null>isteğe bağlı——
subscriptions[].billing_interval · variant 1stringisteğe bağlı——
subscriptions[].billing_interval · variant 2nullisteğe bağlı——
subscriptions[].current_period_startanyOf<string | null>isteğe bağlı——
subscriptions[].current_period_start · variant 1stringisteğe bağlı—
format: date-time
subscriptions[].current_period_start · variant 2nullisteğe bağlı——
subscriptions[].current_period_endanyOf<string | null>isteğe bağlı——
subscriptions[].current_period_end · variant 1stringisteğe bağlı—
format: date-time
subscriptions[].current_period_end · variant 2nullisteğe bağlı——
subscriptions[].next_billed_atanyOf<string | null>isteğe bağlı——
subscriptions[].next_billed_at · variant 1stringisteğe bağlı—
format: date-time
subscriptions[].next_billed_at · variant 2nullisteğe bağlı——
passesobject[]gerekli——
passes[]objectisteğe bağlı——
passes[].idstringgerekli——
passes[].offerstringgerekli——
passes[].planstringgerekli——
passes[].starts_atstringgerekli—
format: date-time
passes[].expires_atstringgerekli—
format: date-time
generated_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
limitqueryintegeristeğe bağlı
default: 50min: 1max: 200
afterqueryanyOf<string | null>isteğe bağlı—
providerqueryanyOf<string | null>isteğe bağlı—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
dataobject[]gerekli——
data[]objectisteğe bağlı——
data[].idstringgerekli——
data[].namestringgerekli——
data[].providerstringgerekli—
enum: "s3", "gcs", "azure", "sftp"
data[].config_summaryobjectgerekli——
data[].enabledbooleangerekli——
data[].created_atstringgerekli—
format: date-time
data[].updated_atstringgerekli—
format: date-time
paginationobjectgerekli——
pagination.nextanyOf<string | null>isteğe bağlı——
pagination.next · variant 1stringisteğe bağlı——
pagination.next · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
namestringgerekli—
min length: 1max length: 255
providerstringgerekli—
enum: "s3", "gcs", "azure", "sftp"
configobjectgerekli——

Yanıtlar

201Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
namestringgerekli——
providerstringgerekli—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectgerekli——
enabledbooleangerekli——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
connection_idpathstringgerekli—

Yanıtlar

204Successful Response

Yanıt gövdesi yok.

400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
connection_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
namestringgerekli——
providerstringgerekli—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectgerekli——
enabledbooleangerekli——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
connection_idpathstringgerekli—

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
nameanyOf<string | null>isteğe bağlı——
name · variant 1stringisteğe bağlı—
min length: 1max length: 255
name · variant 2nullisteğe bağlı——
configanyOf<object | null>isteğe bağlı——
config · variant 1objectisteğe bağlı——
config · variant 2nullisteğe bağlı——
enabledanyOf<boolean | null>isteğe bağlı——
enabled · variant 1booleanisteğe bağlı——
enabled · variant 2nullisteğe bağlı——

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
namestringgerekli——
providerstringgerekli—
enum: "s3", "gcs", "azure", "sftp"
config_summaryobjectgerekli——
enabledbooleangerekli——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
connection_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
okbooleangerekli——
providerstringgerekli——
detailsobjectisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
PreferheaderanyOf<string | null>isteğe bağlı—
Idempotency-KeyheaderanyOf<string | null>isteğe bağlı—

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
inputobjectgerekli——
input.file_idanyOf<string | null>isteğe bağlı—
default: null
input.file_id · variant 1stringisteğe bağlı——
input.file_id · variant 2nullisteğe bağlı——
input.urlanyOf<string | null>isteğe bağlı—
default: null
input.url · variant 1stringisteğe bağlı——
input.url · variant 2nullisteğe bağlı——
input_formatanyOf<string | null>isteğe bağlı—
default: null
input_format · variant 1stringisteğe bağlı——
input_format · variant 2nullisteğe bağlı——
output_formatstringgerekli—
min length: 1max length: 64
optionsobjectisteğe bağlı——
filenameanyOf<string | null>isteğe bağlı—
default: null
filename · variant 1stringisteğe bağlı—
max length: 512
filename · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
client_reference_idanyOf<string | null>isteğe bağlı—
default: null
client_reference_id · variant 1stringisteğe bağlı—
max length: 255
client_reference_id · variant 2nullisteğe bağlı——
retention_secondsanyOf<integer | null>isteğe bağlı—
default: null
retention_seconds · variant 1integeristeğe bağlı—
min: 0max: 86400
retention_seconds · variant 2nullisteğe bağlı——
multipart/form-data
AlanTürGerekliAçıklamaKısıtlamalar
filestringgerekliInput file, up to 4 MiB.
format: binary
input_formatstringisteğe bağlıOptional source format when it cannot be detected.—
output_formatstringgerekliRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringisteğe bağlıJSON object containing pair-specific conversion options.—
metadatastringisteğe bağlıJSON object copied to the created Job.—
filenamestringisteğe bağlıOptional output filename hint.—
client_reference_idstringisteğe bağlıOptional caller-defined reference.—
retention_secondsintegeristeğe bağlı—
min: 0max: 86400

Yanıtlar

200Conversion completed within the requested wait window.
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
job_idstringgerekli——
statusstringgerekli——
progressintegergerekli——
input_formatanyOf<string | null>isteğe bağlı——
input_format · variant 1stringisteğe bağlı——
input_format · variant 2nullisteğe bağlı——
output_formatstringgerekli——
output_fileanyOf<object | null>isteğe bağlı——
output_file · variant 1objectisteğe bağlı——
output_file · variant 1.idstringgerekli——
output_file · variant 1.statusstringgerekli——
output_file · variant 1.rolestringgerekli——
output_file · variant 1.filenamestringgerekli——
output_file · variant 1.content_typeanyOf<string | null>isteğe bağlı——
output_file · variant 1.content_type · variant 1stringisteğe bağlı——
output_file · variant 1.content_type · variant 2nullisteğe bağlı——
output_file · variant 1.detected_content_typeanyOf<string | null>isteğe bağlı——
output_file · variant 1.detected_content_type · variant 1stringisteğe bağlı——
output_file · variant 1.detected_content_type · variant 2nullisteğe bağlı——
output_file · variant 1.detected_formatanyOf<string | null>isteğe bağlı——
output_file · variant 1.detected_format · variant 1stringisteğe bağlı——
output_file · variant 1.detected_format · variant 2nullisteğe bağlı——
output_file · variant 1.size_bytesanyOf<integer | null>isteğe bağlı——
output_file · variant 1.size_bytes · variant 1integeristeğe bağlı——
output_file · variant 1.size_bytes · variant 2nullisteğe bağlı——
output_file · variant 1.checksum_sha256anyOf<string | null>isteğe bağlı——
output_file · variant 1.checksum_sha256 · variant 1stringisteğe bağlı——
output_file · variant 1.checksum_sha256 · variant 2nullisteğe bağlı——
output_file · variant 1.source_typestringgerekli——
output_file · variant 1.created_atstringgerekli—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>isteğe bağlı——
output_file · variant 1.ready_at · variant 1stringisteğe bağlı—
format: date-time
output_file · variant 1.ready_at · variant 2nullisteğe bağlı——
output_file · variant 1.expires_atanyOf<string | null>isteğe bağlı——
output_file · variant 1.expires_at · variant 1stringisteğe bağlı—
format: date-time
output_file · variant 1.expires_at · variant 2nullisteğe bağlı——
output_file · variant 1.metadataobjectisteğe bağlı——
output_file · variant 1.uploadanyOf<object | null>isteğe bağlı——
output_file · variant 1.upload · variant 1objectisteğe bağlı——
output_file · variant 1.upload · variant 1.methodstringisteğe bağlı—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringgerekli——
output_file · variant 1.upload · variant 1.expires_atstringgerekli—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectisteğe bağlı——
output_file · variant 1.upload · variant 2nullisteğe bağlı——
output_file · variant 1.download_urlanyOf<string | null>isteğe bağlı——
output_file · variant 1.download_url · variant 1stringisteğe bağlı——
output_file · variant 1.download_url · variant 2nullisteğe bağlı——
output_file · variant 1.download_expires_atanyOf<string | null>isteğe bağlı——
output_file · variant 1.download_expires_at · variant 1stringisteğe bağlı—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullisteğe bağlı——
output_file · variant 2nullisteğe bağlı——
created_atstringgerekli—
format: date-time
202Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
job_idstringgerekli——
statusstringgerekli——
progressintegergerekli——
input_formatanyOf<string | null>isteğe bağlı——
input_format · variant 1stringisteğe bağlı——
input_format · variant 2nullisteğe bağlı——
output_formatstringgerekli——
output_fileanyOf<object | null>isteğe bağlı——
output_file · variant 1objectisteğe bağlı——
output_file · variant 1.idstringgerekli——
output_file · variant 1.statusstringgerekli——
output_file · variant 1.rolestringgerekli——
output_file · variant 1.filenamestringgerekli——
output_file · variant 1.content_typeanyOf<string | null>isteğe bağlı——
output_file · variant 1.content_type · variant 1stringisteğe bağlı——
output_file · variant 1.content_type · variant 2nullisteğe bağlı——
output_file · variant 1.detected_content_typeanyOf<string | null>isteğe bağlı——
output_file · variant 1.detected_content_type · variant 1stringisteğe bağlı——
output_file · variant 1.detected_content_type · variant 2nullisteğe bağlı——
output_file · variant 1.detected_formatanyOf<string | null>isteğe bağlı——
output_file · variant 1.detected_format · variant 1stringisteğe bağlı——
output_file · variant 1.detected_format · variant 2nullisteğe bağlı——
output_file · variant 1.size_bytesanyOf<integer | null>isteğe bağlı——
output_file · variant 1.size_bytes · variant 1integeristeğe bağlı——
output_file · variant 1.size_bytes · variant 2nullisteğe bağlı——
output_file · variant 1.checksum_sha256anyOf<string | null>isteğe bağlı——
output_file · variant 1.checksum_sha256 · variant 1stringisteğe bağlı——
output_file · variant 1.checksum_sha256 · variant 2nullisteğe bağlı——
output_file · variant 1.source_typestringgerekli——
output_file · variant 1.created_atstringgerekli—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>isteğe bağlı——
output_file · variant 1.ready_at · variant 1stringisteğe bağlı—
format: date-time
output_file · variant 1.ready_at · variant 2nullisteğe bağlı——
output_file · variant 1.expires_atanyOf<string | null>isteğe bağlı——
output_file · variant 1.expires_at · variant 1stringisteğe bağlı—
format: date-time
output_file · variant 1.expires_at · variant 2nullisteğe bağlı——
output_file · variant 1.metadataobjectisteğe bağlı——
output_file · variant 1.uploadanyOf<object | null>isteğe bağlı——
output_file · variant 1.upload · variant 1objectisteğe bağlı——
output_file · variant 1.upload · variant 1.methodstringisteğe bağlı—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringgerekli——
output_file · variant 1.upload · variant 1.expires_atstringgerekli—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectisteğe bağlı——
output_file · variant 1.upload · variant 2nullisteğe bağlı——
output_file · variant 1.download_urlanyOf<string | null>isteğe bağlı——
output_file · variant 1.download_url · variant 1stringisteğe bağlı——
output_file · variant 1.download_url · variant 2nullisteğe bağlı——
output_file · variant 1.download_expires_atanyOf<string | null>isteğe bağlı——
output_file · variant 1.download_expires_at · variant 1stringisteğe bağlı—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullisteğe bağlı——
output_file · variant 2nullisteğe bağlı——
created_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
from_formatpathstringgerekli—
to_formatpathstringgerekli—
PreferheaderanyOf<string | null>isteğe bağlı—
Idempotency-KeyheaderanyOf<string | null>isteğe bağlı—

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
inputobjectgerekli——
input.file_idanyOf<string | null>isteğe bağlı—
default: null
input.file_id · variant 1stringisteğe bağlı——
input.file_id · variant 2nullisteğe bağlı——
input.urlanyOf<string | null>isteğe bağlı—
default: null
input.url · variant 1stringisteğe bağlı——
input.url · variant 2nullisteğe bağlı——
input_formatanyOf<string | null>isteğe bağlı—
default: null
input_format · variant 1stringisteğe bağlı——
input_format · variant 2nullisteğe bağlı——
output_formatstringgerekli—
min length: 1max length: 64
optionsobjectisteğe bağlı——
filenameanyOf<string | null>isteğe bağlı—
default: null
filename · variant 1stringisteğe bağlı—
max length: 512
filename · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
client_reference_idanyOf<string | null>isteğe bağlı—
default: null
client_reference_id · variant 1stringisteğe bağlı—
max length: 255
client_reference_id · variant 2nullisteğe bağlı——
retention_secondsanyOf<integer | null>isteğe bağlı—
default: null
retention_seconds · variant 1integeristeğe bağlı—
min: 0max: 86400
retention_seconds · variant 2nullisteğe bağlı——
multipart/form-data
AlanTürGerekliAçıklamaKısıtlamalar
filestringgerekliInput file, up to 4 MiB.
format: binary
input_formatstringisteğe bağlıOptional source format when it cannot be detected.—
output_formatstringisteğe bağlıRequired on POST /v1/convert; inferred from the pair URL otherwise.—
optionsstringisteğe bağlıJSON object containing pair-specific conversion options.—
metadatastringisteğe bağlıJSON object copied to the created Job.—
filenamestringisteğe bağlıOptional output filename hint.—
client_reference_idstringisteğe bağlıOptional caller-defined reference.—
retention_secondsintegeristeğe bağlı—
min: 0max: 86400

Yanıtlar

200Conversion completed within the requested wait window.
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
job_idstringgerekli——
statusstringgerekli——
progressintegergerekli——
input_formatanyOf<string | null>isteğe bağlı——
input_format · variant 1stringisteğe bağlı——
input_format · variant 2nullisteğe bağlı——
output_formatstringgerekli——
output_fileanyOf<object | null>isteğe bağlı——
output_file · variant 1objectisteğe bağlı——
output_file · variant 1.idstringgerekli——
output_file · variant 1.statusstringgerekli——
output_file · variant 1.rolestringgerekli——
output_file · variant 1.filenamestringgerekli——
output_file · variant 1.content_typeanyOf<string | null>isteğe bağlı——
output_file · variant 1.content_type · variant 1stringisteğe bağlı——
output_file · variant 1.content_type · variant 2nullisteğe bağlı——
output_file · variant 1.detected_content_typeanyOf<string | null>isteğe bağlı——
output_file · variant 1.detected_content_type · variant 1stringisteğe bağlı——
output_file · variant 1.detected_content_type · variant 2nullisteğe bağlı——
output_file · variant 1.detected_formatanyOf<string | null>isteğe bağlı——
output_file · variant 1.detected_format · variant 1stringisteğe bağlı——
output_file · variant 1.detected_format · variant 2nullisteğe bağlı——
output_file · variant 1.size_bytesanyOf<integer | null>isteğe bağlı——
output_file · variant 1.size_bytes · variant 1integeristeğe bağlı——
output_file · variant 1.size_bytes · variant 2nullisteğe bağlı——
output_file · variant 1.checksum_sha256anyOf<string | null>isteğe bağlı——
output_file · variant 1.checksum_sha256 · variant 1stringisteğe bağlı——
output_file · variant 1.checksum_sha256 · variant 2nullisteğe bağlı——
output_file · variant 1.source_typestringgerekli——
output_file · variant 1.created_atstringgerekli—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>isteğe bağlı——
output_file · variant 1.ready_at · variant 1stringisteğe bağlı—
format: date-time
output_file · variant 1.ready_at · variant 2nullisteğe bağlı——
output_file · variant 1.expires_atanyOf<string | null>isteğe bağlı——
output_file · variant 1.expires_at · variant 1stringisteğe bağlı—
format: date-time
output_file · variant 1.expires_at · variant 2nullisteğe bağlı——
output_file · variant 1.metadataobjectisteğe bağlı——
output_file · variant 1.uploadanyOf<object | null>isteğe bağlı——
output_file · variant 1.upload · variant 1objectisteğe bağlı——
output_file · variant 1.upload · variant 1.methodstringisteğe bağlı—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringgerekli——
output_file · variant 1.upload · variant 1.expires_atstringgerekli—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectisteğe bağlı——
output_file · variant 1.upload · variant 2nullisteğe bağlı——
output_file · variant 1.download_urlanyOf<string | null>isteğe bağlı——
output_file · variant 1.download_url · variant 1stringisteğe bağlı——
output_file · variant 1.download_url · variant 2nullisteğe bağlı——
output_file · variant 1.download_expires_atanyOf<string | null>isteğe bağlı——
output_file · variant 1.download_expires_at · variant 1stringisteğe bağlı—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullisteğe bağlı——
output_file · variant 2nullisteğe bağlı——
created_atstringgerekli—
format: date-time
202Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
job_idstringgerekli——
statusstringgerekli——
progressintegergerekli——
input_formatanyOf<string | null>isteğe bağlı——
input_format · variant 1stringisteğe bağlı——
input_format · variant 2nullisteğe bağlı——
output_formatstringgerekli——
output_fileanyOf<object | null>isteğe bağlı——
output_file · variant 1objectisteğe bağlı——
output_file · variant 1.idstringgerekli——
output_file · variant 1.statusstringgerekli——
output_file · variant 1.rolestringgerekli——
output_file · variant 1.filenamestringgerekli——
output_file · variant 1.content_typeanyOf<string | null>isteğe bağlı——
output_file · variant 1.content_type · variant 1stringisteğe bağlı——
output_file · variant 1.content_type · variant 2nullisteğe bağlı——
output_file · variant 1.detected_content_typeanyOf<string | null>isteğe bağlı——
output_file · variant 1.detected_content_type · variant 1stringisteğe bağlı——
output_file · variant 1.detected_content_type · variant 2nullisteğe bağlı——
output_file · variant 1.detected_formatanyOf<string | null>isteğe bağlı——
output_file · variant 1.detected_format · variant 1stringisteğe bağlı——
output_file · variant 1.detected_format · variant 2nullisteğe bağlı——
output_file · variant 1.size_bytesanyOf<integer | null>isteğe bağlı——
output_file · variant 1.size_bytes · variant 1integeristeğe bağlı——
output_file · variant 1.size_bytes · variant 2nullisteğe bağlı——
output_file · variant 1.checksum_sha256anyOf<string | null>isteğe bağlı——
output_file · variant 1.checksum_sha256 · variant 1stringisteğe bağlı——
output_file · variant 1.checksum_sha256 · variant 2nullisteğe bağlı——
output_file · variant 1.source_typestringgerekli——
output_file · variant 1.created_atstringgerekli—
format: date-time
output_file · variant 1.ready_atanyOf<string | null>isteğe bağlı——
output_file · variant 1.ready_at · variant 1stringisteğe bağlı—
format: date-time
output_file · variant 1.ready_at · variant 2nullisteğe bağlı——
output_file · variant 1.expires_atanyOf<string | null>isteğe bağlı——
output_file · variant 1.expires_at · variant 1stringisteğe bağlı—
format: date-time
output_file · variant 1.expires_at · variant 2nullisteğe bağlı——
output_file · variant 1.metadataobjectisteğe bağlı——
output_file · variant 1.uploadanyOf<object | null>isteğe bağlı——
output_file · variant 1.upload · variant 1objectisteğe bağlı——
output_file · variant 1.upload · variant 1.methodstringisteğe bağlı—
default: "PUT"
output_file · variant 1.upload · variant 1.urlstringgerekli——
output_file · variant 1.upload · variant 1.expires_atstringgerekli—
format: date-time
output_file · variant 1.upload · variant 1.headersobjectisteğe bağlı——
output_file · variant 1.upload · variant 2nullisteğe bağlı——
output_file · variant 1.download_urlanyOf<string | null>isteğe bağlı——
output_file · variant 1.download_url · variant 1stringisteğe bağlı——
output_file · variant 1.download_url · variant 2nullisteğe bağlı——
output_file · variant 1.download_expires_atanyOf<string | null>isteğe bağlı——
output_file · variant 1.download_expires_at · variant 1stringisteğe bağlı—
format: date-time
output_file · variant 1.download_expires_at · variant 2nullisteğe bağlı——
output_file · variant 2nullisteğe bağlı——
created_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
input_formatstringgerekli——
output_formatstringgerekli——
size_bytesanyOf<integer | null>isteğe bağlı——
size_bytes · variant 1integeristeğe bağlı—
min: 0
size_bytes · variant 2nullisteğe bağlı——
page_countanyOf<integer | null>isteğe bağlı——
page_count · variant 1integeristeğe bağlı—
min: 0
page_count · variant 2nullisteğe bağlı——
duration_secondsanyOf<number | null>isteğe bağlı——
duration_seconds · variant 1numberisteğe bağlı—
min: 0
duration_seconds · variant 2nullisteğe bağlı——
optionsobjectisteğe bağlı——

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
supportedbooleangerekli——
recommended_modestringgerekli—
enum: "sync", "async"
creditsobjectgerekli——
warningsstring[]isteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
GET/v1/event-typesEvent TypesDiscovery#

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

Kimlik doğrulamaGenel / işleme özgü kimlik doğrulama gerekmez

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
dataobject[]gerekli——
data[]objectisteğe bağlı——
data[].typestringgerekli——
data[].descriptionstringgerekli——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
limitqueryintegeristeğe bağlı
default: 50min: 1max: 200
afterqueryanyOf<string | null>isteğe bağlı—
statusqueryanyOf<string | null>isteğe bağlı—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
dataobject[]gerekli——
data[]objectisteğe bağlı——
data[].idstringgerekli——
data[].statusstringgerekli——
data[].rolestringgerekli——
data[].filenamestringgerekli——
data[].content_typeanyOf<string | null>isteğe bağlı——
data[].content_type · variant 1stringisteğe bağlı——
data[].content_type · variant 2nullisteğe bağlı——
data[].detected_content_typeanyOf<string | null>isteğe bağlı——
data[].detected_content_type · variant 1stringisteğe bağlı——
data[].detected_content_type · variant 2nullisteğe bağlı——
data[].detected_formatanyOf<string | null>isteğe bağlı——
data[].detected_format · variant 1stringisteğe bağlı——
data[].detected_format · variant 2nullisteğe bağlı——
data[].size_bytesanyOf<integer | null>isteğe bağlı——
data[].size_bytes · variant 1integeristeğe bağlı——
data[].size_bytes · variant 2nullisteğe bağlı——
data[].checksum_sha256anyOf<string | null>isteğe bağlı——
data[].checksum_sha256 · variant 1stringisteğe bağlı——
data[].checksum_sha256 · variant 2nullisteğe bağlı——
data[].source_typestringgerekli——
data[].created_atstringgerekli—
format: date-time
data[].ready_atanyOf<string | null>isteğe bağlı——
data[].ready_at · variant 1stringisteğe bağlı—
format: date-time
data[].ready_at · variant 2nullisteğe bağlı——
data[].expires_atanyOf<string | null>isteğe bağlı——
data[].expires_at · variant 1stringisteğe bağlı—
format: date-time
data[].expires_at · variant 2nullisteğe bağlı——
data[].metadataobjectisteğe bağlı——
data[].uploadanyOf<object | null>isteğe bağlı——
data[].upload · variant 1objectisteğe bağlı——
data[].upload · variant 1.methodstringisteğe bağlı—
default: "PUT"
data[].upload · variant 1.urlstringgerekli——
data[].upload · variant 1.expires_atstringgerekli—
format: date-time
data[].upload · variant 1.headersobjectisteğe bağlı——
data[].upload · variant 2nullisteğe bağlı——
data[].download_urlanyOf<string | null>isteğe bağlı——
data[].download_url · variant 1stringisteğe bağlı——
data[].download_url · variant 2nullisteğe bağlı——
data[].download_expires_atanyOf<string | null>isteğe bağlı——
data[].download_expires_at · variant 1stringisteğe bağlı—
format: date-time
data[].download_expires_at · variant 2nullisteğe bağlı——
paginationobjectgerekli——
pagination.nextanyOf<string | null>isteğe bağlı——
pagination.next · variant 1stringisteğe bağlı——
pagination.next · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
filenamestringgerekli—
min length: 1max length: 512
size_bytesanyOf<integer | null>isteğe bağlı——
size_bytes · variant 1integeristeğe bağlı—
min: 0
size_bytes · variant 2nullisteğe bağlı——
content_typeanyOf<string | null>isteğe bağlı——
content_type · variant 1stringisteğe bağlı—
max length: 255
content_type · variant 2nullisteğe bağlı——
checksum_sha256anyOf<string | null>isteğe bağlı——
checksum_sha256 · variant 1stringisteğe bağlı—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullisteğe bağlı——
retention_secondsanyOf<integer | null>isteğe bağlı——
retention_seconds · variant 1integeristeğe bağlı—
min: 0max: 86400
retention_seconds · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——

Yanıtlar

201Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
statusstringgerekli——
rolestringgerekli——
filenamestringgerekli——
content_typeanyOf<string | null>isteğe bağlı——
content_type · variant 1stringisteğe bağlı——
content_type · variant 2nullisteğe bağlı——
detected_content_typeanyOf<string | null>isteğe bağlı——
detected_content_type · variant 1stringisteğe bağlı——
detected_content_type · variant 2nullisteğe bağlı——
detected_formatanyOf<string | null>isteğe bağlı——
detected_format · variant 1stringisteğe bağlı——
detected_format · variant 2nullisteğe bağlı——
size_bytesanyOf<integer | null>isteğe bağlı——
size_bytes · variant 1integeristeğe bağlı——
size_bytes · variant 2nullisteğe bağlı——
checksum_sha256anyOf<string | null>isteğe bağlı——
checksum_sha256 · variant 1stringisteğe bağlı——
checksum_sha256 · variant 2nullisteğe bağlı——
source_typestringgerekli——
created_atstringgerekli—
format: date-time
ready_atanyOf<string | null>isteğe bağlı——
ready_at · variant 1stringisteğe bağlı—
format: date-time
ready_at · variant 2nullisteğe bağlı——
expires_atanyOf<string | null>isteğe bağlı——
expires_at · variant 1stringisteğe bağlı—
format: date-time
expires_at · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
uploadanyOf<object | null>isteğe bağlı——
upload · variant 1objectisteğe bağlı——
upload · variant 1.methodstringisteğe bağlı—
default: "PUT"
upload · variant 1.urlstringgerekli——
upload · variant 1.expires_atstringgerekli—
format: date-time
upload · variant 1.headersobjectisteğe bağlı——
upload · variant 2nullisteğe bağlı——
download_urlanyOf<string | null>isteğe bağlı——
download_url · variant 1stringisteğe bağlı——
download_url · variant 2nullisteğe bağlı——
download_expires_atanyOf<string | null>isteğe bağlı——
download_expires_at · variant 1stringisteğe bağlı—
format: date-time
download_expires_at · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
file_idpathstringgerekli—

Yanıtlar

204Successful Response

Yanıt gövdesi yok.

400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
file_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
statusstringgerekli——
rolestringgerekli——
filenamestringgerekli——
content_typeanyOf<string | null>isteğe bağlı——
content_type · variant 1stringisteğe bağlı——
content_type · variant 2nullisteğe bağlı——
detected_content_typeanyOf<string | null>isteğe bağlı——
detected_content_type · variant 1stringisteğe bağlı——
detected_content_type · variant 2nullisteğe bağlı——
detected_formatanyOf<string | null>isteğe bağlı——
detected_format · variant 1stringisteğe bağlı——
detected_format · variant 2nullisteğe bağlı——
size_bytesanyOf<integer | null>isteğe bağlı——
size_bytes · variant 1integeristeğe bağlı——
size_bytes · variant 2nullisteğe bağlı——
checksum_sha256anyOf<string | null>isteğe bağlı——
checksum_sha256 · variant 1stringisteğe bağlı——
checksum_sha256 · variant 2nullisteğe bağlı——
source_typestringgerekli——
created_atstringgerekli—
format: date-time
ready_atanyOf<string | null>isteğe bağlı——
ready_at · variant 1stringisteğe bağlı—
format: date-time
ready_at · variant 2nullisteğe bağlı——
expires_atanyOf<string | null>isteğe bağlı——
expires_at · variant 1stringisteğe bağlı—
format: date-time
expires_at · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
uploadanyOf<object | null>isteğe bağlı——
upload · variant 1objectisteğe bağlı——
upload · variant 1.methodstringisteğe bağlı—
default: "PUT"
upload · variant 1.urlstringgerekli——
upload · variant 1.expires_atstringgerekli—
format: date-time
upload · variant 1.headersobjectisteğe bağlı——
upload · variant 2nullisteğe bağlı——
download_urlanyOf<string | null>isteğe bağlı——
download_url · variant 1stringisteğe bağlı——
download_url · variant 2nullisteğe bağlı——
download_expires_atanyOf<string | null>isteğe bağlı——
download_expires_at · variant 1stringisteğe bağlı—
format: date-time
download_expires_at · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
file_idpathstringgerekli—

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
checksum_sha256anyOf<string | null>isteğe bağlı——
checksum_sha256 · variant 1stringisteğe bağlı—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullisteğe bağlı——

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
statusstringgerekli——
rolestringgerekli——
filenamestringgerekli——
content_typeanyOf<string | null>isteğe bağlı——
content_type · variant 1stringisteğe bağlı——
content_type · variant 2nullisteğe bağlı——
detected_content_typeanyOf<string | null>isteğe bağlı——
detected_content_type · variant 1stringisteğe bağlı——
detected_content_type · variant 2nullisteğe bağlı——
detected_formatanyOf<string | null>isteğe bağlı——
detected_format · variant 1stringisteğe bağlı——
detected_format · variant 2nullisteğe bağlı——
size_bytesanyOf<integer | null>isteğe bağlı——
size_bytes · variant 1integeristeğe bağlı——
size_bytes · variant 2nullisteğe bağlı——
checksum_sha256anyOf<string | null>isteğe bağlı——
checksum_sha256 · variant 1stringisteğe bağlı——
checksum_sha256 · variant 2nullisteğe bağlı——
source_typestringgerekli——
created_atstringgerekli—
format: date-time
ready_atanyOf<string | null>isteğe bağlı——
ready_at · variant 1stringisteğe bağlı—
format: date-time
ready_at · variant 2nullisteğe bağlı——
expires_atanyOf<string | null>isteğe bağlı——
expires_at · variant 1stringisteğe bağlı—
format: date-time
expires_at · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
uploadanyOf<object | null>isteğe bağlı——
upload · variant 1objectisteğe bağlı——
upload · variant 1.methodstringisteğe bağlı—
default: "PUT"
upload · variant 1.urlstringgerekli——
upload · variant 1.expires_atstringgerekli—
format: date-time
upload · variant 1.headersobjectisteğe bağlı——
upload · variant 2nullisteğe bağlı——
download_urlanyOf<string | null>isteğe bağlı——
download_url · variant 1stringisteğe bağlı——
download_url · variant 2nullisteğe bağlı——
download_expires_atanyOf<string | null>isteğe bağlı——
download_expires_at · variant 1stringisteğe bağlı—
format: date-time
download_expires_at · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
file_idpathstringgerekli—

Yanıtlar

204Successful Response

Yanıt gövdesi yok.

400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
file_idpathstringgerekli—

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
part_sizeanyOf<integer | null>isteğe bağlı——
part_size · variant 1integeristeğe bağlı—
min: 5242880max: 5368709120
part_size · variant 2nullisteğe bağlı——

Yanıtlar

201Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
file_idstringgerekli——
upload_idstringgerekli——
part_sizeintegergerekli——
max_partsintegeristeğe bağlı—
default: 10000
expires_atstringgerekli—
format: date-time
partsobject[]isteğe bağlı——
parts[]objectisteğe bağlı——
parts[].part_numberintegergerekli——
parts[].urlstringgerekli——
parts[].expires_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
file_idpathstringgerekli—

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
partsobject[]gerekli—
min items: 1max items: 10000
parts[]objectisteğe bağlı——
parts[].part_numberintegergerekli—
min: 1max: 10000
parts[].etagstringgerekli—
min length: 1max length: 512
checksum_sha256anyOf<string | null>isteğe bağlı——
checksum_sha256 · variant 1stringisteğe bağlı—
pattern: ^[0-9a-fA-F]{64}$
checksum_sha256 · variant 2nullisteğe bağlı——

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
statusstringgerekli——
rolestringgerekli——
filenamestringgerekli——
content_typeanyOf<string | null>isteğe bağlı——
content_type · variant 1stringisteğe bağlı——
content_type · variant 2nullisteğe bağlı——
detected_content_typeanyOf<string | null>isteğe bağlı——
detected_content_type · variant 1stringisteğe bağlı——
detected_content_type · variant 2nullisteğe bağlı——
detected_formatanyOf<string | null>isteğe bağlı——
detected_format · variant 1stringisteğe bağlı——
detected_format · variant 2nullisteğe bağlı——
size_bytesanyOf<integer | null>isteğe bağlı——
size_bytes · variant 1integeristeğe bağlı——
size_bytes · variant 2nullisteğe bağlı——
checksum_sha256anyOf<string | null>isteğe bağlı——
checksum_sha256 · variant 1stringisteğe bağlı——
checksum_sha256 · variant 2nullisteğe bağlı——
source_typestringgerekli——
created_atstringgerekli—
format: date-time
ready_atanyOf<string | null>isteğe bağlı——
ready_at · variant 1stringisteğe bağlı—
format: date-time
ready_at · variant 2nullisteğe bağlı——
expires_atanyOf<string | null>isteğe bağlı——
expires_at · variant 1stringisteğe bağlı—
format: date-time
expires_at · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
uploadanyOf<object | null>isteğe bağlı——
upload · variant 1objectisteğe bağlı——
upload · variant 1.methodstringisteğe bağlı—
default: "PUT"
upload · variant 1.urlstringgerekli——
upload · variant 1.expires_atstringgerekli—
format: date-time
upload · variant 1.headersobjectisteğe bağlı——
upload · variant 2nullisteğe bağlı——
download_urlanyOf<string | null>isteğe bağlı——
download_url · variant 1stringisteğe bağlı——
download_url · variant 2nullisteğe bağlı——
download_expires_atanyOf<string | null>isteğe bağlı——
download_expires_at · variant 1stringisteğe bağlı—
format: date-time
download_expires_at · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
file_idpathstringgerekli—

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
part_numbersinteger[]gerekli—
min items: 1max items: 1000

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
file_idstringgerekli——
upload_idstringgerekli——
part_sizeintegergerekli——
max_partsintegeristeğe bağlı—
default: 10000
expires_atstringgerekli—
format: date-time
partsobject[]isteğe bağlı——
parts[]objectisteğe bağlı——
parts[].part_numberintegergerekli——
parts[].urlstringgerekli——
parts[].expires_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulamaGenel / işleme özgü kimlik doğrulama gerekmez

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
limitqueryintegeristeğe bağlı
default: 500min: 1max: 500

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
dataobject[]gerekli——
data[]objectisteğe bağlı——
data[].slugstringgerekli——
data[].labelstringgerekli——
data[].categorystringgerekli——
data[].mime_typesstring[]gerekli——
data[].extensionsstring[]gerekli——
paginationobjectgerekli——
pagination.nextanyOf<string | null>isteğe bağlı——
pagination.next · variant 1stringisteğe bağlı——
pagination.next · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulamaGenel / işleme özgü kimlik doğrulama gerekmez

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
slugpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
slugstringgerekli——
labelstringgerekli——
categorystringgerekli——
mime_typesstring[]gerekli——
extensionsstring[]gerekli——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulamaGenel / işleme özgü kimlik doğrulama gerekmez

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
slugpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
dataobject[]gerekli——
data[]objectisteğe bağlı——
data[].slugstringgerekli——
data[].labelstringgerekli——
data[].categorystringgerekli——
data[].mime_typesstring[]gerekli——
data[].extensionsstring[]gerekli——
paginationobjectgerekli——
pagination.nextanyOf<string | null>isteğe bağlı——
pagination.next · variant 1stringisteğe bağlı——
pagination.next · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulamaGenel / işleme özgü kimlik doğrulama gerekmez

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
slugpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
dataobject[]gerekli——
data[]objectisteğe bağlı——
data[].slugstringgerekli——
data[].labelstringgerekli——
data[].categorystringgerekli——
data[].mime_typesstring[]gerekli——
data[].extensionsstring[]gerekli——
paginationobjectgerekli——
pagination.nextanyOf<string | null>isteğe bağlı——
pagination.next · variant 1stringisteğe bağlı——
pagination.next · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
limitqueryintegeristeğe bağlı
default: 50min: 1max: 200
afterqueryanyOf<string | null>isteğe bağlı—
statusqueryanyOf<string | null>isteğe bağlı—
tagqueryanyOf<string | null>isteğe bağlı—
originqueryanyOf<string | null>isteğe bağlı—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
dataobject[]gerekli——
data[]objectisteğe bağlı——
data[].idstringgerekli——
data[].kindstringgerekli——
data[].statusstringgerekli——
data[].progressintegergerekli——
data[].taganyOf<string | null>isteğe bağlı——
data[].tag · variant 1stringisteğe bağlı——
data[].tag · variant 2nullisteğe bağlı——
data[].client_reference_idanyOf<string | null>isteğe bağlı——
data[].client_reference_id · variant 1stringisteğe bağlı——
data[].client_reference_id · variant 2nullisteğe bağlı——
data[].metadataobjectisteğe bağlı——
data[].prioritystringgerekli——
data[].concurrency_limitintegeristeğe bağlı—
default: 1
data[].originstringgerekli——
data[].created_atstringgerekli—
format: date-time
data[].started_atanyOf<string | null>isteğe bağlı——
data[].started_at · variant 1stringisteğe bağlı—
format: date-time
data[].started_at · variant 2nullisteğe bağlı——
data[].completed_atanyOf<string | null>isteğe bağlı——
data[].completed_at · variant 1stringisteğe bağlı—
format: date-time
data[].completed_at · variant 2nullisteğe bağlı——
data[].error_codeanyOf<string | null>isteğe bağlı——
data[].error_code · variant 1stringisteğe bağlı——
data[].error_code · variant 2nullisteğe bağlı——
data[].error_messageanyOf<string | null>isteğe bağlı——
data[].error_message · variant 1stringisteğe bağlı——
data[].error_message · variant 2nullisteğe bağlı——
data[].tasksobject[]isteğe bağlı——
data[].tasks[]objectisteğe bağlı——
data[].tasks[].idstringgerekli——
data[].tasks[].job_idstringgerekli——
data[].tasks[].namestringgerekli——
data[].tasks[].operationstringgerekli——
data[].tasks[].statusstringgerekli——
data[].tasks[].progressintegergerekli——
data[].tasks[].inputobjectgerekli——
data[].tasks[].optionsobjectgerekli——
data[].tasks[].resultobjectgerekli——
data[].tasks[].requiredbooleangerekli——
data[].tasks[].runtime_classstringgerekli——
data[].tasks[].prioritystringgerekli——
data[].tasks[].attempt_countintegergerekli——
data[].tasks[].max_attemptsintegergerekli——
data[].tasks[].error_codeanyOf<string | null>isteğe bağlı——
data[].tasks[].error_code · variant 1stringisteğe bağlı——
data[].tasks[].error_code · variant 2nullisteğe bağlı——
data[].tasks[].error_messageanyOf<string | null>isteğe bağlı——
data[].tasks[].error_message · variant 1stringisteğe bağlı——
data[].tasks[].error_message · variant 2nullisteğe bağlı——
data[].tasks[].created_atstringgerekli—
format: date-time
data[].tasks[].queued_atanyOf<string | null>isteğe bağlı——
data[].tasks[].queued_at · variant 1stringisteğe bağlı—
format: date-time
data[].tasks[].queued_at · variant 2nullisteğe bağlı——
data[].tasks[].started_atanyOf<string | null>isteğe bağlı——
data[].tasks[].started_at · variant 1stringisteğe bağlı—
format: date-time
data[].tasks[].started_at · variant 2nullisteğe bağlı——
data[].tasks[].completed_atanyOf<string | null>isteğe bağlı——
data[].tasks[].completed_at · variant 1stringisteğe bağlı—
format: date-time
data[].tasks[].completed_at · variant 2nullisteğe bağlı——
data[].tasks[].attemptsobject[]isteğe bağlı——
data[].tasks[].attempts[]objectisteğe bağlı——
data[].tasks[].attempts[].idstringgerekli——
data[].tasks[].attempts[].attempt_numberintegergerekli——
data[].tasks[].attempts[].statusstringgerekli——
data[].tasks[].attempts[].worker_idanyOf<string | null>isteğe bağlı——
data[].tasks[].attempts[].worker_id · variant 1stringisteğe bağlı——
data[].tasks[].attempts[].worker_id · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].runtime_classanyOf<string | null>isteğe bağlı——
data[].tasks[].attempts[].runtime_class · variant 1stringisteğe bağlı——
data[].tasks[].attempts[].runtime_class · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].regionanyOf<string | null>isteğe bağlı——
data[].tasks[].attempts[].region · variant 1stringisteğe bağlı——
data[].tasks[].attempts[].region · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].engineanyOf<string | null>isteğe bağlı——
data[].tasks[].attempts[].engine · variant 1stringisteğe bağlı——
data[].tasks[].attempts[].engine · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].engine_versionanyOf<string | null>isteğe bağlı——
data[].tasks[].attempts[].engine_version · variant 1stringisteğe bağlı——
data[].tasks[].attempts[].engine_version · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].input_bytesanyOf<integer | null>isteğe bağlı——
data[].tasks[].attempts[].input_bytes · variant 1integeristeğe bağlı——
data[].tasks[].attempts[].input_bytes · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].output_bytesanyOf<integer | null>isteğe bağlı——
data[].tasks[].attempts[].output_bytes · variant 1integeristeğe bağlı——
data[].tasks[].attempts[].output_bytes · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].wall_msanyOf<integer | null>isteğe bağlı——
data[].tasks[].attempts[].wall_ms · variant 1integeristeğe bağlı——
data[].tasks[].attempts[].wall_ms · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].cpu_msanyOf<integer | null>isteğe bağlı——
data[].tasks[].attempts[].cpu_ms · variant 1integeristeğe bağlı——
data[].tasks[].attempts[].cpu_ms · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].peak_memory_mbanyOf<integer | null>isteğe bağlı——
data[].tasks[].attempts[].peak_memory_mb · variant 1integeristeğe bağlı——
data[].tasks[].attempts[].peak_memory_mb · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].temp_bytesanyOf<integer | null>isteğe bağlı——
data[].tasks[].attempts[].temp_bytes · variant 1integeristeğe bağlı——
data[].tasks[].attempts[].temp_bytes · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].error_codeanyOf<string | null>isteğe bağlı——
data[].tasks[].attempts[].error_code · variant 1stringisteğe bağlı——
data[].tasks[].attempts[].error_code · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].error_messageanyOf<string | null>isteğe bağlı——
data[].tasks[].attempts[].error_message · variant 1stringisteğe bağlı——
data[].tasks[].attempts[].error_message · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].estimated_creditsanyOf<string | null>isteğe bağlı——
data[].tasks[].attempts[].estimated_credits · variant 1stringisteğe bağlı——
data[].tasks[].attempts[].estimated_credits · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].settled_creditsanyOf<string | null>isteğe bağlı——
data[].tasks[].attempts[].settled_credits · variant 1stringisteğe bağlı——
data[].tasks[].attempts[].settled_credits · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].external_side_effect_started_atanyOf<string | null>isteğe bağlı——
data[].tasks[].attempts[].external_side_effect_started_at · variant 1stringisteğe bağlı—
format: date-time
data[].tasks[].attempts[].external_side_effect_started_at · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>isteğe bağlı——
data[].tasks[].attempts[].external_side_effect_committed_at · variant 1stringisteğe bağlı—
format: date-time
data[].tasks[].attempts[].external_side_effect_committed_at · variant 2nullisteğe bağlı——
data[].tasks[].attempts[].started_atstringgerekli—
format: date-time
data[].tasks[].attempts[].completed_atanyOf<string | null>isteğe bağlı——
data[].tasks[].attempts[].completed_at · variant 1stringisteğe bağlı—
format: date-time
data[].tasks[].attempts[].completed_at · variant 2nullisteğe bağlı——
paginationobjectgerekli——
pagination.nextanyOf<string | null>isteğe bağlı——
pagination.next · variant 1stringisteğe bağlı——
pagination.next · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
Idempotency-KeyheaderanyOf<string | null>isteğe bağlı—

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
tasksobjectgerekli——
taganyOf<string | null>isteğe bağlı——
tag · variant 1stringisteğe bağlı—
max length: 255
tag · variant 2nullisteğe bağlı——
client_reference_idanyOf<string | null>isteğe bağlı——
client_reference_id · variant 1stringisteğe bağlı—
max length: 255
client_reference_id · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
prioritystringisteğe bağlı—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>isteğe bağlı——
retention_seconds · variant 1integeristeğe bağlı—
min: 0max: 86400
retention_seconds · variant 2nullisteğe bağlı——

Yanıtlar

201Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
kindstringgerekli——
statusstringgerekli——
progressintegergerekli——
taganyOf<string | null>isteğe bağlı——
tag · variant 1stringisteğe bağlı——
tag · variant 2nullisteğe bağlı——
client_reference_idanyOf<string | null>isteğe bağlı——
client_reference_id · variant 1stringisteğe bağlı——
client_reference_id · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
prioritystringgerekli——
concurrency_limitintegeristeğe bağlı—
default: 1
originstringgerekli——
created_atstringgerekli—
format: date-time
started_atanyOf<string | null>isteğe bağlı——
started_at · variant 1stringisteğe bağlı—
format: date-time
started_at · variant 2nullisteğe bağlı——
completed_atanyOf<string | null>isteğe bağlı——
completed_at · variant 1stringisteğe bağlı—
format: date-time
completed_at · variant 2nullisteğe bağlı——
error_codeanyOf<string | null>isteğe bağlı——
error_code · variant 1stringisteğe bağlı——
error_code · variant 2nullisteğe bağlı——
error_messageanyOf<string | null>isteğe bağlı——
error_message · variant 1stringisteğe bağlı——
error_message · variant 2nullisteğe bağlı——
tasksobject[]isteğe bağlı——
tasks[]objectisteğe bağlı——
tasks[].idstringgerekli——
tasks[].job_idstringgerekli——
tasks[].namestringgerekli——
tasks[].operationstringgerekli——
tasks[].statusstringgerekli——
tasks[].progressintegergerekli——
tasks[].inputobjectgerekli——
tasks[].optionsobjectgerekli——
tasks[].resultobjectgerekli——
tasks[].requiredbooleangerekli——
tasks[].runtime_classstringgerekli——
tasks[].prioritystringgerekli——
tasks[].attempt_countintegergerekli——
tasks[].max_attemptsintegergerekli——
tasks[].error_codeanyOf<string | null>isteğe bağlı——
tasks[].error_code · variant 1stringisteğe bağlı——
tasks[].error_code · variant 2nullisteğe bağlı——
tasks[].error_messageanyOf<string | null>isteğe bağlı——
tasks[].error_message · variant 1stringisteğe bağlı——
tasks[].error_message · variant 2nullisteğe bağlı——
tasks[].created_atstringgerekli—
format: date-time
tasks[].queued_atanyOf<string | null>isteğe bağlı——
tasks[].queued_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].queued_at · variant 2nullisteğe bağlı——
tasks[].started_atanyOf<string | null>isteğe bağlı——
tasks[].started_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].started_at · variant 2nullisteğe bağlı——
tasks[].completed_atanyOf<string | null>isteğe bağlı——
tasks[].completed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].completed_at · variant 2nullisteğe bağlı——
tasks[].attemptsobject[]isteğe bağlı——
tasks[].attempts[]objectisteğe bağlı——
tasks[].attempts[].idstringgerekli——
tasks[].attempts[].attempt_numberintegergerekli——
tasks[].attempts[].statusstringgerekli——
tasks[].attempts[].worker_idanyOf<string | null>isteğe bağlı——
tasks[].attempts[].worker_id · variant 1stringisteğe bağlı——
tasks[].attempts[].worker_id · variant 2nullisteğe bağlı——
tasks[].attempts[].runtime_classanyOf<string | null>isteğe bağlı——
tasks[].attempts[].runtime_class · variant 1stringisteğe bağlı——
tasks[].attempts[].runtime_class · variant 2nullisteğe bağlı——
tasks[].attempts[].regionanyOf<string | null>isteğe bağlı——
tasks[].attempts[].region · variant 1stringisteğe bağlı——
tasks[].attempts[].region · variant 2nullisteğe bağlı——
tasks[].attempts[].engineanyOf<string | null>isteğe bağlı——
tasks[].attempts[].engine · variant 1stringisteğe bağlı——
tasks[].attempts[].engine · variant 2nullisteğe bağlı——
tasks[].attempts[].engine_versionanyOf<string | null>isteğe bağlı——
tasks[].attempts[].engine_version · variant 1stringisteğe bağlı——
tasks[].attempts[].engine_version · variant 2nullisteğe bağlı——
tasks[].attempts[].input_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].input_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].input_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].output_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].output_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].output_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].wall_msanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].wall_ms · variant 1integeristeğe bağlı——
tasks[].attempts[].wall_ms · variant 2nullisteğe bağlı——
tasks[].attempts[].cpu_msanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].cpu_ms · variant 1integeristeğe bağlı——
tasks[].attempts[].cpu_ms · variant 2nullisteğe bağlı——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].peak_memory_mb · variant 1integeristeğe bağlı——
tasks[].attempts[].peak_memory_mb · variant 2nullisteğe bağlı——
tasks[].attempts[].temp_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].temp_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].temp_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].error_codeanyOf<string | null>isteğe bağlı——
tasks[].attempts[].error_code · variant 1stringisteğe bağlı——
tasks[].attempts[].error_code · variant 2nullisteğe bağlı——
tasks[].attempts[].error_messageanyOf<string | null>isteğe bağlı——
tasks[].attempts[].error_message · variant 1stringisteğe bağlı——
tasks[].attempts[].error_message · variant 2nullisteğe bağlı——
tasks[].attempts[].estimated_creditsanyOf<string | null>isteğe bağlı——
tasks[].attempts[].estimated_credits · variant 1stringisteğe bağlı——
tasks[].attempts[].estimated_credits · variant 2nullisteğe bağlı——
tasks[].attempts[].settled_creditsanyOf<string | null>isteğe bağlı——
tasks[].attempts[].settled_credits · variant 1stringisteğe bağlı——
tasks[].attempts[].settled_credits · variant 2nullisteğe bağlı——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].external_side_effect_started_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullisteğe bağlı——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullisteğe bağlı——
tasks[].attempts[].started_atstringgerekli—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].completed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].completed_at · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
job_idpathstringgerekli—
include_attemptsquerybooleanisteğe bağlı
default: false

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
kindstringgerekli——
statusstringgerekli——
progressintegergerekli——
taganyOf<string | null>isteğe bağlı——
tag · variant 1stringisteğe bağlı——
tag · variant 2nullisteğe bağlı——
client_reference_idanyOf<string | null>isteğe bağlı——
client_reference_id · variant 1stringisteğe bağlı——
client_reference_id · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
prioritystringgerekli——
concurrency_limitintegeristeğe bağlı—
default: 1
originstringgerekli——
created_atstringgerekli—
format: date-time
started_atanyOf<string | null>isteğe bağlı——
started_at · variant 1stringisteğe bağlı—
format: date-time
started_at · variant 2nullisteğe bağlı——
completed_atanyOf<string | null>isteğe bağlı——
completed_at · variant 1stringisteğe bağlı—
format: date-time
completed_at · variant 2nullisteğe bağlı——
error_codeanyOf<string | null>isteğe bağlı——
error_code · variant 1stringisteğe bağlı——
error_code · variant 2nullisteğe bağlı——
error_messageanyOf<string | null>isteğe bağlı——
error_message · variant 1stringisteğe bağlı——
error_message · variant 2nullisteğe bağlı——
tasksobject[]isteğe bağlı——
tasks[]objectisteğe bağlı——
tasks[].idstringgerekli——
tasks[].job_idstringgerekli——
tasks[].namestringgerekli——
tasks[].operationstringgerekli——
tasks[].statusstringgerekli——
tasks[].progressintegergerekli——
tasks[].inputobjectgerekli——
tasks[].optionsobjectgerekli——
tasks[].resultobjectgerekli——
tasks[].requiredbooleangerekli——
tasks[].runtime_classstringgerekli——
tasks[].prioritystringgerekli——
tasks[].attempt_countintegergerekli——
tasks[].max_attemptsintegergerekli——
tasks[].error_codeanyOf<string | null>isteğe bağlı——
tasks[].error_code · variant 1stringisteğe bağlı——
tasks[].error_code · variant 2nullisteğe bağlı——
tasks[].error_messageanyOf<string | null>isteğe bağlı——
tasks[].error_message · variant 1stringisteğe bağlı——
tasks[].error_message · variant 2nullisteğe bağlı——
tasks[].created_atstringgerekli—
format: date-time
tasks[].queued_atanyOf<string | null>isteğe bağlı——
tasks[].queued_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].queued_at · variant 2nullisteğe bağlı——
tasks[].started_atanyOf<string | null>isteğe bağlı——
tasks[].started_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].started_at · variant 2nullisteğe bağlı——
tasks[].completed_atanyOf<string | null>isteğe bağlı——
tasks[].completed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].completed_at · variant 2nullisteğe bağlı——
tasks[].attemptsobject[]isteğe bağlı——
tasks[].attempts[]objectisteğe bağlı——
tasks[].attempts[].idstringgerekli——
tasks[].attempts[].attempt_numberintegergerekli——
tasks[].attempts[].statusstringgerekli——
tasks[].attempts[].worker_idanyOf<string | null>isteğe bağlı——
tasks[].attempts[].worker_id · variant 1stringisteğe bağlı——
tasks[].attempts[].worker_id · variant 2nullisteğe bağlı——
tasks[].attempts[].runtime_classanyOf<string | null>isteğe bağlı——
tasks[].attempts[].runtime_class · variant 1stringisteğe bağlı——
tasks[].attempts[].runtime_class · variant 2nullisteğe bağlı——
tasks[].attempts[].regionanyOf<string | null>isteğe bağlı——
tasks[].attempts[].region · variant 1stringisteğe bağlı——
tasks[].attempts[].region · variant 2nullisteğe bağlı——
tasks[].attempts[].engineanyOf<string | null>isteğe bağlı——
tasks[].attempts[].engine · variant 1stringisteğe bağlı——
tasks[].attempts[].engine · variant 2nullisteğe bağlı——
tasks[].attempts[].engine_versionanyOf<string | null>isteğe bağlı——
tasks[].attempts[].engine_version · variant 1stringisteğe bağlı——
tasks[].attempts[].engine_version · variant 2nullisteğe bağlı——
tasks[].attempts[].input_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].input_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].input_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].output_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].output_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].output_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].wall_msanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].wall_ms · variant 1integeristeğe bağlı——
tasks[].attempts[].wall_ms · variant 2nullisteğe bağlı——
tasks[].attempts[].cpu_msanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].cpu_ms · variant 1integeristeğe bağlı——
tasks[].attempts[].cpu_ms · variant 2nullisteğe bağlı——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].peak_memory_mb · variant 1integeristeğe bağlı——
tasks[].attempts[].peak_memory_mb · variant 2nullisteğe bağlı——
tasks[].attempts[].temp_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].temp_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].temp_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].error_codeanyOf<string | null>isteğe bağlı——
tasks[].attempts[].error_code · variant 1stringisteğe bağlı——
tasks[].attempts[].error_code · variant 2nullisteğe bağlı——
tasks[].attempts[].error_messageanyOf<string | null>isteğe bağlı——
tasks[].attempts[].error_message · variant 1stringisteğe bağlı——
tasks[].attempts[].error_message · variant 2nullisteğe bağlı——
tasks[].attempts[].estimated_creditsanyOf<string | null>isteğe bağlı——
tasks[].attempts[].estimated_credits · variant 1stringisteğe bağlı——
tasks[].attempts[].estimated_credits · variant 2nullisteğe bağlı——
tasks[].attempts[].settled_creditsanyOf<string | null>isteğe bağlı——
tasks[].attempts[].settled_credits · variant 1stringisteğe bağlı——
tasks[].attempts[].settled_credits · variant 2nullisteğe bağlı——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].external_side_effect_started_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullisteğe bağlı——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullisteğe bağlı——
tasks[].attempts[].started_atstringgerekli—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].completed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].completed_at · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
job_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
kindstringgerekli——
statusstringgerekli——
progressintegergerekli——
taganyOf<string | null>isteğe bağlı——
tag · variant 1stringisteğe bağlı——
tag · variant 2nullisteğe bağlı——
client_reference_idanyOf<string | null>isteğe bağlı——
client_reference_id · variant 1stringisteğe bağlı——
client_reference_id · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
prioritystringgerekli——
concurrency_limitintegeristeğe bağlı—
default: 1
originstringgerekli——
created_atstringgerekli—
format: date-time
started_atanyOf<string | null>isteğe bağlı——
started_at · variant 1stringisteğe bağlı—
format: date-time
started_at · variant 2nullisteğe bağlı——
completed_atanyOf<string | null>isteğe bağlı——
completed_at · variant 1stringisteğe bağlı—
format: date-time
completed_at · variant 2nullisteğe bağlı——
error_codeanyOf<string | null>isteğe bağlı——
error_code · variant 1stringisteğe bağlı——
error_code · variant 2nullisteğe bağlı——
error_messageanyOf<string | null>isteğe bağlı——
error_message · variant 1stringisteğe bağlı——
error_message · variant 2nullisteğe bağlı——
tasksobject[]isteğe bağlı——
tasks[]objectisteğe bağlı——
tasks[].idstringgerekli——
tasks[].job_idstringgerekli——
tasks[].namestringgerekli——
tasks[].operationstringgerekli——
tasks[].statusstringgerekli——
tasks[].progressintegergerekli——
tasks[].inputobjectgerekli——
tasks[].optionsobjectgerekli——
tasks[].resultobjectgerekli——
tasks[].requiredbooleangerekli——
tasks[].runtime_classstringgerekli——
tasks[].prioritystringgerekli——
tasks[].attempt_countintegergerekli——
tasks[].max_attemptsintegergerekli——
tasks[].error_codeanyOf<string | null>isteğe bağlı——
tasks[].error_code · variant 1stringisteğe bağlı——
tasks[].error_code · variant 2nullisteğe bağlı——
tasks[].error_messageanyOf<string | null>isteğe bağlı——
tasks[].error_message · variant 1stringisteğe bağlı——
tasks[].error_message · variant 2nullisteğe bağlı——
tasks[].created_atstringgerekli—
format: date-time
tasks[].queued_atanyOf<string | null>isteğe bağlı——
tasks[].queued_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].queued_at · variant 2nullisteğe bağlı——
tasks[].started_atanyOf<string | null>isteğe bağlı——
tasks[].started_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].started_at · variant 2nullisteğe bağlı——
tasks[].completed_atanyOf<string | null>isteğe bağlı——
tasks[].completed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].completed_at · variant 2nullisteğe bağlı——
tasks[].attemptsobject[]isteğe bağlı——
tasks[].attempts[]objectisteğe bağlı——
tasks[].attempts[].idstringgerekli——
tasks[].attempts[].attempt_numberintegergerekli——
tasks[].attempts[].statusstringgerekli——
tasks[].attempts[].worker_idanyOf<string | null>isteğe bağlı——
tasks[].attempts[].worker_id · variant 1stringisteğe bağlı——
tasks[].attempts[].worker_id · variant 2nullisteğe bağlı——
tasks[].attempts[].runtime_classanyOf<string | null>isteğe bağlı——
tasks[].attempts[].runtime_class · variant 1stringisteğe bağlı——
tasks[].attempts[].runtime_class · variant 2nullisteğe bağlı——
tasks[].attempts[].regionanyOf<string | null>isteğe bağlı——
tasks[].attempts[].region · variant 1stringisteğe bağlı——
tasks[].attempts[].region · variant 2nullisteğe bağlı——
tasks[].attempts[].engineanyOf<string | null>isteğe bağlı——
tasks[].attempts[].engine · variant 1stringisteğe bağlı——
tasks[].attempts[].engine · variant 2nullisteğe bağlı——
tasks[].attempts[].engine_versionanyOf<string | null>isteğe bağlı——
tasks[].attempts[].engine_version · variant 1stringisteğe bağlı——
tasks[].attempts[].engine_version · variant 2nullisteğe bağlı——
tasks[].attempts[].input_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].input_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].input_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].output_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].output_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].output_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].wall_msanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].wall_ms · variant 1integeristeğe bağlı——
tasks[].attempts[].wall_ms · variant 2nullisteğe bağlı——
tasks[].attempts[].cpu_msanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].cpu_ms · variant 1integeristeğe bağlı——
tasks[].attempts[].cpu_ms · variant 2nullisteğe bağlı——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].peak_memory_mb · variant 1integeristeğe bağlı——
tasks[].attempts[].peak_memory_mb · variant 2nullisteğe bağlı——
tasks[].attempts[].temp_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].temp_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].temp_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].error_codeanyOf<string | null>isteğe bağlı——
tasks[].attempts[].error_code · variant 1stringisteğe bağlı——
tasks[].attempts[].error_code · variant 2nullisteğe bağlı——
tasks[].attempts[].error_messageanyOf<string | null>isteğe bağlı——
tasks[].attempts[].error_message · variant 1stringisteğe bağlı——
tasks[].attempts[].error_message · variant 2nullisteğe bağlı——
tasks[].attempts[].estimated_creditsanyOf<string | null>isteğe bağlı——
tasks[].attempts[].estimated_credits · variant 1stringisteğe bağlı——
tasks[].attempts[].estimated_credits · variant 2nullisteğe bağlı——
tasks[].attempts[].settled_creditsanyOf<string | null>isteğe bağlı——
tasks[].attempts[].settled_credits · variant 1stringisteğe bağlı——
tasks[].attempts[].settled_credits · variant 2nullisteğe bağlı——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].external_side_effect_started_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullisteğe bağlı——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullisteğe bağlı——
tasks[].attempts[].started_atstringgerekli—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].completed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].completed_at · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
job_idpathstringgerekli—
timeoutqueryintegeristeğe bağlı
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>isteğe bağlı—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
bodyunknowngerekli——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
job_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
kindstringgerekli——
statusstringgerekli——
progressintegergerekli——
taganyOf<string | null>isteğe bağlı——
tag · variant 1stringisteğe bağlı——
tag · variant 2nullisteğe bağlı——
client_reference_idanyOf<string | null>isteğe bağlı——
client_reference_id · variant 1stringisteğe bağlı——
client_reference_id · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
prioritystringgerekli——
concurrency_limitintegeristeğe bağlı—
default: 1
originstringgerekli——
created_atstringgerekli—
format: date-time
started_atanyOf<string | null>isteğe bağlı——
started_at · variant 1stringisteğe bağlı—
format: date-time
started_at · variant 2nullisteğe bağlı——
completed_atanyOf<string | null>isteğe bağlı——
completed_at · variant 1stringisteğe bağlı—
format: date-time
completed_at · variant 2nullisteğe bağlı——
error_codeanyOf<string | null>isteğe bağlı——
error_code · variant 1stringisteğe bağlı——
error_code · variant 2nullisteğe bağlı——
error_messageanyOf<string | null>isteğe bağlı——
error_message · variant 1stringisteğe bağlı——
error_message · variant 2nullisteğe bağlı——
tasksobject[]isteğe bağlı——
tasks[]objectisteğe bağlı——
tasks[].idstringgerekli——
tasks[].job_idstringgerekli——
tasks[].namestringgerekli——
tasks[].operationstringgerekli——
tasks[].statusstringgerekli——
tasks[].progressintegergerekli——
tasks[].inputobjectgerekli——
tasks[].optionsobjectgerekli——
tasks[].resultobjectgerekli——
tasks[].requiredbooleangerekli——
tasks[].runtime_classstringgerekli——
tasks[].prioritystringgerekli——
tasks[].attempt_countintegergerekli——
tasks[].max_attemptsintegergerekli——
tasks[].error_codeanyOf<string | null>isteğe bağlı——
tasks[].error_code · variant 1stringisteğe bağlı——
tasks[].error_code · variant 2nullisteğe bağlı——
tasks[].error_messageanyOf<string | null>isteğe bağlı——
tasks[].error_message · variant 1stringisteğe bağlı——
tasks[].error_message · variant 2nullisteğe bağlı——
tasks[].created_atstringgerekli—
format: date-time
tasks[].queued_atanyOf<string | null>isteğe bağlı——
tasks[].queued_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].queued_at · variant 2nullisteğe bağlı——
tasks[].started_atanyOf<string | null>isteğe bağlı——
tasks[].started_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].started_at · variant 2nullisteğe bağlı——
tasks[].completed_atanyOf<string | null>isteğe bağlı——
tasks[].completed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].completed_at · variant 2nullisteğe bağlı——
tasks[].attemptsobject[]isteğe bağlı——
tasks[].attempts[]objectisteğe bağlı——
tasks[].attempts[].idstringgerekli——
tasks[].attempts[].attempt_numberintegergerekli——
tasks[].attempts[].statusstringgerekli——
tasks[].attempts[].worker_idanyOf<string | null>isteğe bağlı——
tasks[].attempts[].worker_id · variant 1stringisteğe bağlı——
tasks[].attempts[].worker_id · variant 2nullisteğe bağlı——
tasks[].attempts[].runtime_classanyOf<string | null>isteğe bağlı——
tasks[].attempts[].runtime_class · variant 1stringisteğe bağlı——
tasks[].attempts[].runtime_class · variant 2nullisteğe bağlı——
tasks[].attempts[].regionanyOf<string | null>isteğe bağlı——
tasks[].attempts[].region · variant 1stringisteğe bağlı——
tasks[].attempts[].region · variant 2nullisteğe bağlı——
tasks[].attempts[].engineanyOf<string | null>isteğe bağlı——
tasks[].attempts[].engine · variant 1stringisteğe bağlı——
tasks[].attempts[].engine · variant 2nullisteğe bağlı——
tasks[].attempts[].engine_versionanyOf<string | null>isteğe bağlı——
tasks[].attempts[].engine_version · variant 1stringisteğe bağlı——
tasks[].attempts[].engine_version · variant 2nullisteğe bağlı——
tasks[].attempts[].input_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].input_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].input_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].output_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].output_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].output_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].wall_msanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].wall_ms · variant 1integeristeğe bağlı——
tasks[].attempts[].wall_ms · variant 2nullisteğe bağlı——
tasks[].attempts[].cpu_msanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].cpu_ms · variant 1integeristeğe bağlı——
tasks[].attempts[].cpu_ms · variant 2nullisteğe bağlı——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].peak_memory_mb · variant 1integeristeğe bağlı——
tasks[].attempts[].peak_memory_mb · variant 2nullisteğe bağlı——
tasks[].attempts[].temp_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].temp_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].temp_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].error_codeanyOf<string | null>isteğe bağlı——
tasks[].attempts[].error_code · variant 1stringisteğe bağlı——
tasks[].attempts[].error_code · variant 2nullisteğe bağlı——
tasks[].attempts[].error_messageanyOf<string | null>isteğe bağlı——
tasks[].attempts[].error_message · variant 1stringisteğe bağlı——
tasks[].attempts[].error_message · variant 2nullisteğe bağlı——
tasks[].attempts[].estimated_creditsanyOf<string | null>isteğe bağlı——
tasks[].attempts[].estimated_credits · variant 1stringisteğe bağlı——
tasks[].attempts[].estimated_credits · variant 2nullisteğe bağlı——
tasks[].attempts[].settled_creditsanyOf<string | null>isteğe bağlı——
tasks[].attempts[].settled_credits · variant 1stringisteğe bağlı——
tasks[].attempts[].settled_credits · variant 2nullisteğe bağlı——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].external_side_effect_started_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullisteğe bağlı——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullisteğe bağlı——
tasks[].attempts[].started_atstringgerekli—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].completed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].completed_at · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
job_idpathstringgerekli—
timeoutqueryintegeristeğe bağlı
default: 20min: 0max: 30

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
kindstringgerekli——
statusstringgerekli——
progressintegergerekli——
taganyOf<string | null>isteğe bağlı——
tag · variant 1stringisteğe bağlı——
tag · variant 2nullisteğe bağlı——
client_reference_idanyOf<string | null>isteğe bağlı——
client_reference_id · variant 1stringisteğe bağlı——
client_reference_id · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
prioritystringgerekli——
concurrency_limitintegeristeğe bağlı—
default: 1
originstringgerekli——
created_atstringgerekli—
format: date-time
started_atanyOf<string | null>isteğe bağlı——
started_at · variant 1stringisteğe bağlı—
format: date-time
started_at · variant 2nullisteğe bağlı——
completed_atanyOf<string | null>isteğe bağlı——
completed_at · variant 1stringisteğe bağlı—
format: date-time
completed_at · variant 2nullisteğe bağlı——
error_codeanyOf<string | null>isteğe bağlı——
error_code · variant 1stringisteğe bağlı——
error_code · variant 2nullisteğe bağlı——
error_messageanyOf<string | null>isteğe bağlı——
error_message · variant 1stringisteğe bağlı——
error_message · variant 2nullisteğe bağlı——
tasksobject[]isteğe bağlı——
tasks[]objectisteğe bağlı——
tasks[].idstringgerekli——
tasks[].job_idstringgerekli——
tasks[].namestringgerekli——
tasks[].operationstringgerekli——
tasks[].statusstringgerekli——
tasks[].progressintegergerekli——
tasks[].inputobjectgerekli——
tasks[].optionsobjectgerekli——
tasks[].resultobjectgerekli——
tasks[].requiredbooleangerekli——
tasks[].runtime_classstringgerekli——
tasks[].prioritystringgerekli——
tasks[].attempt_countintegergerekli——
tasks[].max_attemptsintegergerekli——
tasks[].error_codeanyOf<string | null>isteğe bağlı——
tasks[].error_code · variant 1stringisteğe bağlı——
tasks[].error_code · variant 2nullisteğe bağlı——
tasks[].error_messageanyOf<string | null>isteğe bağlı——
tasks[].error_message · variant 1stringisteğe bağlı——
tasks[].error_message · variant 2nullisteğe bağlı——
tasks[].created_atstringgerekli—
format: date-time
tasks[].queued_atanyOf<string | null>isteğe bağlı——
tasks[].queued_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].queued_at · variant 2nullisteğe bağlı——
tasks[].started_atanyOf<string | null>isteğe bağlı——
tasks[].started_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].started_at · variant 2nullisteğe bağlı——
tasks[].completed_atanyOf<string | null>isteğe bağlı——
tasks[].completed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].completed_at · variant 2nullisteğe bağlı——
tasks[].attemptsobject[]isteğe bağlı——
tasks[].attempts[]objectisteğe bağlı——
tasks[].attempts[].idstringgerekli——
tasks[].attempts[].attempt_numberintegergerekli——
tasks[].attempts[].statusstringgerekli——
tasks[].attempts[].worker_idanyOf<string | null>isteğe bağlı——
tasks[].attempts[].worker_id · variant 1stringisteğe bağlı——
tasks[].attempts[].worker_id · variant 2nullisteğe bağlı——
tasks[].attempts[].runtime_classanyOf<string | null>isteğe bağlı——
tasks[].attempts[].runtime_class · variant 1stringisteğe bağlı——
tasks[].attempts[].runtime_class · variant 2nullisteğe bağlı——
tasks[].attempts[].regionanyOf<string | null>isteğe bağlı——
tasks[].attempts[].region · variant 1stringisteğe bağlı——
tasks[].attempts[].region · variant 2nullisteğe bağlı——
tasks[].attempts[].engineanyOf<string | null>isteğe bağlı——
tasks[].attempts[].engine · variant 1stringisteğe bağlı——
tasks[].attempts[].engine · variant 2nullisteğe bağlı——
tasks[].attempts[].engine_versionanyOf<string | null>isteğe bağlı——
tasks[].attempts[].engine_version · variant 1stringisteğe bağlı——
tasks[].attempts[].engine_version · variant 2nullisteğe bağlı——
tasks[].attempts[].input_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].input_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].input_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].output_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].output_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].output_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].wall_msanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].wall_ms · variant 1integeristeğe bağlı——
tasks[].attempts[].wall_ms · variant 2nullisteğe bağlı——
tasks[].attempts[].cpu_msanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].cpu_ms · variant 1integeristeğe bağlı——
tasks[].attempts[].cpu_ms · variant 2nullisteğe bağlı——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].peak_memory_mb · variant 1integeristeğe bağlı——
tasks[].attempts[].peak_memory_mb · variant 2nullisteğe bağlı——
tasks[].attempts[].temp_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].temp_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].temp_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].error_codeanyOf<string | null>isteğe bağlı——
tasks[].attempts[].error_code · variant 1stringisteğe bağlı——
tasks[].attempts[].error_code · variant 2nullisteğe bağlı——
tasks[].attempts[].error_messageanyOf<string | null>isteğe bağlı——
tasks[].attempts[].error_message · variant 1stringisteğe bağlı——
tasks[].attempts[].error_message · variant 2nullisteğe bağlı——
tasks[].attempts[].estimated_creditsanyOf<string | null>isteğe bağlı——
tasks[].attempts[].estimated_credits · variant 1stringisteğe bağlı——
tasks[].attempts[].estimated_credits · variant 2nullisteğe bağlı——
tasks[].attempts[].settled_creditsanyOf<string | null>isteğe bağlı——
tasks[].attempts[].settled_credits · variant 1stringisteğe bağlı——
tasks[].attempts[].settled_credits · variant 2nullisteğe bağlı——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].external_side_effect_started_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullisteğe bağlı——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullisteğe bağlı——
tasks[].attempts[].started_atstringgerekli—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].completed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].completed_at · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
tasksobjectgerekli——
taganyOf<string | null>isteğe bağlı——
tag · variant 1stringisteğe bağlı—
max length: 255
tag · variant 2nullisteğe bağlı——
client_reference_idanyOf<string | null>isteğe bağlı——
client_reference_id · variant 1stringisteğe bağlı—
max length: 255
client_reference_id · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
prioritystringisteğe bağlı—
enum: "low", "normal", "high"default: "normal"
retention_secondsanyOf<integer | null>isteğe bağlı——
retention_seconds · variant 1integeristeğe bağlı—
min: 0max: 86400
retention_seconds · variant 2nullisteğe bağlı——

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
validbooleangerekli——
task_countintegergerekli——
execution_orderstring[]gerekli——
root_tasksstring[]gerekli——
warningsstring[]isteğe bağlı——
estimated_creditsanyOf<object | null>isteğe bağlı——
estimated_credits · variant 1objectisteğe bağlı——
estimated_credits · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
limitqueryintegeristeğe bağlı
default: 50min: 1max: 200
afterqueryanyOf<string | null>isteğe bağlı—
status_codequeryanyOf<integer | null>isteğe bağlı—
path_prefixqueryanyOf<string | null>isteğe bağlı—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
dataobject[]gerekli——
data[]objectisteğe bağlı——
data[].request_idstringgerekli——
data[].methodstringgerekli——
data[].pathstringgerekli——
data[].status_codeintegergerekli——
data[].latency_msintegergerekli——
data[].api_key_idanyOf<string | null>isteğe bağlı——
data[].api_key_id · variant 1stringisteğe bağlı——
data[].api_key_id · variant 2nullisteğe bağlı——
data[].auth_typestringgerekli——
data[].user_agentanyOf<string | null>isteğe bağlı——
data[].user_agent · variant 1stringisteğe bağlı——
data[].user_agent · variant 2nullisteğe bağlı——
data[].created_atstringgerekli——
paginationobjectgerekli——
pagination.nextanyOf<string | null>isteğe bağlı——
pagination.next · variant 1stringisteğe bağlı——
pagination.next · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
request_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
request_idstringgerekli——
methodstringgerekli——
pathstringgerekli——
status_codeintegergerekli——
latency_msintegergerekli——
api_key_idanyOf<string | null>isteğe bağlı——
api_key_id · variant 1stringisteğe bağlı——
api_key_id · variant 2nullisteğe bağlı——
auth_typestringgerekli——
user_agentanyOf<string | null>isteğe bağlı——
user_agent · variant 1stringisteğe bağlı——
user_agent · variant 2nullisteğe bağlı——
created_atstringgerekli——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
account_idstringgerekli——
actor_idstringgerekli——
auth_typestringgerekli——
environmentstringgerekli——
access_tierstringisteğe bağlı—
enum: "sandbox", "paid"default: "paid"
scopesstring[]gerekli——
roleanyOf<string | null>isteğe bağlı——
role · variant 1stringisteğe bağlı——
role · variant 2nullisteğe bağlı——
authorized_partyanyOf<string | null>isteğe bağlı——
authorized_party · variant 1stringisteğe bağlı——
authorized_party · variant 2nullisteğe bağlı——
limitsanyOf<object | null>isteğe bağlı——
limits · variant 1objectisteğe bağlı——
limits · variant 1.monthly_callsanyOf<integer | null>isteğe bağlı——
limits · variant 1.monthly_calls · variant 1integeristeğe bağlı——
limits · variant 1.monthly_calls · variant 2nullisteğe bağlı——
limits · variant 1.rate_limit_per_minuteanyOf<integer | null>isteğe bağlı——
limits · variant 1.rate_limit_per_minute · variant 1integeristeğe bağlı——
limits · variant 1.rate_limit_per_minute · variant 2nullisteğe bağlı——
limits · variant 1.daily_requestsanyOf<integer | null>isteğe bağlı——
limits · variant 1.daily_requests · variant 1integeristeğe bağlı——
limits · variant 1.daily_requests · variant 2nullisteğe bağlı——
limits · variant 1.concurrencyanyOf<integer | null>isteğe bağlı——
limits · variant 1.concurrency · variant 1integeristeğe bağlı——
limits · variant 1.concurrency · variant 2nullisteğe bağlı——
limits · variant 1.max_file_mbanyOf<integer | null>isteğe bağlı——
limits · variant 1.max_file_mb · variant 1integeristeğe bağlı——
limits · variant 1.max_file_mb · variant 2nullisteğe bağlı——
limits · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
GET/v1/operationsOperationsDiscovery#

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

Kimlik doğrulamaGenel / işleme özgü kimlik doğrulama gerekmez

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
dataobject[]gerekli——
data[]objectisteğe bağlı——
data[].operationstringgerekli——
data[].categorystringgerekli—
enum: "import", "processing", "export"
data[].descriptionstringgerekli——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
account_idstringgerekli——
environmentstringgerekli——
scopedbooleangerekli——
project_idanyOf<string | null>isteğe bağlı——
project_id · variant 1stringisteğe bağlı——
project_id · variant 2nullisteğe bağlı——
project_nameanyOf<string | null>isteğe bağlı——
project_name · variant 1stringisteğe bağlı——
project_name · variant 2nullisteğe bağlı——
project_sluganyOf<string | null>isteğe bağlı——
project_slug · variant 1stringisteğe bağlı——
project_slug · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
GET/v1/project/legacy-migrationPreview Legacy MigrationAuthentication · Projects#

Preview account/environment resources still in the legacy namespace.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
bodyobjectgerekli——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
POST/v1/project/legacy-migrationMigrate Legacy Project ResourcesAuthentication · Projects#

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

Kimlik doğrulama
ConverterHQBearerhttp / bearer

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
confirm_project_idstringgerekli—
min length: 1max length: 64

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
bodyobjectgerekli——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
tokenstringgerekli——
expires_atstringgerekli—
format: date-time
websocket_urlstringgerekli——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
bodyobjectgerekli——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
fixture_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
bodyobjectgerekli——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
bodyobject[]gerekli——
items[]objectisteğe bağlı——
items[].idstringgerekli——
items[].namestringgerekli——
items[].workflow_idanyOf<string | null>isteğe bağlı——
items[].workflow_id · variant 1stringisteğe bağlı——
items[].workflow_id · variant 2nullisteğe bağlı——
items[].workflow_versionanyOf<integer | null>isteğe bağlı——
items[].workflow_version · variant 1integeristeğe bağlı——
items[].workflow_version · variant 2nullisteğe bağlı——
items[].inline_definitionanyOf<object | null>isteğe bağlı——
items[].inline_definition · variant 1objectisteğe bağlı——
items[].inline_definition · variant 2nullisteğe bağlı——
items[].variables_schemaobjectgerekli——
items[].allowed_source_hostsstring[]gerekli——
items[].max_file_size_bytesanyOf<integer | null>isteğe bağlı——
items[].max_file_size_bytes · variant 1integeristeğe bağlı——
items[].max_file_size_bytes · variant 2nullisteğe bağlı——
items[].max_credits_per_requestanyOf<string | null>isteğe bağlı——
items[].max_credits_per_request · variant 1stringisteğe bağlı——
items[].max_credits_per_request · variant 2nullisteğe bağlı——
items[].max_usesanyOf<integer | null>isteğe bağlı——
items[].max_uses · variant 1integeristeğe bağlı——
items[].max_uses · variant 2nullisteğe bağlı——
items[].use_countintegergerekli——
items[].cache_ttl_secondsintegergerekli——
items[].enabledbooleangerekli——
items[].created_atstringgerekli—
format: date-time
items[].updated_atstringgerekli—
format: date-time
items[].signing_secretanyOf<string | null>isteğe bağlı——
items[].signing_secret · variant 1stringisteğe bağlı——
items[].signing_secret · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
namestringgerekli—
min length: 1max length: 255
workflow_idanyOf<string | null>isteğe bağlı——
workflow_id · variant 1stringisteğe bağlı——
workflow_id · variant 2nullisteğe bağlı——
inline_definitionanyOf<object | null>isteğe bağlı——
inline_definition · variant 1objectisteğe bağlı——
inline_definition · variant 1.tasksobjectgerekli——
inline_definition · variant 1.taganyOf<string | null>isteğe bağlı——
inline_definition · variant 1.tag · variant 1stringisteğe bağlı—
max length: 255
inline_definition · variant 1.tag · variant 2nullisteğe bağlı——
inline_definition · variant 1.client_reference_idanyOf<string | null>isteğe bağlı——
inline_definition · variant 1.client_reference_id · variant 1stringisteğe bağlı—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nullisteğe bağlı——
inline_definition · variant 1.metadataobjectisteğe bağlı——
inline_definition · variant 1.prioritystringisteğe bağlı—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>isteğe bağlı——
inline_definition · variant 1.retention_seconds · variant 1integeristeğe bağlı—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nullisteğe bağlı——
inline_definition · variant 2nullisteğe bağlı——
variables_schemaobjectisteğe bağlı——
allowed_source_hostsstring[]isteğe bağlı——
max_file_size_bytesanyOf<integer | null>isteğe bağlı——
max_file_size_bytes · variant 1integeristeğe bağlı——
max_file_size_bytes · variant 2nullisteğe bağlı——
max_credits_per_requestanyOf<string | null>isteğe bağlı——
max_credits_per_request · variant 1stringisteğe bağlı—
max length: 64
max_credits_per_request · variant 2nullisteğe bağlı——
max_usesanyOf<integer | null>isteğe bağlı——
max_uses · variant 1integeristeğe bağlı——
max_uses · variant 2nullisteğe bağlı——
cache_ttl_secondsintegeristeğe bağlı—
default: 0min: 0max: 86400

Yanıtlar

201Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
namestringgerekli——
workflow_idanyOf<string | null>isteğe bağlı——
workflow_id · variant 1stringisteğe bağlı——
workflow_id · variant 2nullisteğe bağlı——
workflow_versionanyOf<integer | null>isteğe bağlı——
workflow_version · variant 1integeristeğe bağlı——
workflow_version · variant 2nullisteğe bağlı——
inline_definitionanyOf<object | null>isteğe bağlı——
inline_definition · variant 1objectisteğe bağlı——
inline_definition · variant 2nullisteğe bağlı——
variables_schemaobjectgerekli——
allowed_source_hostsstring[]gerekli——
max_file_size_bytesanyOf<integer | null>isteğe bağlı——
max_file_size_bytes · variant 1integeristeğe bağlı——
max_file_size_bytes · variant 2nullisteğe bağlı——
max_credits_per_requestanyOf<string | null>isteğe bağlı——
max_credits_per_request · variant 1stringisteğe bağlı——
max_credits_per_request · variant 2nullisteğe bağlı——
max_usesanyOf<integer | null>isteğe bağlı——
max_uses · variant 1integeristeğe bağlı——
max_uses · variant 2nullisteğe bağlı——
use_countintegergerekli——
cache_ttl_secondsintegergerekli——
enabledbooleangerekli——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
signing_secretanyOf<string | null>isteğe bağlı——
signing_secret · variant 1stringisteğe bağlı——
signing_secret · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
base_idpathstringgerekli—

Yanıtlar

204Successful Response

Yanıt gövdesi yok.

400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
base_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
namestringgerekli——
workflow_idanyOf<string | null>isteğe bağlı——
workflow_id · variant 1stringisteğe bağlı——
workflow_id · variant 2nullisteğe bağlı——
workflow_versionanyOf<integer | null>isteğe bağlı——
workflow_version · variant 1integeristeğe bağlı——
workflow_version · variant 2nullisteğe bağlı——
inline_definitionanyOf<object | null>isteğe bağlı——
inline_definition · variant 1objectisteğe bağlı——
inline_definition · variant 2nullisteğe bağlı——
variables_schemaobjectgerekli——
allowed_source_hostsstring[]gerekli——
max_file_size_bytesanyOf<integer | null>isteğe bağlı——
max_file_size_bytes · variant 1integeristeğe bağlı——
max_file_size_bytes · variant 2nullisteğe bağlı——
max_credits_per_requestanyOf<string | null>isteğe bağlı——
max_credits_per_request · variant 1stringisteğe bağlı——
max_credits_per_request · variant 2nullisteğe bağlı——
max_usesanyOf<integer | null>isteğe bağlı——
max_uses · variant 1integeristeğe bağlı——
max_uses · variant 2nullisteğe bağlı——
use_countintegergerekli——
cache_ttl_secondsintegergerekli——
enabledbooleangerekli——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
signing_secretanyOf<string | null>isteğe bağlı——
signing_secret · variant 1stringisteğe bağlı——
signing_secret · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
base_idpathstringgerekli—

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
nameanyOf<string | null>isteğe bağlı——
name · variant 1stringisteğe bağlı—
min length: 1max length: 255
name · variant 2nullisteğe bağlı——
workflow_idanyOf<string | null>isteğe bağlı——
workflow_id · variant 1stringisteğe bağlı——
workflow_id · variant 2nullisteğe bağlı——
inline_definitionanyOf<object | null>isteğe bağlı——
inline_definition · variant 1objectisteğe bağlı——
inline_definition · variant 1.tasksobjectgerekli——
inline_definition · variant 1.taganyOf<string | null>isteğe bağlı——
inline_definition · variant 1.tag · variant 1stringisteğe bağlı—
max length: 255
inline_definition · variant 1.tag · variant 2nullisteğe bağlı——
inline_definition · variant 1.client_reference_idanyOf<string | null>isteğe bağlı——
inline_definition · variant 1.client_reference_id · variant 1stringisteğe bağlı—
max length: 255
inline_definition · variant 1.client_reference_id · variant 2nullisteğe bağlı——
inline_definition · variant 1.metadataobjectisteğe bağlı——
inline_definition · variant 1.prioritystringisteğe bağlı—
enum: "low", "normal", "high"default: "normal"
inline_definition · variant 1.retention_secondsanyOf<integer | null>isteğe bağlı——
inline_definition · variant 1.retention_seconds · variant 1integeristeğe bağlı—
min: 0max: 86400
inline_definition · variant 1.retention_seconds · variant 2nullisteğe bağlı——
inline_definition · variant 2nullisteğe bağlı——
variables_schemaanyOf<object | null>isteğe bağlı——
variables_schema · variant 1objectisteğe bağlı——
variables_schema · variant 2nullisteğe bağlı——
allowed_source_hostsanyOf<string[] | null>isteğe bağlı——
allowed_source_hosts · variant 1string[]isteğe bağlı——
allowed_source_hosts · variant 2nullisteğe bağlı——
max_file_size_bytesanyOf<integer | null>isteğe bağlı——
max_file_size_bytes · variant 1integeristeğe bağlı——
max_file_size_bytes · variant 2nullisteğe bağlı——
max_credits_per_requestanyOf<string | null>isteğe bağlı——
max_credits_per_request · variant 1stringisteğe bağlı—
max length: 64
max_credits_per_request · variant 2nullisteğe bağlı——
max_usesanyOf<integer | null>isteğe bağlı——
max_uses · variant 1integeristeğe bağlı——
max_uses · variant 2nullisteğe bağlı——
cache_ttl_secondsanyOf<integer | null>isteğe bağlı——
cache_ttl_seconds · variant 1integeristeğe bağlı—
min: 0max: 86400
cache_ttl_seconds · variant 2nullisteğe bağlı——
enabledanyOf<boolean | null>isteğe bağlı——
enabled · variant 1booleanisteğe bağlı——
enabled · variant 2nullisteğe bağlı——

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
namestringgerekli——
workflow_idanyOf<string | null>isteğe bağlı——
workflow_id · variant 1stringisteğe bağlı——
workflow_id · variant 2nullisteğe bağlı——
workflow_versionanyOf<integer | null>isteğe bağlı——
workflow_version · variant 1integeristeğe bağlı——
workflow_version · variant 2nullisteğe bağlı——
inline_definitionanyOf<object | null>isteğe bağlı——
inline_definition · variant 1objectisteğe bağlı——
inline_definition · variant 2nullisteğe bağlı——
variables_schemaobjectgerekli——
allowed_source_hostsstring[]gerekli——
max_file_size_bytesanyOf<integer | null>isteğe bağlı——
max_file_size_bytes · variant 1integeristeğe bağlı——
max_file_size_bytes · variant 2nullisteğe bağlı——
max_credits_per_requestanyOf<string | null>isteğe bağlı——
max_credits_per_request · variant 1stringisteğe bağlı——
max_credits_per_request · variant 2nullisteğe bağlı——
max_usesanyOf<integer | null>isteğe bağlı——
max_uses · variant 1integeristeğe bağlı——
max_uses · variant 2nullisteğe bağlı——
use_countintegergerekli——
cache_ttl_secondsintegergerekli——
enabledbooleangerekli——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
signing_secretanyOf<string | null>isteğe bağlı——
signing_secret · variant 1stringisteğe bağlı——
signing_secret · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
base_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
namestringgerekli——
workflow_idanyOf<string | null>isteğe bağlı——
workflow_id · variant 1stringisteğe bağlı——
workflow_id · variant 2nullisteğe bağlı——
workflow_versionanyOf<integer | null>isteğe bağlı——
workflow_version · variant 1integeristeğe bağlı——
workflow_version · variant 2nullisteğe bağlı——
inline_definitionanyOf<object | null>isteğe bağlı——
inline_definition · variant 1objectisteğe bağlı——
inline_definition · variant 2nullisteğe bağlı——
variables_schemaobjectgerekli——
allowed_source_hostsstring[]gerekli——
max_file_size_bytesanyOf<integer | null>isteğe bağlı——
max_file_size_bytes · variant 1integeristeğe bağlı——
max_file_size_bytes · variant 2nullisteğe bağlı——
max_credits_per_requestanyOf<string | null>isteğe bağlı——
max_credits_per_request · variant 1stringisteğe bağlı——
max_credits_per_request · variant 2nullisteğe bağlı——
max_usesanyOf<integer | null>isteğe bağlı——
max_uses · variant 1integeristeğe bağlı——
max_uses · variant 2nullisteğe bağlı——
use_countintegergerekli——
cache_ttl_secondsintegergerekli——
enabledbooleangerekli——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
signing_secretanyOf<string | null>isteğe bağlı——
signing_secret · variant 1stringisteğe bağlı——
signing_secret · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
base_idpathstringgerekli—

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
variablesobjectisteğe bağlı——
expires_inintegeristeğe bağlı—
default: 3600min: 60max: 86400
cache_keyanyOf<string | null>isteğe bağlı——
cache_key · variant 1stringisteğe bağlı—
max length: 255
cache_key · variant 2nullisteğe bağlı——

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
urlstringgerekli——
expires_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulamaGenel / işleme özgü kimlik doğrulama gerekmez

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
statusstringgerekli—
enum: "ok", "degraded"
servicestringisteğe bağlı—
default: "converterhq-api"
api_versionstringisteğe bağlı—
default: "v1"
timestampstringgerekli—
format: date-time
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulamaGenel / işleme özgü kimlik doğrulama gerekmez

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
successful_conversionsintegergerekli——
input_bytes_processedintegergerekli——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
task_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
job_idstringgerekli——
namestringgerekli——
operationstringgerekli——
statusstringgerekli——
progressintegergerekli——
inputobjectgerekli——
optionsobjectgerekli——
resultobjectgerekli——
requiredbooleangerekli——
runtime_classstringgerekli——
prioritystringgerekli——
attempt_countintegergerekli——
max_attemptsintegergerekli——
error_codeanyOf<string | null>isteğe bağlı——
error_code · variant 1stringisteğe bağlı——
error_code · variant 2nullisteğe bağlı——
error_messageanyOf<string | null>isteğe bağlı——
error_message · variant 1stringisteğe bağlı——
error_message · variant 2nullisteğe bağlı——
created_atstringgerekli—
format: date-time
queued_atanyOf<string | null>isteğe bağlı——
queued_at · variant 1stringisteğe bağlı—
format: date-time
queued_at · variant 2nullisteğe bağlı——
started_atanyOf<string | null>isteğe bağlı——
started_at · variant 1stringisteğe bağlı—
format: date-time
started_at · variant 2nullisteğe bağlı——
completed_atanyOf<string | null>isteğe bağlı——
completed_at · variant 1stringisteğe bağlı—
format: date-time
completed_at · variant 2nullisteğe bağlı——
attemptsobject[]isteğe bağlı——
attempts[]objectisteğe bağlı——
attempts[].idstringgerekli——
attempts[].attempt_numberintegergerekli——
attempts[].statusstringgerekli——
attempts[].worker_idanyOf<string | null>isteğe bağlı——
attempts[].worker_id · variant 1stringisteğe bağlı——
attempts[].worker_id · variant 2nullisteğe bağlı——
attempts[].runtime_classanyOf<string | null>isteğe bağlı——
attempts[].runtime_class · variant 1stringisteğe bağlı——
attempts[].runtime_class · variant 2nullisteğe bağlı——
attempts[].regionanyOf<string | null>isteğe bağlı——
attempts[].region · variant 1stringisteğe bağlı——
attempts[].region · variant 2nullisteğe bağlı——
attempts[].engineanyOf<string | null>isteğe bağlı——
attempts[].engine · variant 1stringisteğe bağlı——
attempts[].engine · variant 2nullisteğe bağlı——
attempts[].engine_versionanyOf<string | null>isteğe bağlı——
attempts[].engine_version · variant 1stringisteğe bağlı——
attempts[].engine_version · variant 2nullisteğe bağlı——
attempts[].input_bytesanyOf<integer | null>isteğe bağlı——
attempts[].input_bytes · variant 1integeristeğe bağlı——
attempts[].input_bytes · variant 2nullisteğe bağlı——
attempts[].output_bytesanyOf<integer | null>isteğe bağlı——
attempts[].output_bytes · variant 1integeristeğe bağlı——
attempts[].output_bytes · variant 2nullisteğe bağlı——
attempts[].wall_msanyOf<integer | null>isteğe bağlı——
attempts[].wall_ms · variant 1integeristeğe bağlı——
attempts[].wall_ms · variant 2nullisteğe bağlı——
attempts[].cpu_msanyOf<integer | null>isteğe bağlı——
attempts[].cpu_ms · variant 1integeristeğe bağlı——
attempts[].cpu_ms · variant 2nullisteğe bağlı——
attempts[].peak_memory_mbanyOf<integer | null>isteğe bağlı——
attempts[].peak_memory_mb · variant 1integeristeğe bağlı——
attempts[].peak_memory_mb · variant 2nullisteğe bağlı——
attempts[].temp_bytesanyOf<integer | null>isteğe bağlı——
attempts[].temp_bytes · variant 1integeristeğe bağlı——
attempts[].temp_bytes · variant 2nullisteğe bağlı——
attempts[].error_codeanyOf<string | null>isteğe bağlı——
attempts[].error_code · variant 1stringisteğe bağlı——
attempts[].error_code · variant 2nullisteğe bağlı——
attempts[].error_messageanyOf<string | null>isteğe bağlı——
attempts[].error_message · variant 1stringisteğe bağlı——
attempts[].error_message · variant 2nullisteğe bağlı——
attempts[].estimated_creditsanyOf<string | null>isteğe bağlı——
attempts[].estimated_credits · variant 1stringisteğe bağlı——
attempts[].estimated_credits · variant 2nullisteğe bağlı——
attempts[].settled_creditsanyOf<string | null>isteğe bağlı——
attempts[].settled_credits · variant 1stringisteğe bağlı——
attempts[].settled_credits · variant 2nullisteğe bağlı——
attempts[].external_side_effect_started_atanyOf<string | null>isteğe bağlı——
attempts[].external_side_effect_started_at · variant 1stringisteğe bağlı—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullisteğe bağlı——
attempts[].external_side_effect_committed_atanyOf<string | null>isteğe bağlı——
attempts[].external_side_effect_committed_at · variant 1stringisteğe bağlı—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullisteğe bağlı——
attempts[].started_atstringgerekli—
format: date-time
attempts[].completed_atanyOf<string | null>isteğe bağlı——
attempts[].completed_at · variant 1stringisteğe bağlı—
format: date-time
attempts[].completed_at · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
task_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
job_idstringgerekli——
namestringgerekli——
operationstringgerekli——
statusstringgerekli——
progressintegergerekli——
inputobjectgerekli——
optionsobjectgerekli——
resultobjectgerekli——
requiredbooleangerekli——
runtime_classstringgerekli——
prioritystringgerekli——
attempt_countintegergerekli——
max_attemptsintegergerekli——
error_codeanyOf<string | null>isteğe bağlı——
error_code · variant 1stringisteğe bağlı——
error_code · variant 2nullisteğe bağlı——
error_messageanyOf<string | null>isteğe bağlı——
error_message · variant 1stringisteğe bağlı——
error_message · variant 2nullisteğe bağlı——
created_atstringgerekli—
format: date-time
queued_atanyOf<string | null>isteğe bağlı——
queued_at · variant 1stringisteğe bağlı—
format: date-time
queued_at · variant 2nullisteğe bağlı——
started_atanyOf<string | null>isteğe bağlı——
started_at · variant 1stringisteğe bağlı—
format: date-time
started_at · variant 2nullisteğe bağlı——
completed_atanyOf<string | null>isteğe bağlı——
completed_at · variant 1stringisteğe bağlı—
format: date-time
completed_at · variant 2nullisteğe bağlı——
attemptsobject[]isteğe bağlı——
attempts[]objectisteğe bağlı——
attempts[].idstringgerekli——
attempts[].attempt_numberintegergerekli——
attempts[].statusstringgerekli——
attempts[].worker_idanyOf<string | null>isteğe bağlı——
attempts[].worker_id · variant 1stringisteğe bağlı——
attempts[].worker_id · variant 2nullisteğe bağlı——
attempts[].runtime_classanyOf<string | null>isteğe bağlı——
attempts[].runtime_class · variant 1stringisteğe bağlı——
attempts[].runtime_class · variant 2nullisteğe bağlı——
attempts[].regionanyOf<string | null>isteğe bağlı——
attempts[].region · variant 1stringisteğe bağlı——
attempts[].region · variant 2nullisteğe bağlı——
attempts[].engineanyOf<string | null>isteğe bağlı——
attempts[].engine · variant 1stringisteğe bağlı——
attempts[].engine · variant 2nullisteğe bağlı——
attempts[].engine_versionanyOf<string | null>isteğe bağlı——
attempts[].engine_version · variant 1stringisteğe bağlı——
attempts[].engine_version · variant 2nullisteğe bağlı——
attempts[].input_bytesanyOf<integer | null>isteğe bağlı——
attempts[].input_bytes · variant 1integeristeğe bağlı——
attempts[].input_bytes · variant 2nullisteğe bağlı——
attempts[].output_bytesanyOf<integer | null>isteğe bağlı——
attempts[].output_bytes · variant 1integeristeğe bağlı——
attempts[].output_bytes · variant 2nullisteğe bağlı——
attempts[].wall_msanyOf<integer | null>isteğe bağlı——
attempts[].wall_ms · variant 1integeristeğe bağlı——
attempts[].wall_ms · variant 2nullisteğe bağlı——
attempts[].cpu_msanyOf<integer | null>isteğe bağlı——
attempts[].cpu_ms · variant 1integeristeğe bağlı——
attempts[].cpu_ms · variant 2nullisteğe bağlı——
attempts[].peak_memory_mbanyOf<integer | null>isteğe bağlı——
attempts[].peak_memory_mb · variant 1integeristeğe bağlı——
attempts[].peak_memory_mb · variant 2nullisteğe bağlı——
attempts[].temp_bytesanyOf<integer | null>isteğe bağlı——
attempts[].temp_bytes · variant 1integeristeğe bağlı——
attempts[].temp_bytes · variant 2nullisteğe bağlı——
attempts[].error_codeanyOf<string | null>isteğe bağlı——
attempts[].error_code · variant 1stringisteğe bağlı——
attempts[].error_code · variant 2nullisteğe bağlı——
attempts[].error_messageanyOf<string | null>isteğe bağlı——
attempts[].error_message · variant 1stringisteğe bağlı——
attempts[].error_message · variant 2nullisteğe bağlı——
attempts[].estimated_creditsanyOf<string | null>isteğe bağlı——
attempts[].estimated_credits · variant 1stringisteğe bağlı——
attempts[].estimated_credits · variant 2nullisteğe bağlı——
attempts[].settled_creditsanyOf<string | null>isteğe bağlı——
attempts[].settled_credits · variant 1stringisteğe bağlı——
attempts[].settled_credits · variant 2nullisteğe bağlı——
attempts[].external_side_effect_started_atanyOf<string | null>isteğe bağlı——
attempts[].external_side_effect_started_at · variant 1stringisteğe bağlı—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullisteğe bağlı——
attempts[].external_side_effect_committed_atanyOf<string | null>isteğe bağlı——
attempts[].external_side_effect_committed_at · variant 1stringisteğe bağlı—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullisteğe bağlı——
attempts[].started_atstringgerekli—
format: date-time
attempts[].completed_atanyOf<string | null>isteğe bağlı——
attempts[].completed_at · variant 1stringisteğe bağlı—
format: date-time
attempts[].completed_at · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
task_idpathstringgerekli—
timeoutqueryintegeristeğe bağlı
default: 10min: 1max: 10
Last-Event-IDheaderanyOf<string | null>isteğe bağlı—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
bodyunknowngerekli——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
task_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
job_idstringgerekli——
namestringgerekli——
operationstringgerekli——
statusstringgerekli——
progressintegergerekli——
inputobjectgerekli——
optionsobjectgerekli——
resultobjectgerekli——
requiredbooleangerekli——
runtime_classstringgerekli——
prioritystringgerekli——
attempt_countintegergerekli——
max_attemptsintegergerekli——
error_codeanyOf<string | null>isteğe bağlı——
error_code · variant 1stringisteğe bağlı——
error_code · variant 2nullisteğe bağlı——
error_messageanyOf<string | null>isteğe bağlı——
error_message · variant 1stringisteğe bağlı——
error_message · variant 2nullisteğe bağlı——
created_atstringgerekli—
format: date-time
queued_atanyOf<string | null>isteğe bağlı——
queued_at · variant 1stringisteğe bağlı—
format: date-time
queued_at · variant 2nullisteğe bağlı——
started_atanyOf<string | null>isteğe bağlı——
started_at · variant 1stringisteğe bağlı—
format: date-time
started_at · variant 2nullisteğe bağlı——
completed_atanyOf<string | null>isteğe bağlı——
completed_at · variant 1stringisteğe bağlı—
format: date-time
completed_at · variant 2nullisteğe bağlı——
attemptsobject[]isteğe bağlı——
attempts[]objectisteğe bağlı——
attempts[].idstringgerekli——
attempts[].attempt_numberintegergerekli——
attempts[].statusstringgerekli——
attempts[].worker_idanyOf<string | null>isteğe bağlı——
attempts[].worker_id · variant 1stringisteğe bağlı——
attempts[].worker_id · variant 2nullisteğe bağlı——
attempts[].runtime_classanyOf<string | null>isteğe bağlı——
attempts[].runtime_class · variant 1stringisteğe bağlı——
attempts[].runtime_class · variant 2nullisteğe bağlı——
attempts[].regionanyOf<string | null>isteğe bağlı——
attempts[].region · variant 1stringisteğe bağlı——
attempts[].region · variant 2nullisteğe bağlı——
attempts[].engineanyOf<string | null>isteğe bağlı——
attempts[].engine · variant 1stringisteğe bağlı——
attempts[].engine · variant 2nullisteğe bağlı——
attempts[].engine_versionanyOf<string | null>isteğe bağlı——
attempts[].engine_version · variant 1stringisteğe bağlı——
attempts[].engine_version · variant 2nullisteğe bağlı——
attempts[].input_bytesanyOf<integer | null>isteğe bağlı——
attempts[].input_bytes · variant 1integeristeğe bağlı——
attempts[].input_bytes · variant 2nullisteğe bağlı——
attempts[].output_bytesanyOf<integer | null>isteğe bağlı——
attempts[].output_bytes · variant 1integeristeğe bağlı——
attempts[].output_bytes · variant 2nullisteğe bağlı——
attempts[].wall_msanyOf<integer | null>isteğe bağlı——
attempts[].wall_ms · variant 1integeristeğe bağlı——
attempts[].wall_ms · variant 2nullisteğe bağlı——
attempts[].cpu_msanyOf<integer | null>isteğe bağlı——
attempts[].cpu_ms · variant 1integeristeğe bağlı——
attempts[].cpu_ms · variant 2nullisteğe bağlı——
attempts[].peak_memory_mbanyOf<integer | null>isteğe bağlı——
attempts[].peak_memory_mb · variant 1integeristeğe bağlı——
attempts[].peak_memory_mb · variant 2nullisteğe bağlı——
attempts[].temp_bytesanyOf<integer | null>isteğe bağlı——
attempts[].temp_bytes · variant 1integeristeğe bağlı——
attempts[].temp_bytes · variant 2nullisteğe bağlı——
attempts[].error_codeanyOf<string | null>isteğe bağlı——
attempts[].error_code · variant 1stringisteğe bağlı——
attempts[].error_code · variant 2nullisteğe bağlı——
attempts[].error_messageanyOf<string | null>isteğe bağlı——
attempts[].error_message · variant 1stringisteğe bağlı——
attempts[].error_message · variant 2nullisteğe bağlı——
attempts[].estimated_creditsanyOf<string | null>isteğe bağlı——
attempts[].estimated_credits · variant 1stringisteğe bağlı——
attempts[].estimated_credits · variant 2nullisteğe bağlı——
attempts[].settled_creditsanyOf<string | null>isteğe bağlı——
attempts[].settled_credits · variant 1stringisteğe bağlı——
attempts[].settled_credits · variant 2nullisteğe bağlı——
attempts[].external_side_effect_started_atanyOf<string | null>isteğe bağlı——
attempts[].external_side_effect_started_at · variant 1stringisteğe bağlı—
format: date-time
attempts[].external_side_effect_started_at · variant 2nullisteğe bağlı——
attempts[].external_side_effect_committed_atanyOf<string | null>isteğe bağlı——
attempts[].external_side_effect_committed_at · variant 1stringisteğe bağlı—
format: date-time
attempts[].external_side_effect_committed_at · variant 2nullisteğe bağlı——
attempts[].started_atstringgerekli—
format: date-time
attempts[].completed_atanyOf<string | null>isteğe bağlı——
attempts[].completed_at · variant 1stringisteğe bağlı—
format: date-time
attempts[].completed_at · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
limitqueryintegeristeğe bağlı
default: 50min: 1max: 200
afterqueryanyOf<string | null>isteğe bağlı—
input_formatqueryanyOf<string | null>isteğe bağlı—
output_formatqueryanyOf<string | null>isteğe bağlı—
originqueryanyOf<string | null>isteğe bağlı—
outcomequeryanyOf<string | null>isteğe bağlı—
job_idqueryanyOf<string | null>isteğe bağlı—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
dataobject[]gerekli——
data[]objectisteğe bağlı——
data[].idstringgerekli——
data[].api_key_idanyOf<string | null>isteğe bağlı——
data[].api_key_id · variant 1stringisteğe bağlı——
data[].api_key_id · variant 2nullisteğe bağlı——
data[].originstringgerekli——
data[].outcomestringisteğe bağlı—
default: "succeeded"
data[].job_idanyOf<string | null>isteğe bağlı——
data[].job_id · variant 1stringisteğe bağlı——
data[].job_id · variant 2nullisteğe bağlı——
data[].task_idanyOf<string | null>isteğe bağlı——
data[].task_id · variant 1stringisteğe bağlı——
data[].task_id · variant 2nullisteğe bağlı——
data[].input_formatanyOf<string | null>isteğe bağlı——
data[].input_format · variant 1stringisteğe bağlı——
data[].input_format · variant 2nullisteğe bağlı——
data[].output_formatanyOf<string | null>isteğe bağlı——
data[].output_format · variant 1stringisteğe bağlı——
data[].output_format · variant 2nullisteğe bağlı——
data[].engineanyOf<string | null>isteğe bağlı——
data[].engine · variant 1stringisteğe bağlı——
data[].engine · variant 2nullisteğe bağlı——
data[].engine_versionanyOf<string | null>isteğe bağlı——
data[].engine_version · variant 1stringisteğe bağlı——
data[].engine_version · variant 2nullisteğe bağlı——
data[].runtime_classanyOf<string | null>isteğe bağlı——
data[].runtime_class · variant 1stringisteğe bağlı——
data[].runtime_class · variant 2nullisteğe bağlı——
data[].input_bytesanyOf<integer | null>isteğe bağlı——
data[].input_bytes · variant 1integeristeğe bağlı——
data[].input_bytes · variant 2nullisteğe bağlı——
data[].output_bytesanyOf<integer | null>isteğe bağlı——
data[].output_bytes · variant 1integeristeğe bağlı——
data[].output_bytes · variant 2nullisteğe bağlı——
data[].wall_msanyOf<integer | null>isteğe bağlı——
data[].wall_ms · variant 1integeristeğe bağlı——
data[].wall_ms · variant 2nullisteğe bağlı——
data[].creditsanyOf<string | null>isteğe bağlı——
data[].credits · variant 1stringisteğe bağlı——
data[].credits · variant 2nullisteğe bağlı——
data[].created_atstringgerekli—
format: date-time
paginationobjectgerekli——
pagination.nextanyOf<string | null>isteğe bağlı——
pagination.next · variant 1stringisteğe bağlı——
pagination.next · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
startqueryanyOf<string | null>isteğe bağlı—
endqueryanyOf<string | null>isteğe bağlı—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
startstringgerekli—
format: date-time
endstringgerekli—
format: date-time
conversionsintegergerekli——
creditsstringgerekli——
input_bytesintegergerekli——
output_bytesintegergerekli——
wall_msintegergerekli——
by_originobject[]isteğe bağlı——
by_origin[]objectisteğe bağlı——
by_origin[].keystringgerekli——
by_origin[].conversionsintegergerekli——
by_origin[].creditsstringgerekli——
top_pairsobject[]isteğe bağlı——
top_pairs[]objectisteğe bağlı——
top_pairs[].keystringgerekli——
top_pairs[].conversionsintegergerekli——
top_pairs[].creditsstringgerekli——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
delivery_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
webhook_idstringgerekli——
event_idstringgerekli——
statusstringgerekli——
attemptintegergerekli——
request_headersobjectgerekli——
request_bodyobjectgerekli——
response_statusanyOf<integer | null>isteğe bağlı——
response_status · variant 1integeristeğe bağlı——
response_status · variant 2nullisteğe bağlı——
response_bodyanyOf<string | null>isteğe bağlı——
response_body · variant 1stringisteğe bağlı——
response_body · variant 2nullisteğe bağlı——
latency_msanyOf<integer | null>isteğe bağlı——
latency_ms · variant 1integeristeğe bağlı——
latency_ms · variant 2nullisteğe bağlı——
error_messageanyOf<string | null>isteğe bağlı——
error_message · variant 1stringisteğe bağlı——
error_message · variant 2nullisteğe bağlı——
next_retry_atanyOf<string | null>isteğe bağlı——
next_retry_at · variant 1stringisteğe bağlı—
format: date-time
next_retry_at · variant 2nullisteğe bağlı——
delivered_atanyOf<string | null>isteğe bağlı——
delivered_at · variant 1stringisteğe bağlı—
format: date-time
delivered_at · variant 2nullisteğe bağlı——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
delivery_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
webhook_idstringgerekli——
event_idstringgerekli——
statusstringgerekli——
attemptintegergerekli——
request_headersobjectgerekli——
request_bodyobjectgerekli——
response_statusanyOf<integer | null>isteğe bağlı——
response_status · variant 1integeristeğe bağlı——
response_status · variant 2nullisteğe bağlı——
response_bodyanyOf<string | null>isteğe bağlı——
response_body · variant 1stringisteğe bağlı——
response_body · variant 2nullisteğe bağlı——
latency_msanyOf<integer | null>isteğe bağlı——
latency_ms · variant 1integeristeğe bağlı——
latency_ms · variant 2nullisteğe bağlı——
error_messageanyOf<string | null>isteğe bağlı——
error_message · variant 1stringisteğe bağlı——
error_message · variant 2nullisteğe bağlı——
next_retry_atanyOf<string | null>isteğe bağlı——
next_retry_at · variant 1stringisteğe bağlı—
format: date-time
next_retry_at · variant 2nullisteğe bağlı——
delivered_atanyOf<string | null>isteğe bağlı——
delivered_at · variant 1stringisteğe bağlı—
format: date-time
delivered_at · variant 2nullisteğe bağlı——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
bodyobject[]gerekli——
items[]objectisteğe bağlı——
items[].idstringgerekli——
items[].urlstringgerekli——
items[].descriptionanyOf<string | null>isteğe bağlı——
items[].description · variant 1stringisteğe bağlı——
items[].description · variant 2nullisteğe bağlı——
items[].event_typesstring[]gerekli——
items[].enabledbooleangerekli——
items[].failure_countintegergerekli——
items[].created_atstringgerekli—
format: date-time
items[].updated_atstringgerekli—
format: date-time
items[].signing_secretanyOf<string | null>isteğe bağlı——
items[].signing_secret · variant 1stringisteğe bağlı——
items[].signing_secret · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
urlstringgerekli—
min length: 1max length: 2048
descriptionanyOf<string | null>isteğe bağlı——
description · variant 1stringisteğe bağlı—
max length: 512
description · variant 2nullisteğe bağlı——
event_typesstring[]isteğe bağlı——

Yanıtlar

201Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
urlstringgerekli——
descriptionanyOf<string | null>isteğe bağlı——
description · variant 1stringisteğe bağlı——
description · variant 2nullisteğe bağlı——
event_typesstring[]gerekli——
enabledbooleangerekli——
failure_countintegergerekli——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
signing_secretanyOf<string | null>isteğe bağlı——
signing_secret · variant 1stringisteğe bağlı——
signing_secret · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
webhook_idpathstringgerekli—

Yanıtlar

204Successful Response

Yanıt gövdesi yok.

400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
webhook_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
urlstringgerekli——
descriptionanyOf<string | null>isteğe bağlı——
description · variant 1stringisteğe bağlı——
description · variant 2nullisteğe bağlı——
event_typesstring[]gerekli——
enabledbooleangerekli——
failure_countintegergerekli——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
signing_secretanyOf<string | null>isteğe bağlı——
signing_secret · variant 1stringisteğe bağlı——
signing_secret · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
webhook_idpathstringgerekli—

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
urlanyOf<string | null>isteğe bağlı——
url · variant 1stringisteğe bağlı—
min length: 1max length: 2048
url · variant 2nullisteğe bağlı——
descriptionanyOf<string | null>isteğe bağlı——
description · variant 1stringisteğe bağlı—
max length: 512
description · variant 2nullisteğe bağlı——
event_typesanyOf<string[] | null>isteğe bağlı——
event_types · variant 1string[]isteğe bağlı——
event_types · variant 2nullisteğe bağlı——
enabledanyOf<boolean | null>isteğe bağlı——
enabled · variant 1booleanisteğe bağlı——
enabled · variant 2nullisteğe bağlı——

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
urlstringgerekli——
descriptionanyOf<string | null>isteğe bağlı——
description · variant 1stringisteğe bağlı——
description · variant 2nullisteğe bağlı——
event_typesstring[]gerekli——
enabledbooleangerekli——
failure_countintegergerekli——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
signing_secretanyOf<string | null>isteğe bağlı——
signing_secret · variant 1stringisteğe bağlı——
signing_secret · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
webhook_idpathstringgerekli—
limitqueryintegeristeğe bağlı
default: 50min: 1max: 100
afterqueryanyOf<string | null>isteğe bağlı—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
dataobject[]gerekli——
data[]objectisteğe bağlı——
data[].idstringgerekli——
data[].webhook_idstringgerekli——
data[].event_idstringgerekli——
data[].statusstringgerekli——
data[].attemptintegergerekli——
data[].request_headersobjectgerekli——
data[].request_bodyobjectgerekli——
data[].response_statusanyOf<integer | null>isteğe bağlı——
data[].response_status · variant 1integeristeğe bağlı——
data[].response_status · variant 2nullisteğe bağlı——
data[].response_bodyanyOf<string | null>isteğe bağlı——
data[].response_body · variant 1stringisteğe bağlı——
data[].response_body · variant 2nullisteğe bağlı——
data[].latency_msanyOf<integer | null>isteğe bağlı——
data[].latency_ms · variant 1integeristeğe bağlı——
data[].latency_ms · variant 2nullisteğe bağlı——
data[].error_messageanyOf<string | null>isteğe bağlı——
data[].error_message · variant 1stringisteğe bağlı——
data[].error_message · variant 2nullisteğe bağlı——
data[].next_retry_atanyOf<string | null>isteğe bağlı——
data[].next_retry_at · variant 1stringisteğe bağlı—
format: date-time
data[].next_retry_at · variant 2nullisteğe bağlı——
data[].delivered_atanyOf<string | null>isteğe bağlı——
data[].delivered_at · variant 1stringisteğe bağlı—
format: date-time
data[].delivered_at · variant 2nullisteğe bağlı——
data[].created_atstringgerekli—
format: date-time
data[].updated_atstringgerekli—
format: date-time
paginationobjectgerekli——
pagination.nextanyOf<string | null>isteğe bağlı——
pagination.next · variant 1stringisteğe bağlı——
pagination.next · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
webhook_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
signing_secretstringgerekli——
previous_secret_valid_untilanyOf<string | null>isteğe bağlı——
previous_secret_valid_until · variant 1stringisteğe bağlı—
format: date-time
previous_secret_valid_until · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
limitqueryintegeristeğe bağlı
default: 50min: 1max: 200
afterqueryanyOf<string | null>isteğe bağlı—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
dataobject[]gerekli——
data[]objectisteğe bağlı——
data[].idstringgerekli——
data[].namestringgerekli——
data[].descriptionanyOf<string | null>isteğe bağlı——
data[].description · variant 1stringisteğe bağlı——
data[].description · variant 2nullisteğe bağlı——
data[].current_versionintegergerekli——
data[].definitionobjectgerekli——
data[].variables_schemaobjectgerekli——
data[].metadataobjectgerekli——
data[].created_atstringgerekli—
format: date-time
data[].updated_atstringgerekli—
format: date-time
paginationobjectgerekli——
pagination.nextanyOf<string | null>isteğe bağlı——
pagination.next · variant 1stringisteğe bağlı——
pagination.next · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
namestringgerekli—
min length: 1max length: 255
descriptionanyOf<string | null>isteğe bağlı——
description · variant 1stringisteğe bağlı—
max length: 2000
description · variant 2nullisteğe bağlı——
definitionobjectgerekli——
definition.tasksobjectgerekli——
definition.taganyOf<string | null>isteğe bağlı——
definition.tag · variant 1stringisteğe bağlı—
max length: 255
definition.tag · variant 2nullisteğe bağlı——
definition.client_reference_idanyOf<string | null>isteğe bağlı——
definition.client_reference_id · variant 1stringisteğe bağlı—
max length: 255
definition.client_reference_id · variant 2nullisteğe bağlı——
definition.metadataobjectisteğe bağlı——
definition.prioritystringisteğe bağlı—
enum: "low", "normal", "high"default: "normal"
definition.retention_secondsanyOf<integer | null>isteğe bağlı——
definition.retention_seconds · variant 1integeristeğe bağlı—
min: 0max: 86400
definition.retention_seconds · variant 2nullisteğe bağlı——
variables_schemaobjectisteğe bağlı——
metadataobjectisteğe bağlı——

Yanıtlar

201Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
namestringgerekli——
descriptionanyOf<string | null>isteğe bağlı——
description · variant 1stringisteğe bağlı——
description · variant 2nullisteğe bağlı——
current_versionintegergerekli——
definitionobjectgerekli——
variables_schemaobjectgerekli——
metadataobjectgerekli——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
workflow_idpathstringgerekli—

Yanıtlar

204Successful Response

Yanıt gövdesi yok.

400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
workflow_idpathstringgerekli—

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
namestringgerekli——
descriptionanyOf<string | null>isteğe bağlı——
description · variant 1stringisteğe bağlı——
description · variant 2nullisteğe bağlı——
current_versionintegergerekli——
definitionobjectgerekli——
variables_schemaobjectgerekli——
metadataobjectgerekli——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
workflow_idpathstringgerekli—

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
nameanyOf<string | null>isteğe bağlı——
name · variant 1stringisteğe bağlı—
min length: 1max length: 255
name · variant 2nullisteğe bağlı——
descriptionanyOf<string | null>isteğe bağlı——
description · variant 1stringisteğe bağlı—
max length: 2000
description · variant 2nullisteğe bağlı——
definitionanyOf<object | null>isteğe bağlı——
definition · variant 1objectisteğe bağlı——
definition · variant 1.tasksobjectgerekli——
definition · variant 1.taganyOf<string | null>isteğe bağlı——
definition · variant 1.tag · variant 1stringisteğe bağlı—
max length: 255
definition · variant 1.tag · variant 2nullisteğe bağlı——
definition · variant 1.client_reference_idanyOf<string | null>isteğe bağlı——
definition · variant 1.client_reference_id · variant 1stringisteğe bağlı—
max length: 255
definition · variant 1.client_reference_id · variant 2nullisteğe bağlı——
definition · variant 1.metadataobjectisteğe bağlı——
definition · variant 1.prioritystringisteğe bağlı—
enum: "low", "normal", "high"default: "normal"
definition · variant 1.retention_secondsanyOf<integer | null>isteğe bağlı——
definition · variant 1.retention_seconds · variant 1integeristeğe bağlı—
min: 0max: 86400
definition · variant 1.retention_seconds · variant 2nullisteğe bağlı——
definition · variant 2nullisteğe bağlı——
variables_schemaanyOf<object | null>isteğe bağlı——
variables_schema · variant 1objectisteğe bağlı——
variables_schema · variant 2nullisteğe bağlı——
metadataanyOf<object | null>isteğe bağlı——
metadata · variant 1objectisteğe bağlı——
metadata · variant 2nullisteğe bağlı——

Yanıtlar

200Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
namestringgerekli——
descriptionanyOf<string | null>isteğe bağlı——
description · variant 1stringisteğe bağlı——
description · variant 2nullisteğe bağlı——
current_versionintegergerekli——
definitionobjectgerekli——
variables_schemaobjectgerekli——
metadataobjectgerekli——
created_atstringgerekli—
format: date-time
updated_atstringgerekli—
format: date-time
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
404The requested resource does not exist in the caller's project boundary.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
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.

Kimlik doğrulama
ConverterHQBearerhttp / bearer

Parametreler

İsimKonumTürGerekliAçıklama / kısıtlamalar
workflow_idpathstringgerekli—
Idempotency-KeyheaderanyOf<string | null>isteğe bağlı—

İstek gövdesi gerekli

application/json
AlanTürGerekliAçıklamaKısıtlamalar
variablesobjectisteğe bağlı——
client_reference_idanyOf<string | null>isteğe bağlı——
client_reference_id · variant 1stringisteğe bağlı—
max length: 255
client_reference_id · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——

Yanıtlar

201Successful Response
application/json
AlanTürGerekliAçıklamaKısıtlamalar
idstringgerekli——
kindstringgerekli——
statusstringgerekli——
progressintegergerekli——
taganyOf<string | null>isteğe bağlı——
tag · variant 1stringisteğe bağlı——
tag · variant 2nullisteğe bağlı——
client_reference_idanyOf<string | null>isteğe bağlı——
client_reference_id · variant 1stringisteğe bağlı——
client_reference_id · variant 2nullisteğe bağlı——
metadataobjectisteğe bağlı——
prioritystringgerekli——
concurrency_limitintegeristeğe bağlı—
default: 1
originstringgerekli——
created_atstringgerekli—
format: date-time
started_atanyOf<string | null>isteğe bağlı——
started_at · variant 1stringisteğe bağlı—
format: date-time
started_at · variant 2nullisteğe bağlı——
completed_atanyOf<string | null>isteğe bağlı——
completed_at · variant 1stringisteğe bağlı—
format: date-time
completed_at · variant 2nullisteğe bağlı——
error_codeanyOf<string | null>isteğe bağlı——
error_code · variant 1stringisteğe bağlı——
error_code · variant 2nullisteğe bağlı——
error_messageanyOf<string | null>isteğe bağlı——
error_message · variant 1stringisteğe bağlı——
error_message · variant 2nullisteğe bağlı——
tasksobject[]isteğe bağlı——
tasks[]objectisteğe bağlı——
tasks[].idstringgerekli——
tasks[].job_idstringgerekli——
tasks[].namestringgerekli——
tasks[].operationstringgerekli——
tasks[].statusstringgerekli——
tasks[].progressintegergerekli——
tasks[].inputobjectgerekli——
tasks[].optionsobjectgerekli——
tasks[].resultobjectgerekli——
tasks[].requiredbooleangerekli——
tasks[].runtime_classstringgerekli——
tasks[].prioritystringgerekli——
tasks[].attempt_countintegergerekli——
tasks[].max_attemptsintegergerekli——
tasks[].error_codeanyOf<string | null>isteğe bağlı——
tasks[].error_code · variant 1stringisteğe bağlı——
tasks[].error_code · variant 2nullisteğe bağlı——
tasks[].error_messageanyOf<string | null>isteğe bağlı——
tasks[].error_message · variant 1stringisteğe bağlı——
tasks[].error_message · variant 2nullisteğe bağlı——
tasks[].created_atstringgerekli—
format: date-time
tasks[].queued_atanyOf<string | null>isteğe bağlı——
tasks[].queued_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].queued_at · variant 2nullisteğe bağlı——
tasks[].started_atanyOf<string | null>isteğe bağlı——
tasks[].started_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].started_at · variant 2nullisteğe bağlı——
tasks[].completed_atanyOf<string | null>isteğe bağlı——
tasks[].completed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].completed_at · variant 2nullisteğe bağlı——
tasks[].attemptsobject[]isteğe bağlı——
tasks[].attempts[]objectisteğe bağlı——
tasks[].attempts[].idstringgerekli——
tasks[].attempts[].attempt_numberintegergerekli——
tasks[].attempts[].statusstringgerekli——
tasks[].attempts[].worker_idanyOf<string | null>isteğe bağlı——
tasks[].attempts[].worker_id · variant 1stringisteğe bağlı——
tasks[].attempts[].worker_id · variant 2nullisteğe bağlı——
tasks[].attempts[].runtime_classanyOf<string | null>isteğe bağlı——
tasks[].attempts[].runtime_class · variant 1stringisteğe bağlı——
tasks[].attempts[].runtime_class · variant 2nullisteğe bağlı——
tasks[].attempts[].regionanyOf<string | null>isteğe bağlı——
tasks[].attempts[].region · variant 1stringisteğe bağlı——
tasks[].attempts[].region · variant 2nullisteğe bağlı——
tasks[].attempts[].engineanyOf<string | null>isteğe bağlı——
tasks[].attempts[].engine · variant 1stringisteğe bağlı——
tasks[].attempts[].engine · variant 2nullisteğe bağlı——
tasks[].attempts[].engine_versionanyOf<string | null>isteğe bağlı——
tasks[].attempts[].engine_version · variant 1stringisteğe bağlı——
tasks[].attempts[].engine_version · variant 2nullisteğe bağlı——
tasks[].attempts[].input_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].input_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].input_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].output_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].output_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].output_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].wall_msanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].wall_ms · variant 1integeristeğe bağlı——
tasks[].attempts[].wall_ms · variant 2nullisteğe bağlı——
tasks[].attempts[].cpu_msanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].cpu_ms · variant 1integeristeğe bağlı——
tasks[].attempts[].cpu_ms · variant 2nullisteğe bağlı——
tasks[].attempts[].peak_memory_mbanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].peak_memory_mb · variant 1integeristeğe bağlı——
tasks[].attempts[].peak_memory_mb · variant 2nullisteğe bağlı——
tasks[].attempts[].temp_bytesanyOf<integer | null>isteğe bağlı——
tasks[].attempts[].temp_bytes · variant 1integeristeğe bağlı——
tasks[].attempts[].temp_bytes · variant 2nullisteğe bağlı——
tasks[].attempts[].error_codeanyOf<string | null>isteğe bağlı——
tasks[].attempts[].error_code · variant 1stringisteğe bağlı——
tasks[].attempts[].error_code · variant 2nullisteğe bağlı——
tasks[].attempts[].error_messageanyOf<string | null>isteğe bağlı——
tasks[].attempts[].error_message · variant 1stringisteğe bağlı——
tasks[].attempts[].error_message · variant 2nullisteğe bağlı——
tasks[].attempts[].estimated_creditsanyOf<string | null>isteğe bağlı——
tasks[].attempts[].estimated_credits · variant 1stringisteğe bağlı——
tasks[].attempts[].estimated_credits · variant 2nullisteğe bağlı——
tasks[].attempts[].settled_creditsanyOf<string | null>isteğe bağlı——
tasks[].attempts[].settled_credits · variant 1stringisteğe bağlı——
tasks[].attempts[].settled_credits · variant 2nullisteğe bağlı——
tasks[].attempts[].external_side_effect_started_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].external_side_effect_started_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].external_side_effect_started_at · variant 2nullisteğe bağlı——
tasks[].attempts[].external_side_effect_committed_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].external_side_effect_committed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].external_side_effect_committed_at · variant 2nullisteğe bağlı——
tasks[].attempts[].started_atstringgerekli—
format: date-time
tasks[].attempts[].completed_atanyOf<string | null>isteğe bağlı——
tasks[].attempts[].completed_at · variant 1stringisteğe bağlı—
format: date-time
tasks[].attempts[].completed_at · variant 2nullisteğe bağlı——
400The request could not be processed.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
401Authentication is missing or invalid.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
403The principal is not allowed to perform this operation.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
409The request conflicts with the current resource or idempotency state.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
422Validation Error
application/json
AlanTürGerekliAçıklamaKısıtlamalar
detailobject[]isteğe bağlı——
detail[]objectisteğe bağlı——
detail[].locanyOf<string | integer>[]gerekli——
detail[].loc[]anyOf<string | integer>isteğe bağlı——
detail[].loc[] · variant 1stringisteğe bağlı——
detail[].loc[] · variant 2integeristeğe bağlı——
detail[].msgstringgerekli——
detail[].typestringgerekli——
429The caller has exceeded an admission-control limit.
Yanıt başlıklarıRateLimit-LimitintegerRateLimit-RemainingintegerRateLimit-ResetintegerRetry-AfteranyOf<integer | string>
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
500An unexpected server error occurred.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——
503A required service is temporarily unavailable.
application/problem+json
AlanTürGerekliAçıklamaKısıtlamalar
typestringgerekli—
default: "about:blank"
titlestringgerekli——
statusintegergerekli—
min: 400max: 599
codestringgerekli——
detailstringgerekli——
retryablebooleangerekli——
parameteranyOf<string | null>isteğe bağlı——
parameter · variant 1stringisteğe bağlı——
parameter · variant 2nullisteğe bağlı——
request_idanyOf<string | null>isteğe bağlı——
request_id · variant 1stringisteğe bağlı——
request_id · variant 2nullisteğe bağlı——