Queue API
List Requests
The authenticated account’s requests, newest first. Filter by endpoint, deployment, status, or the metadata tags set at submit time (metadata is a URL-encoded JSON object of exact key/value matches, AND-combined). NOTE: read billingStatus, not status, to tell success from failure — a failed generation is COMPLETED + billingStatus: 'failed'.
GET
/
requests
List Requests
curl --request GET \
--url https://queue.modelrunner.run/requests \
--header 'Authorization: <api-key>'import requests
url = "https://queue.modelrunner.run/requests"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://queue.modelrunner.run/requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://queue.modelrunner.run/requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://queue.modelrunner.run/requests"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://queue.modelrunner.run/requests")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://queue.modelrunner.run/requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"page": 123,
"limit": 123,
"total": 123,
"totalPages": 123,
"data": [
{
"id": "<string>",
"modelEndpoint": "<string>",
"targetKind": "model",
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestedModelEndpoint": "<string>",
"status": "IN_QUEUE",
"billingStatus": "pending",
"error": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"inferenceTime": 123,
"delayTime": 123,
"input": "<unknown>",
"output": "<unknown>",
"payloadsPurgedAt": "2023-11-07T05:31:56Z",
"totalPrice": "<string>",
"public": true,
"metadata": {},
"thumbnails": [
{}
],
"wrapperId": "<string>",
"baseModelId": "<string>",
"baseModelEndpoint": "<string>",
"user": {
"id": "<string>"
}
}
]
}{
"error": "<string>",
"message": "<string>",
"statusCode": 123,
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"statusCode": 123,
"details": "<unknown>"
}Authorizations
Use the format: Key modelrunner_key
Query Parameters
ownerName/alias of a model or wrapper.
Narrow to the jobs run on one Serverless GPU deployment.
Available options:
IN_QUEUE, IN_PROGRESS, COMPLETED, FAILED, CANCELLED URL-encoded JSON object, e.g. %7B%22batch%22%3A%22a1%22%7D for {"batch":"a1"}.
⌘I
List Requests
curl --request GET \
--url https://queue.modelrunner.run/requests \
--header 'Authorization: <api-key>'import requests
url = "https://queue.modelrunner.run/requests"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://queue.modelrunner.run/requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://queue.modelrunner.run/requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://queue.modelrunner.run/requests"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://queue.modelrunner.run/requests")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://queue.modelrunner.run/requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"page": 123,
"limit": 123,
"total": 123,
"totalPages": 123,
"data": [
{
"id": "<string>",
"modelEndpoint": "<string>",
"targetKind": "model",
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestedModelEndpoint": "<string>",
"status": "IN_QUEUE",
"billingStatus": "pending",
"error": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"inferenceTime": 123,
"delayTime": 123,
"input": "<unknown>",
"output": "<unknown>",
"payloadsPurgedAt": "2023-11-07T05:31:56Z",
"totalPrice": "<string>",
"public": true,
"metadata": {},
"thumbnails": [
{}
],
"wrapperId": "<string>",
"baseModelId": "<string>",
"baseModelEndpoint": "<string>",
"user": {
"id": "<string>"
}
}
]
}{
"error": "<string>",
"message": "<string>",
"statusCode": 123,
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"statusCode": 123,
"details": "<unknown>"
}
