Перейти к содержимому
Agentum Cloud для разработчиков

List Catalog

GET
/v1/catalog
curl --request GET \
  --url 'https://api.cloud.agentums.ru/v1/catalog?q=&kind=&category=&limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Витрина каталога: одобренные карточки, популярные сверху.

Пометки «установлено» и «есть обновление» считаются здесь же, одним запросом на весь список: иначе клиенту пришлось бы спрашивать про каждую карточку отдельно, а до тех пор рисовать «Установить» под тем, что у человека уже стоит.

Authorizations

Заголовок раздела «Authorizations»

Parameters

Заголовок раздела «Parameters»

Query Parameters

Заголовок раздела «Query Parameters»
q
Q
string
"" <= 100 characters
kind
Kind
string
""
category
Category
string
""
limit
Limit
integer
default: 50 >= 1 <= 100
offset
Offset
integer
0

Responses

Заголовок раздела «Responses»

200

Заголовок раздела «200»

Successful Response

Media typeapplication/json
CatalogListOut

Витрина плюс справочники фильтров — экран каталога один, и второй запрос ради списка рубрик был бы лишним раундтрипом (так же устроен /v1/agents).

object
categories
Categories
Array<string>
installed_count
Installed Count
integer
0
installed_limit
Installed Limit
integer
0
items
Items
Array<object>
CatalogCardOut

Карточка витрины: что видно в сетке.

object
author_handle
Author Handle
string
""
author_name
Author Name
string
""
category
required
Category
string
icon
required
Icon
string
installed
Installed
boolean
installed_version
Installed Version
integer
0
installs
Installs
integer
0
kind
required
Kind
string
slug
required
Slug
string
summary
required
Summary
string
title
required
Title
string
update_available
Update Available
boolean
url
Url
string
""
version
Version
integer
0
kinds
Kinds
Array<string>
total
Total
integer
0
Example
{
  "installed_count": 0,
  "installed_limit": 0,
  "items": [
    {
      "author_handle": "",
      "author_name": "",
      "installed": false,
      "installed_version": 0,
      "installs": 0,
      "update_available": false,
      "url": "",
      "version": 0
    }
  ],
  "total": 0
}

422

Заголовок раздела «422»

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}