Account

List usage records

Returns one page of the team's API tasks with the credits each one consumed, newest first by default. Requires an API key belonging to a Studio or Enterprise team. Records cover tasks that have reached a terminal status; with no explicit time range the window is the last 30 days.

get/v1/usage/tasks

Request

  • Base URL: https://api.meshy.ai/openapi
  • URL: https://api.meshy.ai/openapi/v1/usage/tasks
  • Auth: HTTP bearer

Query parameters

page_numinteger

Page number (1-based).

page_sizeinteger

Items per page (max 100).

sort_by'+created_at' | '-created_at'

Sort key; created_at is the only sortable column.

start_timestring date-time

Start of the created_at window, RFC 3339. Defaults to 30 days before end_time. The window may span at most 1 year.

end_timestring date-time

End of the created_at window, RFC 3339. Defaults to the current time.

endpointsstring

Comma-separated endpoint names to include, using the same values the endpoint response field carries (e.g. image-to-3d,animate). Omit to include every endpoint; an unknown name is rejected with 400.

status'SUCCEEDED' | 'FAILED'

Filter by terminal task status. Omit to include both.

Response

A page of usage records, newest first by default.

task_idstring uuid required

ID of the task this record bills.

endpointstring required

The endpoint the task ran on, e.g. image-to-3d. Text to 3D tasks report their phase.

status'SUCCEEDED' | 'FAILED' required

Terminal task status.

created_atinteger required

Task creation time, in unix milliseconds.

finished_atinteger nullable required

Completion time in unix milliseconds; null when the task carries no completion time.

consumed_creditsinteger required

Credits consumed by this task. 0 for FAILED tasks (credits are refunded on failure).

api_key_namestring required

Display name of the API key that ran the task.

api_key_suffixstring required

Last four characters of that API key.

Changes

No recorded changes to this operation across all 1 revision of this API.