List batches - ZeroGPU

List batches

curl --request GET \
  --url https://api.zerogpu.ai/v1/batches \
  --header 'x-api-key: <api-key>' \
  --header 'x-project-id: <api-key>'

import requests

url = "https://api.zerogpu.ai/v1/batches"

headers = {
    "x-api-key": "<api-key>",
    "x-project-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<api-key>', 'x-project-id': '<api-key>'}
};

fetch('https://api.zerogpu.ai/v1/batches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zerogpu.ai/v1/batches"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-project-id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zerogpu.ai/v1/batches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-project-id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "batch",
      "endpoint": "<string>",
      "status": "validating",
      "input_file_id": "<string>",
      "output_file_id": "<string>",
      "error_file_id": "<string>",
      "completion_window": "<string>",
      "created_at": 123,
      "expires_at": 123,
      "request_counts": {
        "total": 123,
        "completed": 123,
        "failed": 123
      },
      "metadata": {}
    }
  ],
  "first_id": "<string>",
  "last_id": "<string>",
  "has_more": true
}

GET

/

v1

/

batches

List batches

curl --request GET \
  --url https://api.zerogpu.ai/v1/batches \
  --header 'x-api-key: <api-key>' \
  --header 'x-project-id: <api-key>'

import requests

url = "https://api.zerogpu.ai/v1/batches"

headers = {
    "x-api-key": "<api-key>",
    "x-project-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<api-key>', 'x-project-id': '<api-key>'}
};

fetch('https://api.zerogpu.ai/v1/batches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zerogpu.ai/v1/batches"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-project-id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zerogpu.ai/v1/batches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-project-id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "batch",
      "endpoint": "<string>",
      "status": "validating",
      "input_file_id": "<string>",
      "output_file_id": "<string>",
      "error_file_id": "<string>",
      "completion_window": "<string>",
      "created_at": 123,
      "expires_at": 123,
      "request_counts": {
        "total": 123,
        "completed": 123,
        "failed": 123
      },
      "metadata": {}
    }
  ],
  "first_id": "<string>",
  "last_id": "<string>",
  "has_more": true
}

List batch jobs in your project. Use after with last_id from a previous page to paginate. Full reference: Batches API.

Authorizations

x-api-key

string

header

required

x-project-id

string

header

required

Query Parameters

limit

integer

default:20

Required range: 1 <= x <= 100

after

string

Cursor: last_id from the previous page

Response

Batch list

object

enum<string>

Available options:

list

data

object[]

Hide child attributes

data.id

string

data.object

enum<string>

Available options:

batch

data.endpoint

string

data.status

enum<string>

Available options:

validating,

in_progress,

finalizing,

completed,

failed,

expired,

cancelling,

cancelled

data.input_file_id

string

data.output_file_id

string | null

data.error_file_id

string | null

data.completion_window

string

data.created_at

integer

data.expires_at

integer

data.request_counts

object

Hide child attributes

data.request_counts.total

integer

data.request_counts.completed

integer

data.request_counts.failed

integer

data.metadata

object

first_id

string | null

last_id

string | null

has_more

boolean