Skip to documentation
Open dashboard
On this page

GET /v1/usage

Read the selected owned resource or current workflow state without starting a new generation.

Request example#

curl 'https://platform.tongai.io/v1/usage' \  -H "Authorization: Bearer $TONG_API_KEY"
Configuration
curl --version

Authentication#

Use a server-side API key for your account, or OAuth for each customer’s account. Never send keys in prompts or tool arguments.

usage:read

Parameters#

fromstringOptional

ISO 8601 date and time, for example 2026-10-22T09:00:00Z.

tostringOptional

ISO 8601 date and time, for example 2026-10-22T09:00:00Z.

channelstringOptional
Allowed values"api""mcp"
credential_idstringOptional

A 24-character hexadecimal ID.

toolstringOptional

Minimum length: 1 characters.

Maximum length: 100 characters.

modelstringOptional

Choose a public Tong model ID from current discovery.

Minimum length: 1 characters.

Maximum length: 150 characters.

categorystringOptional

Minimum length: 1 characters.

Maximum length: 60 characters.

statestringOptional
Allowed values"accepted""running""needs_review""paused""reconciling""succeeded""failed""cancelled"
searchstringOptional

Maximum length: 150 characters.

activitystringOptional
Allowed values"creative""all"
outcomestringOptional
Allowed values"success""error""pending""cancelled"
limitintegerOptional

Minimum: 1.

Maximum: 100.

Default: 40.

Request body#

This endpoint has no request body.

Response schema#

JSON
{}

HTTP 200

application/json
object

Errors and limits#

HTTPErrorRecovery
400Invalid requestREQUEST_INVALIDCorrect the fields identified by the error before trying again.
401Invalid credentialCREDENTIAL_INVALIDCheck the credential, its expiry and whether it has been revoked.
402Insufficient creditsINSUFFICIENT_CREDITSAdd credits to the account that owns the credential, then continue the saved work.
403Permission deniedSCOPE_REQUIREDUse a credential with the required scopes and access to the selected resource.
404Resource unavailableRESOURCE_UNAVAILABLECheck the resource ID and that it belongs to the authorized account.
409Intent conflictIDEMPOTENCY_CONFLICTReuse an intent only with its original request. Use a new UUID for a different action.
429Rate limitedRATE_LIMITEDWait for Retry-After before retrying the same intended request.
503Temporarily unavailableDEPENDENCY_UNAVAILABLEWait for Retry-After and retry with the same intent. Check the saved operation after a timeout.