Get Request

GET

requests

{requestId}

Get Request

curl --request GET \
  --url https://queue.modelrunner.run/requests/{requestId} \
  --header 'Authorization: <api-key>'

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

fetch('https://queue.modelrunner.run/requests/{requestId}', 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/{requestId}",
  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/{requestId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://queue.modelrunner.run/requests/{requestId}")

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

{
  "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>"
}

{
  "error": "<string>",
  "message": "<string>",
  "statusCode": 123,
  "details": "<unknown>"
}

Authorizations

Authorization

string

header

required

Use the format: Key modelrunner_key

Path Parameters

requestId

string

required

Response

The request.

One inference request as returned by the list/detail/stream surfaces. IMPORTANT: status alone does not signal success — a failed generation is normalized to status: COMPLETED with billingStatus: 'failed'. Always read billingStatus (and error) on these surfaces.

string

modelEndpoint

string

The owner/alias endpoint that served the request (after any provider fallback).

targetKind

enum<string>

What the request ran against. Absent on older cached payloads; treat a missing value as model.

Available options:

model,

wrapper,

deployment

deploymentId

string<uuid> | null

The Serverless GPU deployment this job ran on. Null unless targetKind is deployment.

requestedModelEndpoint

string | null

The endpoint originally requested, when a fallback served it. Null/absent otherwise.

status

enum<string>

Available options:

IN_QUEUE,

IN_PROGRESS,

COMPLETED,

FAILED,

CANCELLED

billingStatus

enum<string>

The success discriminator: 'failed' marks a failed generation even when status is COMPLETED.

Available options:

pending,

partial,

charged,

failed

error

string

Failure detail, when the generation failed.

createdAt

string<date-time>

updatedAt

string<date-time>

inferenceTime

number

delayTime

number

input

any

The stored client input. {} after payload retention removed it — see payloadsPurgedAt.

output

any

The model output. {} after payload retention removed it — see payloadsPurgedAt.

payloadsPurgedAt

string<date-time> | null

Set when input/output are empty because retention removed them, not because the model returned nothing.

totalPrice

string

What this request actually charged, as a decimal string.

public

boolean

Owner-controlled publication state; requests default to private.

metadata

object

The caller-supplied metadata tags from submit time.

Show child attributes

thumbnails

object[]

wrapperId

string | null

baseModelId

string | null

baseModelEndpoint

string | null

user

object

Show child attributes

Get Request

curl --request GET \
  --url https://queue.modelrunner.run/requests/{requestId} \
  --header 'Authorization: <api-key>'

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

fetch('https://queue.modelrunner.run/requests/{requestId}', 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/{requestId}",
  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/{requestId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://queue.modelrunner.run/requests/{requestId}")

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

{
  "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>"
}

{
  "error": "<string>",
  "message": "<string>",
  "statusCode": 123,
  "details": "<unknown>"
}

API documentation

Queue API

Platform APIs

Authorizations

Path Parameters

Response