Odinn ML Documentation

Postman collection → OpenAPI spec →

Введение

Документация предоставляет всю информацию, необходимую вам для работы с нашим API.

Аутентификация запросов

Этот API не аутентифицирован.

ML Results

Список

GET
https://ml.persomon.odinn.cloud
/api/ml-results

Получить список экспортов результатов применения ML (с пагинацией)

Стандартный листинг Одинна с возможностью фильтрации

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

page
integer

Номер страницы.

Example:
1
page-size
integer

Количество элементов, возвращаемых на странице. По умолчанию 50.

Example:
50
Example request: 
curl --request GET \
    --get "https://ml.persomon.odinn.cloud/api/ml-results?page=1&page-size=50" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "current_page": 1,
    "data": [],
    "first_page_url": "https://ml.persomon.odinn.cloud/api/ml-results?page=1",
    "from": null,
    "last_page": 1,
    "last_page_url": "https://ml.persomon.odinn.cloud/api/ml-results?page=1",
    "links": [
        {
            "url": null,
            "label": "« Назад",
            "active": false
        },
        {
            "url": "https://ml.persomon.odinn.cloud/api/ml-results?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Вперёд »",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "https://ml.persomon.odinn.cloud/api/ml-results",
    "per_page": 50,
    "prev_page_url": null,
    "to": null,
    "total": 0
}

Получение результатов по применению ML через API

GET
https://ml.persomon.odinn.cloud
/api/ml-results/ml-data

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request GET \
    --get "https://ml.persomon.odinn.cloud/api/ml-results/ml-data" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ids\": [
        \"818d8c20-4342-39a3-9888-b356987a8700\"
    ]
}"
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Server Error"
}

Экспорт результатов по применению ML в виде файла

POST
https://ml.persomon.odinn.cloud
/api/ml-results/export

Начинает выгрузку результатов по применению ML в виде файла. Метод только начинает выгрузку, скачать файл можно будет по завершении (статус completed)

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://ml.persomon.odinn.cloud/api/ml-results/export" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ids\": [
        \"800720db-423b-3dd6-9046-7ef0567c4df8\"
    ],
    \"with_photo\": true
}"

Получить информацию об экспорте

GET
https://ml.persomon.odinn.cloud
/api/ml-results/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
uuid
required

Идентификатор (UUID)

Example:
12196d51-9cd6-3ab5-9b90-08fa15fcfe49
Example request: 
curl --request GET \
    --get "https://ml.persomon.odinn.cloud/api/ml-results/12196d51-9cd6-3ab5-9b90-08fa15fcfe49" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Ml Results Export #12196d51-9cd6-3ab5-9b90-08fa15fcfe49 Not found"
}

Скачать файл экспорта результатов по применению ML

GET
https://ml.persomon.odinn.cloud
/api/ml-results/{id}/download

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
uuid
required

Идентификатор (UUID)

Example:
5b8fd871-1b88-3637-93b1-14e92dd9002a
Example request: 
curl --request GET \
    --get "https://ml.persomon.odinn.cloud/api/ml-results/5b8fd871-1b88-3637-93b1-14e92dd9002a/download" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": ""
}

Весы моделей

Список

GET
https://ml.persomon.odinn.cloud
/api/weight

Получить список весов (с пагинацией) Стандартный листинг Одинна с возможностью фильтрации

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

page
integer

Номер страницы.

Example:
1
page-size
integer

Количество элементов, возвращаемых на странице. По умолчанию 50.

Example:
50
Example request: 
curl --request GET \
    --get "https://ml.persomon.odinn.cloud/api/weight?page=1&page-size=50" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "current_page": 1,
    "data": [],
    "first_page_url": "https://ml.persomon.odinn.cloud/api/weight?page=1",
    "from": null,
    "last_page": 1,
    "last_page_url": "https://ml.persomon.odinn.cloud/api/weight?page=1",
    "links": [
        {
            "url": null,
            "label": "« Назад",
            "active": false
        },
        {
            "url": "https://ml.persomon.odinn.cloud/api/weight?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Вперёд »",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "https://ml.persomon.odinn.cloud/api/weight",
    "per_page": 50,
    "prev_page_url": null,
    "to": null,
    "total": 0
}

Получить информацию о весах модели

GET
https://ml.persomon.odinn.cloud
/api/weight/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
uuid
required

Идентификатор (UUID)

Example:
1d393a5e-8745-3ea3-a7b4-66bba0366fc0
Example request: 
curl --request GET \
    --get "https://ml.persomon.odinn.cloud/api/weight/1d393a5e-8745-3ea3-a7b4-66bba0366fc0" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Weight #1d393a5e-8745-3ea3-a7b4-66bba0366fc0 Not found"
}

Скачать файл весов

GET
https://ml.persomon.odinn.cloud
/api/weight/{id}/download

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
uuid
required

Идентификатор (UUID)

Example:
cd82527a-b988-358b-80d4-e21569fdccce
Example request: 
curl --request GET \
    --get "https://ml.persomon.odinn.cloud/api/weight/cd82527a-b988-358b-80d4-e21569fdccce/download" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": ""
}

Создать

POST
https://ml.persomon.odinn.cloud
/api/weight

Headers

Content-Type
Example:
multipart/form-data
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://ml.persomon.odinn.cloud/api/weight" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=repellat"\
    --form "notes=id"\
    --form "models[]=accusantium"\
    --form "file=@/tmp/php5vmAG8"

Обновить информацию о весах моделей

PUT
https://ml.persomon.odinn.cloud
/api/weight/{id}

Headers

Content-Type
Example:
multipart/form-data
Accept
Example:
application/json

URL Parameters

id
uuid
required

Идентификатор (UUID)

Example:
f69fb9a6-8033-3849-b983-775f06fda407

Body Parameters

Example request: 
curl --request PUT \
    "https://ml.persomon.odinn.cloud/api/weight/f69fb9a6-8033-3849-b983-775f06fda407" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=voluptate"\
    --form "notes=iure"\
    --form "models[]=consequatur"\
    --form "file=@/tmp/php8cjTv9"

Удалить весы модели

DELETE
https://ml.persomon.odinn.cloud
/api/weight/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
uuid
required

Идентификатор (UUID)

Example:
17d34779-1796-3efc-b62f-fe4c26f8864a
Example request: 
curl --request DELETE \
    "https://ml.persomon.odinn.cloud/api/weight/17d34779-1796-3efc-b62f-fe4c26f8864a" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Модели

Список

GET
https://ml.persomon.odinn.cloud
/api/ai-model

Получить список весов (с пагинацией) Стандартный листинг Одинна с возможностью фильтрации

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

page
integer

Номер страницы.

Example:
1
page-size
integer

Количество элементов, возвращаемых на странице. По умолчанию 50.

Example:
50
Example request: 
curl --request GET \
    --get "https://ml.persomon.odinn.cloud/api/ai-model?page=1&page-size=50" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "current_page": 1,
    "data": [],
    "first_page_url": "https://ml.persomon.odinn.cloud/api/ai-model?page=1",
    "from": null,
    "last_page": 1,
    "last_page_url": "https://ml.persomon.odinn.cloud/api/ai-model?page=1",
    "links": [
        {
            "url": null,
            "label": "« Назад",
            "active": false
        },
        {
            "url": "https://ml.persomon.odinn.cloud/api/ai-model?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Вперёд »",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "https://ml.persomon.odinn.cloud/api/ai-model",
    "per_page": 50,
    "prev_page_url": null,
    "to": null,
    "total": 0
}

Получить информацию о модели

GET
https://ml.persomon.odinn.cloud
/api/ai-model/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
uuid
required

Идентификатор (UUID)

Example:
e91204f4-97ac-38e6-a90f-740a28fb44af
Example request: 
curl --request GET \
    --get "https://ml.persomon.odinn.cloud/api/ai-model/e91204f4-97ac-38e6-a90f-740a28fb44af" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "AI Model #e91204f4-97ac-38e6-a90f-740a28fb44af Not found"
}

Скачать файл модели

GET
https://ml.persomon.odinn.cloud
/api/ai-model/{id}/download

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
uuid
required

Идентификатор (UUID)

Example:
3039498f-c566-35a2-a018-d95660c603ac
Example request: 
curl --request GET \
    --get "https://ml.persomon.odinn.cloud/api/ai-model/3039498f-c566-35a2-a018-d95660c603ac/download" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": ""
}

Создать

POST
https://ml.persomon.odinn.cloud
/api/ai-model

Headers

Content-Type
Example:
multipart/form-data
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://ml.persomon.odinn.cloud/api/ai-model" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=rerum"\
    --form "notes=necessitatibus"\
    --form "classes[]=perferendis"\
    --form "file=@/tmp/phpKojQC9"

Обновить информацию о модели

PUT
https://ml.persomon.odinn.cloud
/api/ai-model/{id}

Headers

Content-Type
Example:
multipart/form-data
Accept
Example:
application/json

URL Parameters

id
uuid
required

Идентификатор (UUID)

Example:
7ee78556-02bb-34f2-ba63-a5b29aca982e

Body Parameters

Example request: 
curl --request PUT \
    "https://ml.persomon.odinn.cloud/api/ai-model/7ee78556-02bb-34f2-ba63-a5b29aca982e" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=quisquam"\
    --form "notes=doloremque"\
    --form "classes[]=cum"\
    --form "file=@/tmp/phpblDSib"

Удалить модель

DELETE
https://ml.persomon.odinn.cloud
/api/ai-model/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
uuid
required

Идентификатор (UUID)

Example:
794a7175-f118-33cb-9f1b-5d08ab5f0020
Example request: 
curl --request DELETE \
    "https://ml.persomon.odinn.cloud/api/ai-model/794a7175-f118-33cb-9f1b-5d08ab5f0020" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"