Odinn ML Documentation

Postman collection → OpenAPI spec →

Введение

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

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

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

ML Results

Список

GET
https://ml.demo2.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.demo2.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.demo2.odinn.cloud/api/ml-results?page=1",
    "from": null,
    "last_page": 1,
    "last_page_url": "https://ml.demo2.odinn.cloud/api/ml-results?page=1",
    "links": [
        {
            "url": null,
            "label": "« Назад",
            "active": false
        },
        {
            "url": "https://ml.demo2.odinn.cloud/api/ml-results?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Вперёд »",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "https://ml.demo2.odinn.cloud/api/ml-results",
    "per_page": 50,
    "prev_page_url": null,
    "to": null,
    "total": 0
}

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

GET
https://ml.demo2.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.demo2.odinn.cloud/api/ml-results/ml-data" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ids\": [
        \"a461842d-a24b-38fb-b4c2-c53f3ed9ff84\"
    ]
}"
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
[]

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

POST
https://ml.demo2.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.demo2.odinn.cloud/api/ml-results/export" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ids\": [
        \"bbefe10d-53b0-3311-935d-f6309d7cc3ec\"
    ],
    \"with_photo\": true
}"

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

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

Headers

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

URL Parameters

id
uuid
required

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

Example:
96156577-70b5-3ff8-bef7-5de476be9553
Example request: 
curl --request GET \
    --get "https://ml.demo2.odinn.cloud/api/ml-results/96156577-70b5-3ff8-bef7-5de476be9553" \
    --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 #96156577-70b5-3ff8-bef7-5de476be9553 Not found"
}

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

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

Headers

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

URL Parameters

id
uuid
required

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

Example:
ff1e9ff5-36e3-33ec-992b-cac997987cd3
Example request: 
curl --request GET \
    --get "https://ml.demo2.odinn.cloud/api/ml-results/ff1e9ff5-36e3-33ec-992b-cac997987cd3/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.demo2.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.demo2.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.demo2.odinn.cloud/api/ai-model?page=1",
    "from": null,
    "last_page": 1,
    "last_page_url": "https://ml.demo2.odinn.cloud/api/ai-model?page=1",
    "links": [
        {
            "url": null,
            "label": "« Назад",
            "active": false
        },
        {
            "url": "https://ml.demo2.odinn.cloud/api/ai-model?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Вперёд »",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "https://ml.demo2.odinn.cloud/api/ai-model",
    "per_page": 50,
    "prev_page_url": null,
    "to": null,
    "total": 0
}

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

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

Headers

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

URL Parameters

id
uuid
required

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

Example:
a96eab58-ccfd-3ff8-a0ab-69945c60d724
Example request: 
curl --request GET \
    --get "https://ml.demo2.odinn.cloud/api/ai-model/a96eab58-ccfd-3ff8-a0ab-69945c60d724" \
    --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 #a96eab58-ccfd-3ff8-a0ab-69945c60d724 Not found"
}

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

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

Headers

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

URL Parameters

id
uuid
required

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

Example:
25c8cec2-e8fa-380e-ae8f-e2fab7e12374
Example request: 
curl --request GET \
    --get "https://ml.demo2.odinn.cloud/api/ai-model/25c8cec2-e8fa-380e-ae8f-e2fab7e12374/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.demo2.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.demo2.odinn.cloud/api/ai-model" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=inventore"\
    --form "notes=autem"\
    --form "classes[]=iusto"\
    --form "file=@/tmp/phpBQimbi"

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

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

Headers

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

URL Parameters

id
uuid
required

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

Example:
cfa2e218-492c-3bea-888e-1b5c8f09d3b2

Body Parameters

Example request: 
curl --request PUT \
    "https://ml.demo2.odinn.cloud/api/ai-model/cfa2e218-492c-3bea-888e-1b5c8f09d3b2" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=quam"\
    --form "notes=error"\
    --form "classes[]=vel"\
    --form "file=@/tmp/php40xQOF"

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

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

Headers

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

URL Parameters

id
uuid
required

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

Example:
9525f5de-57d7-3dd0-a333-f4a5cba0cdf0
Example request: 
curl --request DELETE \
    "https://ml.demo2.odinn.cloud/api/ai-model/9525f5de-57d7-3dd0-a333-f4a5cba0cdf0" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"