Единый каталог моделей

GET/v1/models

Требуемое право: models:read или любое право операции

Авторизация

Authorizationstringобязательный

Ключ API в заголовке Authorization: Bearer <ключ>. Ключ создаётся в кабинете, подробнее — в разделе Аутентификация.

Параметры запроса

pageintegerпо умолчанию 1 · 1 … 9007199254740991

page_sizeintegerпо умолчанию 100 · 1 … 100

operationstring

qstringдлина 0–200

Поиск без учёта регистра по ID модели, опубликованным aliases, slug, названию и разработчику. Описания моделей не участвуют.

enabledboolean

Ответы

200Успешный ответ

application/json

object"list"обязательный

dataobject[]обязательный

Вложенные поля

idstringобязательный

Публичный API ID; совпадает с public_api_id.

canonical_idstringобязательный

display_namestringобязательный

developerstringобязательный

operationsstring[]обязательный

pricesobject[]обязательный

Вложенные поля

operationstringобязательный

componentstringобязательный

amount_microrubintegerобязательный0 … 9007199254740991

unitstringобязательный

quantityintegerобязательный1 … 9007199254740991

status"published"обязательный

currency"RUB"обязательный

conditionobject

effective_fromstringdate-time

effective_tostring | null

observed_atstringdate-time

availabilityobjectобязательный

Вложенные поля

enabledbooleanобязательный

operationsobject[]обязательный

Вложенные поля

operationstringобязательный

enabledbooleanобязательный

api_pathstring | nullобязательный

studio_supportedbooleanобязательный

corestringобязательный

Значения: "implemented" "unsupported" "unknown"

inventorystringобязательный

Значения: "observed" "missing"

localstringобязательный

Значения: "PASS" "FAIL" "NOT_RUN"

livestringобязательный

Значения: "PASS" "FAIL" "NOT_RUN"

commercialstringобязательный

Значения: "on" "off"

sourceobjectобязательный

Вложенные поля

facts_completebooleanобязательный

price_completebooleanобязательный

evidence_atstring | nullобязательный

supported_parametersstring[]обязательный

technical_eligibleboolean

object"model"

owned_bystring

slugstring

description_rustring

description_full_rustring

input_modalitiesstring[]

output_modalitiesstring[]

capabilitiesobject

public_statusstring

Значения: "available" "soon" "temporarily_unavailable"

pricingobject

public_api_idstring

Копируйте это значение в model.

api_aliasesstring[]

Опубликованные aliases той же canonical-модели.

datesobject

Вложенные поля

releaseobject | nullобязательный

Вложенные поля

valuestringобязательный

precisionstringобязательный

Значения: "month" "day" "timestamp"

provenance"supplier_declared_release"обязательный

supplier_addedobject | nullобязательный

Вложенные поля

valuestringобязательный

precisionstringобязательный

Значения: "month" "day" "timestamp"

provenance"supplier_added"обязательный

paginationobjectобязательный

Вложенные поля

pageintegerобязательный1 … 9007199254740991

page_sizeintegerобязательный1 … 9007199254740991

totalintegerобязательный0 … 9007199254740991

total_pagesintegerобязательный0 … 9007199254740991

ОшибкаОшибка проверки, прав, лимита или доступности. Код error.code; результат запроса при неизвестном исходе не следует считать отменённым.

application/json

errorobjectобязательный

Вложенные поля

codestringобязательный

messagestringобязательный

request_idstring

typestring