List Images

Send a GET request to this endpoint to retrieve a list of generated images.

ℹ️

You will need to authenticate to use this API. See authentication.

Request


GET https://api.ojo.so/v1/image

Query Parameters

Parameter	Type	Description
page	number	(Optional) Page number for pagination (default: 1)
pageSize	number	(Optional) Number of items per page (default: 10)
sort	string	(Optional) Sort order: ‘asc’ or ‘desc’ (default: ‘desc’)

cURL


curl --request GET \
  --url 'https://api.ojo.so/v1/image?page=1&pageSize=10&sort=desc' \
  --header 'Authorization: Bearer <API Key>'

Python


import requests
 
url = "https://api.ojo.so/v1/image"
 
querystring = {"page":"1","pageSize":"10","sort":"desc"}
 
headers = {
"Authorization": "Bearer <API Key>"
}
 
response = requests.request("GET", url, headers=headers, params=querystring)
 
print(response.text)

JavaScript


const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <API Key>'
  }
};
 
fetch('https://api.ojo.so/v1/image?page=1&pageSize=10&sort=desc', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

PHP


<?php
 
$curl = curl_init();
 
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ojo.so/v1/image?page=1&pageSize=10&sort=desc",
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: Bearer <API Key>"
],
]);
 
$response = curl_exec($curl);
$err = curl_error($curl);
 
curl_close($curl);
 
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}

Go


package main
 
import (
  "fmt"
  "net/http"
  "io/ioutil"
)
 
func main() {
  url := "https://api.ojo.so/v1/image?page=1&pageSize=10&sort=desc"
 
  req, _ := http.NewRequest("GET", url, nil)
 
  req.Header.Add("Authorization", "Bearer <API Key>")
 
  res, _ := http.DefaultClient.Do(req)
 
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)
 
  fmt.Println(string(body))
}

Java


HttpResponse<String> response = Unirest.get("https://api.ojo.so/v1/image?page=1&pageSize=10&sort=desc")
  .header("Authorization", "Bearer <API Key>")
  .asString();

Response

200

Successfully retrieved the list of images.


{
  "items": [
    {
      "id": "image-id-1",
      "imageUrl": "https://example.com/path/to/image1.png",
      "createdAt": "2023-08-29T12:34:56Z"
    },
    {
      "id": "image-id-2",
      "imageUrl": "https://example.com/path/to/image2.png",
      "createdAt": "2023-08-28T10:11:12Z"
    }
  ],
  "totalItems": 48,
  "totalPages": 5,
  "currentPage": 1,
  "pageSize": 10
}

401

Your API key might be invalid or expired.


{
  "error": true,
  "message": "Unauthorized"
}

429

You have hit your rate limit. You can view rate limit details here.


Too Many Requests

500

An unexpected error occurred. Try again later. If the issue persists, please reach out.


{
  "error": true,
  "message": "Internal server error"
}