API Reference
Get Request Result
Retrieve the final output and metadata for a completed request.
GET
/
{ownerName}
/
{modelName}
/
requests
/
{requestId}
Get Request Result
curl --request GET \
--url https://queue.modelrunner.run/{ownerName}/{modelName}/requests/{requestId} \
--header 'Authorization: <api-key>'import requests
url = "https://queue.modelrunner.run/{ownerName}/{modelName}/requests/{requestId}"
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/{ownerName}/{modelName}/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/{ownerName}/{modelName}/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/{ownerName}/{modelName}/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))
}HttpResponse<String> response = Unirest.get("https://queue.modelrunner.run/{ownerName}/{modelName}/requests/{requestId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://queue.modelrunner.run/{ownerName}/{modelName}/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>",
"output": "<unknown>",
"input": "<unknown>",
"createdAt": "2023-11-07T05:31:56Z",
"inferenceTime": 123,
"delayTime": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"logs": "<string>",
"error": "<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>"
}{
"error": "<string>",
"message": "<string>",
"statusCode": 123,
"details": "<unknown>"
}Authorizations
Use the format: Key modelrunner_key
Path Parameters
Model owner or organization name.
Model alias on ModelRunner.
The request identifier returned by Create Request.
Required string length:
21Response
Completed result
Required string length:
21Available options:
IN_QUEUE, IN_PROGRESS, COMPLETED, FAILED, CANCELLED ⌘I
Get Request Result
curl --request GET \
--url https://queue.modelrunner.run/{ownerName}/{modelName}/requests/{requestId} \
--header 'Authorization: <api-key>'import requests
url = "https://queue.modelrunner.run/{ownerName}/{modelName}/requests/{requestId}"
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/{ownerName}/{modelName}/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/{ownerName}/{modelName}/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/{ownerName}/{modelName}/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))
}HttpResponse<String> response = Unirest.get("https://queue.modelrunner.run/{ownerName}/{modelName}/requests/{requestId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://queue.modelrunner.run/{ownerName}/{modelName}/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>",
"output": "<unknown>",
"input": "<unknown>",
"createdAt": "2023-11-07T05:31:56Z",
"inferenceTime": 123,
"delayTime": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"logs": "<string>",
"error": "<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>"
}{
"error": "<string>",
"message": "<string>",
"statusCode": 123,
"details": "<unknown>"
}
