Fetch Queued Images Endpoint

Overview

Fetch Queued Images API fetches queued images.

Usually more complex image generation requests take more time for processing. Such requests are being queued for processing and the output images are retrievable after some time. The estimated processing time is specified by the eta parameter in the response returned upon the request execution.

Request

--request POST 'https://modelslab.com/api/v6/images/fetch' \

Send a POST request to https://modelslab.com/api/v6/images/fetch endpoint to return the corresponding queued images, specified by the request_id parameter in the request body.

This endpoint does not generate new images, it returns already generated/queued images.

Attributes

Parameter	Description
key	Your API Key used for request authorization
request_id	Returned by the id parameter in the response upon an image generation request.

Example

Body

Body Raw

{
 "key": "",
 "request_id": "your_request_id"
}

Request

JS

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
 "key": "",
 "request_id": "your_request_id"
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://modelslab.com/api/v6/images/fetch", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

PHP

<?php

$payload = [
  "key" => "",
  "request_id" => "your_request_id"
];

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://modelslab.com/api/v6/images/fetch',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>  json_encode($payload),
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

NODE

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://modelslab.com/api/v6/images/fetch',
  'headers': {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "key": "",
    "request_id": "your_request_id"
  })
};

request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

PYTHON

import requests
import json

url = "https://modelslab.com/api/v6/images/fetch"

payload = json.dumps({
 "key": "",
 "request_id": "your_request_id"
})

headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

JAVA

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"key\": \"\",\n  \"request_id\": \"your_request_id\"\n}");
Request request = new Request.Builder()
  .url("https://modelslab.com/api/v6/images/fetch")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

Response

Example Response

{
  "status": "success",
  "id": 13443927,
  "output": [
    "https://pub-8b49af329fae499aa563997f5d4068a4.r2.dev/generations/6ef3f81f-14e1-4835-b07a-e00dbe80b6ff-0.png"
  ]
}