Usage API

Usage API returnerar ditt teams historiska API-uppgifter tillsammans med hur många credits var och en förbrukade. Filtrera efter tidsintervall, endpoint eller status, och bläddra igenom resultaten för att exportera i bulk.

Tillgänglighet. API-nyckeln måste tillhöra ett Studio- eller Enterprise-team; nycklar på någon annan plan, eller utan team, får ett 403.

GET/openapi/v1/usage/tasks

List Usage Records

Returnerar en sida av teamets API-uppgifter, nyaste först. Utan ett explicit tidsintervall omfattar svaret de senaste 30 dagarna.

Parametrar

Name
page_num
Type
integer
standard 1
Description
Sidnummer för paginering.
Name
page_size
Type
integer
standard 10
Description
Gräns för sidstorlek. Maximalt tillåtet är 100 objekt.
Name
sort_by
Type
string
standard -created_at
Description
Fält att sortera efter.
Tillgängliga värden:
- +created_at: Sortera efter skapandetid i stigande ordning.
- -created_at: Sortera efter skapandetid i fallande ordning.
Name
start_time
Type
string
Description
Start på created_at-intervallet, som en RFC 3339-tidsstämpel (t.ex. 2026-08-01T00:00:00Z). Standardvärdet är 30 dagar före end_time. Intervallet kan omfatta högst 1 år — för större exporter, bläddra igenom på varandra följande intervall.
Name
end_time
Type
string
Description
Slut på created_at-intervallet, som en RFC 3339-tidsstämpel. Standardvärdet är den aktuella tiden.
Name
endpoints
Type
string
Description
Kommaseparerad lista med endpoint-namn att inkludera. Accepterar samma värden som fältet endpoint i svaret innehåller — text-to-3d, text-to-3d-preview, text-to-3d-refine, image-to-3d, multi-image-to-3d, retexture, remesh, convert, resize, uv-unwrap, rig, animate, text-to-motion, text-to-image, image-to-image, print-multi-color, print-repair, print-analyze — där text-to-3d är ett övergripande begrepp som täcker både preview- och refine-faserna. Utelämna för att inkludera alla endpoints.
Name
status
Type
string
Description
Filtrera efter uppgiftens sluttillstånd: SUCCEEDED eller FAILED. Utelämna för att inkludera båda.

Returer

Returnerar en paginerad lista med The Usage Record Objects.

Poster omfattar uppgifter som har nått ett sluttillstånd. Credits debiteras när en uppgift skapas, så en uppgift som fortfarande körs när du exporterar finns ännu inte med i det tidsintervallets resultat — hämta om nyligen genomförda intervall (eller exportera med en kort fördröjning) om dina summor måste stämma exakt med ditt saldo av credits.

Team med en anpassad policy för datalagring får poster inom sitt konfigurerade lagringsfönster.

Request

GET

/openapi/v1/usage/tasks

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"
  },
  {
    "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"
  }
]

The Usage Record Object

Name
task_id
Type
string
Description
ID för uppgiften som denna post fakturerar — samma ID som den skapande endpointen returnerade. För att hämta själva uppgiften (inklusive dess utdatamodell eller bild-URL:er, omsignerade vid varje läsning), skicka det till motsvarande hämtnings-endpoint, t.ex. GET /openapi/v1/{endpoint}/{task_id}.
Name
endpoint
Type
string
Description
Endpointen som uppgiften kördes på, t.ex. image-to-3d eller text-to-3d-refine. Text till 3D-uppgifter rapporterar sin fas (text-to-3d-preview / text-to-3d-refine).
Name
status
Type
string
Description
Uppgiftens sluttillstånd: SUCCEEDED eller FAILED.
Name
created_at
Type
timestamp
Description
Tidsstämpel för när uppgiften skapades, i millisekunder.
Name
finished_at
Type
timestamp
Description
Tidsstämpel för slutförande, i millisekunder. null om uppgiften saknar en slutförandetid.
Name
consumed_credits
Type
integer
Description
Credits förbrukade av denna uppgift. Returnerar 0 för FAILED-uppgifter (credits återbetalas vid fel).
Name
api_key_name
Type
string
Description
Visningsnamn för API-nyckeln som körde uppgiften. Förblir ifylld för återkallade nycklar, så att historiska utgifter förblir spårbara efter nyckelrotation.
Name
api_key_suffix
Type
string
Description
De sista fyra tecknen i den API-nyckeln, för att skilja åt nycklar med samma namn.

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"
}