Skip to main content

WorkloadsBillingResponseSchema

Schema representing the response from the workloads billing endpoint.

next_datetimestring<date-time>required

End of the time window, use as start_datetime for next poll (ISO 8601 format)

start_datetimestring<date-time>required

Start of the time window for which usage data is returned (ISO 8601 format)

workloads object[]required

List of workload usage records within the specified time window.

  • Array [
  • current_statusWorkloadStatusrequired

    Current status of the workload.

    Possible values: [pending, running, cancelled, completed, failed, insufficient_credits]

    gpu_countintegerrequired

    Number of GPUs used for the workload.

    Possible values: >= 0

    gpu_typestringrequired

    Type of GPU used for the workload.

    Min length: 1 character (non-empty)

    hyperstack_org_idintegerrequired

    Unique identifier of the Hyperstack organization.

    Possible values: > 0

    status_transitions object[]required

    List of status transitions within the time window.

  • Array [
  • destination_statusWorkloadStatusrequired

    The status the workload transitioned to.

    Possible values: [pending, running, cancelled, completed, failed, insufficient_credits]

    transition_datetimestring<date-time>required

    The timestamp when the transition occurred (ISO 8601 format)

  • ]
  • time_deltas_in_minutes_per_status objectrequired

    Time spent in each status in minutes (can be negative for refunds)

    property name*integer
    workload_display_namestringrequired

    Human-readable display name for the workload.

    workload_idintegerrequired

    Unique identifier of the workload (Pod ID)

    Possible values: > 0

    workload_typestringrequired

    Type of workload (currently only 'fine-tuning')

    Possible values: [fine-tuning]

  • ]
  • WorkloadsBillingResponseSchema
    {
    "next_datetime": "2024-07-29T15:51:28.071Z",
    "start_datetime": "2024-07-29T15:51:28.071Z",
    "workloads": [
    {
    "current_status": "pending",
    "gpu_count": 0,
    "gpu_type": "string",
    "hyperstack_org_id": 0,
    "status_transitions": [
    {
    "destination_status": "pending",
    "transition_datetime": "2024-07-29T15:51:28.071Z"
    }
    ],
    "time_deltas_in_minutes_per_status": {},
    "workload_display_name": "string",
    "workload_id": 0,
    "workload_type": "fine-tuning"
    }
    ]
    }