Usage API

Usage API returnerar ditt teams historiska API-uppgifter tillsammans med de credits varje uppgift förbrukade. Filtrera efter tidsfönster, 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-svar.

GET/openapi/v1/usage/tasks

List Usage Records

Returnerar en sida av teamets API-uppgifter, nyaste först. Utan ett explicit tidsintervall täcker 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 för created_at-fönstret, som en RFC 3339-tidsstämpel (t.ex. 2026-08-01T00:00:00Z). Standardvärdet är 30 dagar före end_time. Fönstret kan omfatta högst 1 år — för större exporter, bläddra igenom på varandra följande fönster.
Name
end_time
Type
string
Description
Slut för created_at-fönstret, 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 svarsfältet endpoint 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, print-split — där text-to-3d är ett samlingsbegrepp som täcker både preview- och refine-fasen. Utelämna för att inkludera varje endpoint.
Name
status
Type
string
Description
Filtrera efter slutgiltig uppgiftsstatus: SUCCEEDED eller FAILED. Utelämna för att inkludera båda.

Returnerar

Returnerar en paginerad lista med Usage Record-objekt.

Poster täcker uppgifter som har nått en slutgiltig status. Credits debiteras när en uppgift skapas, så en uppgift som fortfarande körs när du exporterar finns ännu inte med i det fönstrets resultat — hämta om nyligen tillagda fönster (eller exportera med en kort fördröjning) om dina totaler måste stämma exakt mot ditt credit-saldo.

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 den uppgift denna post fakturerar — samma ID som den skapande endpointen returnerade. För att hämta själva uppgiften (inklusive dess utmodell eller bild-URL:er, omsignerade vid varje läsning), skicka den till motsvarande hämt-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
Slutgiltig uppgiftsstatus: 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 inte har en slutförandetid.
Name
consumed_credits
Type
integer
Description
Credits förbrukade av denna uppgift. Returnerar 0 för FAILED-uppgifter (credits återbetalas vid misslyckande).
Name
api_key_name
Type
string
Description
Visningsnamn för API-nyckeln som körde uppgiften. Förblir ifylld för återkallade nycklar, så historiska utgifter kan fortfarande spåras efter nyckelrotation.
Name
api_key_suffix
Type
string
Description
De sista fyra tecknen i den API-nyckeln, för att skilja nycklar med samma namn åt.

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