Start here
The work each model is shown with
/v1/catalogue/showcaseson https://api.auray.ai/v1Takes no key and charges nothing, for the reason /catalogue does: the marketing page reads it before anybody has an account.
Takes no key and charges nothing, for the reason /catalogue does: the marketing page reads it before anybody has an account. For every published address that one of our team's works was made with, the work it is shown with — published, approved and listed on the Community, by an author the Community shows — the one we picked for that model while it still qualifies, else chosen in this order: featured, then one with a still (a song: with a waveform), then one not made from another work, then the textured tier of a 3D model, then a landscape still before a square one before a portrait, then the first published. A work withdrawn, unlisted or taken down leaves this map within a few minutes. An address with no work of ours is simply absent: draw the maker's mark there. Keyed by each address as this reference prints it, never by another name. Answered with a weak ETag over the works alone; send it back in If-None-Match and an unchanged map is answered 304 with no body. When the works cannot be read this answers 200 with source: "fallback", an empty showcases and as_of: null rather than an error, sent with no-store and stored nowhere. Cached at the edge for sixty seconds with two minutes of stale service.
#Authentication
No key needed — this document is public.
#Request
#Headers
| Name | Type | Required | Description |
|---|---|---|---|
If-None-Match | string | no | The ETag of a map you hold. When it is still current the answer is 304 with no body. |
#Example request
curl https://api.auray.ai/v1/catalogue/showcasesconst res = await fetch("https://api.auray.ai/v1/catalogue/showcases", {
method: "GET",
});
console.log(await res.json());import requests
r = requests.get(
"https://api.auray.ai/v1/catalogue/showcases",
)
r.raise_for_status()
print(r.json())package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.auray.ai/v1/catalogue/showcases", nil)
if err != nil {
panic(err)
}
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.Status, string(out))
}<?php
$ch = curl_init("https://api.auray.ai/v1/catalogue/showcases");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response, PHP_EOL;require "net/http"
uri = URI("https://api.auray.ai/v1/catalogue/showcases")
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.code, res.bodyimport java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.auray.ai/v1/catalogue/showcases"))
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.auray.ai/v1/catalogue/showcases");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");#Responses
#200 OK
OK. Every showcase, by address, and when they were read.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
object | string | yes | — | One of "showcases". |
source | string | yes | — | fallback when the works could not be read: showcases is then empty and as_of null. One of "live", "fallback". |
showcases | object | yes | — | One work per published address that has one, keyed by the address as this reference prints it. |
as_of | string | yes | — | When the works were read; null on fallback. May be null. |
request_id | string | yes | — |
Headers:
| Header | Description |
|---|---|
Cache-Control | public, s-maxage=60, stale-while-revalidate=120 when the works were read; no-store on fallback. |
ETag | A weak validator of showcases (W/"…"). Absent on fallback. |
X-Request-Id |
#304 Not Modified
Not modified: the map the If-None-Match named is current. No body.
#Status codes
| Status | Meaning |
|---|---|
200 | OK. Every showcase, by address, and when they were read. |
304 | Not modified: the map the If-None-Match named is current. |
Every refusal names its code, and every code is explained at Errors.