Get Usage Detail

Overview

The "Get Usage Detail" API allows you to query account usage details with pagination. At least one of the time range parameters (startTime / endTime) is required (millisecond timestamps).

Request

POST https://api.peperwork.ai/api/account/v2/getUsageDetail

Request body

Name	Type	Mandatory	Description
page	int	false	Page number, default 1
pageSize	int	false	Page size, default 10
startTime	long	true	Start time (millisecond timestamp)
endTime	long	true	End time (millisecond timestamp)
modelId	string	false	Model ID (reserved, not used currently)

Response body

Name	Type	Mandatory	Description
page	int	true	Current page number
pageSize	int	true	Page size
total	long	true	Total record count
data	array	true	Usage detail list
data.fileId	string	true	File ID
data.filePage	int	true	Number of file pages
data.createTime	long	true	Creation time (millisecond timestamp)

Example request

curl -i -X POST https://api.peperwork.ai/api/account/v2/getUsageDetail \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $DOCAI_API_KEY" \
-d '{"page":1,"pageSize":10,"startTime":1672531200000,"endTime":1735689599000}'

Example response

{
    "code": 200,
    "data": {
        "page": 1,
        "pageSize": 10,
        "total": 58,
        "data": [
            {
                "fileId": "2310091711378393918074800",
                "filePage": 3,
                "createTime": 1683797919008
            },
            {
                "fileId": "2310091711378393918074801",
                "filePage": 1,
                "createTime": 1683797920012
            }
        ]
    },
    "requestId": "49bd854af81048358219e57ae3c607a9",
    "currentTimeMillis": 1683797919008
}