zg8qqc21.nx.link

{
  "parameters": [
    {
      "description": "Accept header to specify the response format",
      "in": "header",
      "name": "Accept",
      "schema": {
        "example": "application/json, text/csv",
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "currency",
      "required": false,
      "schema": {
        "description": "Filter by currency",
        "enum": [
          "USD",
          "VCU",
          "DIEM"
        ],
        "example": "USD",
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "endDate",
      "required": false,
      "schema": {
        "description": "End date for filtering records (ISO 8601)",
        "example": "2024-12-31T23:59:59Z",
        "format": "date-time",
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "limit",
      "required": false,
      "schema": {
        "default": 200,
        "description": "Number of items per page",
        "example": 200,
        "exclusiveMinimum": true,
        "maximum": 500,
        "minimum": 0,
        "type": "integer"
      }
    },
    {
      "in": "query",
      "name": "page",
      "required": false,
      "schema": {
        "default": 1,
        "description": "Page number for pagination",
        "example": 1,
        "exclusiveMinimum": true,
        "minimum": 0,
        "type": "integer"
      }
    },
    {
      "in": "query",
      "name": "sortOrder",
      "required": false,
      "schema": {
        "default": "desc",
        "description": "Sort order for createdAt field",
        "enum": [
          "asc",
          "desc"
        ],
        "example": "desc",
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "startDate",
      "required": false,
      "schema": {
        "description": "Start date for filtering records (ISO 8601)",
        "example": "2024-01-01T00:00:00Z",
        "format": "date-time",
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "additionalProperties": false,
            "description": "The response schema for the billing usage endpoint",
            "example": {
              "data": [
                {
                  "amount": -0.1,
                  "currency": "DIEM",
                  "inferenceDetails": null,
                  "notes": "API Inference",
                  "pricePerUnitUsd": 0.1,
                  "sku": "venice-sd35-image-unit",
                  "timestamp": {},
                  "units": 1
                },
                {
                  "amount": -0.06356,
                  "currency": "DIEM",
                  "inferenceDetails": {
                    "completionTokens": 227,
                    "inferenceExecutionTime": 2964,
                    "promptTokens": 339,
                    "requestId": "chatcmpl-4007fd29f42b7d3c4107f4345e8d174a"
                  },
                  "notes": "API Inference",
                  "pricePerUnitUsd": 2.8,
                  "sku": "llama-3.3-70b-llm-output-mtoken",
                  "timestamp": {},
                  "units": 0.000227
                }
              ],
              "pagination": {
                "limit": 1,
                "page": 200,
                "total": 56090,
                "totalPages": 56090
              }
            },
            "properties": {
              "data": {
                "items": {
                  "properties": {
                    "amount": {
                      "description": "The total amount charged for the billing usage entry",
                      "type": "number"
                    },
                    "currency": {
                      "description": "The currency charged for the billing usage entry",
                      "enum": [
                        "USD",
                        "VCU",
                        "DIEM"
                      ],
                      "example": "USD",
                      "type": "string"
                    },
                    "inferenceDetails": {
                      "description": "Details about the related inference request, if applicable",
                      "nullable": true,
                      "properties": {
                        "completionTokens": {
                          "description": "Number of tokens used in the completion. Only present for LLM usage.",
                          "nullable": true,
                          "type": "number"
                        },
                        "inferenceExecutionTime": {
                          "description": "Time taken for inference execution in milliseconds",
                          "nullable": true,
                          "type": "number"
                        },
                        "promptTokens": {
                          "description": "Number of tokens requested in the prompt. Only present for LLM usage.",
                          "nullable": true,
                          "type": "number"
                        },
                        "requestId": {
                          "description": "Unique identifier for the inference request",
                          "nullable": true,
                          "type": "string"
                        }
                      },
                      "required": [
                        "completionTokens",
                        "inferenceExecutionTime",
                        "promptTokens",
                        "requestId"
                      ],
                      "type": "object"
                    },
                    "notes": {
                      "description": "Notes about the billing usage entry",
                      "type": "string"
                    },
                    "pricePerUnitUsd": {
                      "description": "The price per unit in USD",
                      "type": "number"
                    },
                    "sku": {
                      "description": "The product associated with the billing usage entry",
                      "type": "string"
                    },
                    "timestamp": {
                      "description": "The timestamp the billing usage entry was created",
                      "example": "2025-01-01T00:00:00Z",
                      "type": "string"
                    },
                    "units": {
                      "description": "The number of units consumed",
                      "type": "number"
                    }
                  },
                  "required": [
                    "amount",
                    "currency",
                    "inferenceDetails",
                    "notes",
                    "pricePerUnitUsd",
                    "sku",
                    "timestamp",
                    "units"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "pagination": {
                "properties": {
                  "limit": {
                    "type": "number"
                  },
                  "page": {
                    "type": "number"
                  },
                  "total": {
                    "type": "number"
                  },
                  "totalPages": {
                    "type": "number"
                  }
                },
                "required": [
                  "limit",
                  "page",
                  "total",
                  "totalPages"
                ],
                "type": "object"
              },
              "warningMessage": {
                "description": "A warning message to disambiguate DIEM usage from legacy DIEM (formerly VCU) usage",
                "type": "string"
              }
            },
            "required": [
              "data",
              "pagination"
            ],
            "type": "object"
          }
        },
        "text/csv": {
          "schema": {
            "description": "CSV formatted billing usage data",
            "type": "string"
          }
        }
      },
      "description": "Successful response",
      "headers": {
        "Content-Disposition": {
          "schema": {
            "description": "attachment; filename=billing_usage.csv",
            "example": "attachment; filename=billing_usage.csv",
            "type": "string"
          }
        },
        "x-pagination-limit": {
          "schema": {
            "description": "Number of items per page",
            "example": 200,
            "type": "number"
          }
        },
        "x-pagination-page": {
          "schema": {
            "description": "Current page number",
            "example": 1,
            "type": "number"
          }
        },
        "x-pagination-total": {
          "schema": {
            "description": "Total number of items",
            "example": 1000,
            "type": "number"
          }
        },
        "x-pagination-total-pages": {
          "schema": {
            "description": "Total number of pages",
            "example": 5,
            "type": "number"
          }
        }
      }
    },
    "400": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/DetailedError"
          }
        }
      },
      "description": "Invalid request parameters"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/StandardError"
          }
        }
      },
      "description": "Authentication failed"
    },
    "500": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/StandardError"
          }
        }
      },
      "description": "Inference processing failed"
    }
  }
}