Usage API
Переглядайте список завершених API-завдань вашої команди та кількість кредитів, витрачених на кожне з них, для експорту даних виставлення рахунків і звітів про витрати.
Щоб викликати цю кінцеву точку, використовуйте API-ключ активного учасника команди Studio або Enterprise. Викликати її може будь-який учасник, а не лише власники та адміністратори. З будь-яким іншим API-ключем запит поверне 403.
Список записів про використання
Повертає одну сторінку записів про використання вашої команди, за замовчуванням спочатку найновіші. Без start_time і end_time записи охоплюють останні 30 днів. Виклик цієї кінцевої точки безкоштовний.
Записи включають такі завдання:
- API-завдання, що завершилися зі статусом
SUCCEEDEDабоFAILED - Завдання всіх поточних учасників команди, з будь-якого з їхніх API-ключів
- Завдання, які ви видалили, і завдання, файли яких застаріли
Записи не включають такі завдання:
- Завдання, що досі мають статус
PENDINGабоIN_PROGRESS, а також завдання зі статусомCANCELED - Завдання людей, які покинули команду
- Завдання Creative Lab
- Завдання, виконані AI-агентами Meshy
- Роботу, виконану у веб-застосунку Meshy
Завдання з'являється в записах лише після завершення, у вікні свого created_at. Meshy списує кредити під час створення завдання, тому завдання, яке ще виконується, відсутнє в записах. Перш ніж звіряти записи з балансом кредитів, повторно отримайте дані за останні періоди або зробіть експорт із невеликою затримкою.
Якщо у вашої команди є період зберігання даних, вікно не може починатися раніше, ніж це дозволяє цей період.
Request
curl "https://api.meshy.ai/openapi/v1/usage/tasks?page_size=50&start_time=2026-08-01T00:00:00Z&end_time=2026-09-01T00:00:00Z" \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"endpoint": "image-to-3d",
"status": "SUCCEEDED",
"created_at": 1755787000000,
"finished_at": 1755787045000,
"consumed_credits": 20,
"api_key_name": "production",
"api_key_suffix": "a1b2",
"metadata": {
"user": "alex@example.com",
"team": "fab"
}
},
{
"task_id": "018a210d-1c22-7e0f-9d3a-4a5b6c7d8e9f",
"endpoint": "text-to-3d-refine",
"status": "FAILED",
"created_at": 1755786000000,
"finished_at": 1755786030000,
"consumed_credits": 0,
"api_key_name": "production",
"api_key_suffix": "a1b2",
"metadata": {}
}
]
Параметри
- Name
- page_num
- Type
- integer
- за замовчуванням 1
- Description
Сторінка, яку потрібно повернути, від
1до255. Значення більше за255поверне400. Одне вікно вміщує не більше 255 сторінок, тому розбивайте великий експорт на коротші вікна.
- Name
- page_size
- Type
- integer
- за замовчуванням 10
- Description
Кількість записів на сторінці, від
1до100. Значення від101до255поверне 100 записів, а значення більше за255поверне400.
- Name
- sort_by
- Type
- string
- за замовчуванням -created_at
- Description
Порядок сортування.
Доступні значення:
+created_at: спочатку найстаріші-created_at: спочатку найновіші
В URL пишіть
+як%2B. Інакше+буде прочитано як пробіл, і запит поверне400.
- Name
- start_time
- Type
- string
- Description
Початок вікна, у форматі мітки часу RFC 3339, наприклад
2026-08-01T00:00:00Z. Записи включають завдання, створені в цей час або пізніше. Якщо не вказати, вікно почнеться за 30 днів доend_time.Вікно може охоплювати щонайбільше 366 днів. Довше вікно поверне
400, тому розбивайте довший експорт на кілька вікон.
- Name
- end_time
- Type
- string
- Description
Кінець вікна, у форматі мітки часу RFC 3339. Записи включають завдання, створені до цього часу. Якщо не вказати, вікно закінчиться на момент вашого запиту.
- Name
- endpoints
- Type
- string
- Description
Список кінцевих точок через кому, за тими самими назвами, що й поле
endpoint. Якщо не вказати, будуть включені всі кінцеві точки. Невідома назва поверне400.Доступні значення:
text-to-3d: усі завдання Текст у 3D, preview і refinetext-to-3d-preview: лише завдання previewtext-to-3d-refine: лише завдання refineimage-to-3dmulti-image-to-3dretextureremeshconvertresizeuv-unwrapriganimatetext-to-motiontext-to-imageimage-to-imageprint-multi-colorprint-repairprint-analyzeprint-splitrelief
- Name
- status
- Type
- string
- Description
Статус, який потрібно включити,
SUCCEEDEDабоFAILED. Якщо не вказати, будуть включені обидва. Будь-яке інше значення поверне400.
Повертає
Повертає масив записів про використання. Масив порожній, якщо немає відповідних записів.
Режими відмови
- Name
400 - Bad Request- Description
Параметр недійсний, і повідомлення про помилку вказує, який саме. Виправте параметр і надішліть запит знову.
- Name
401 - Unauthorized- Description
API-ключ відсутній або недійсний. Перевірте заголовок
Authorization.
- Name
403 - Forbidden- Description
Обліковий запис API-ключа не є активним учасником команди Studio або Enterprise. Повідомлення:
This endpoint is available on Studio and Enterprise plans. Використовуйте API-ключ учасника команди Studio або Enterprise.
- Name
429 - Too Many Requests- Description
Ви надіслали забагато запитів. Зачекайте кількість секунд, вказану в
Retry-After, потім повторіть спробу.
Об'єкт запису про використання
Example usage record object
{
"task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"endpoint": "image-to-3d",
"status": "SUCCEEDED",
"created_at": 1755787000000,
"finished_at": 1755787045000,
"consumed_credits": 20,
"api_key_name": "production",
"api_key_suffix": "a1b2",
"metadata": {
"user": "alex@example.com",
"team": "fab"
}
}
- Name
- task_id
- Type
- string
- Description
Ідентифікатор завдання, той самий ID, що повернула кінцева точка створення. Щоб отримати саме завдання з URL-адресами результату, надішліть цей ID на маршрут отримання відповідної кінцевої точки, наприклад
GET /openapi/v1/image-to-3d/{task_id}для записуimage-to-3d.
- Name
- endpoint
- Type
- string
- Description
Кінцева точка, на якій виконувалося завдання, наприклад
image-to-3dабоrig. Завдання Текст у 3D показує свій етап:text-to-3d-previewабоtext-to-3d-refine.Старіші записи можуть мати назви застарілих кінцевих точок, які фільтр
endpointsне приймає.
- Name
- status
- Type
- string
- Description
Кінцевий статус завдання,
SUCCEEDEDабоFAILED.
- Name
- created_at
- Type
- timestamp
- Description
Час створення завдання, у мілісекундах Unix.
- Name
- finished_at
- Type
- timestamp
- Description
Час завершення завдання, у мілісекундах Unix.
null, якщо завдання не має часу завершення.
- Name
- consumed_credits
- Type
- integer
- Description
Кількість кредитів, витрачених на завдання, після повернень.
0для невдалого завдання, оскільки Meshy повертає кредити, а також для безкоштовного завдання, наприклад Аналіз придатності до друку.
- Name
- api_key_name
- Type
- string
- Description
Назва API-ключа, яким було виконано завдання. Для завдання, виконаного через вхід у застосунок, це назва застосунку, наприклад
Meshy CLI.У деяких випадках це порожній рядок, наприклад:
- За завдання ніколи не стягувалася плата, наприклад за завдання Аналіз придатності до друку, яке безкоштовне.
- API-ключ було видалено.
- API-ключ було створено протягом останніх кількох хвилин.
- Name
- api_key_suffix
- Type
- string
- Description
Останні чотири символи цього API-ключа, щоб відрізняти ключі з однаковою назвою. Порожній рядок, коли
api_key_nameпорожній, а також для входів через застосунки, наприклад Meshy CLI.
- Name
- metadata
- Type
- object
- Description
Теги, надіслані в заголовку
X-Meshy-Metadataпід час створення завдання.{}, якщо їх немає. Див. Метадані.