Start here
Change a work
/v1/community/publications/{id}on https://api.auray.ai/v1Change a published work of yours.
Change a published work of yours. New words pass the automatic check and send the work back to our team for review; show_prompt: false hides its prompt and settings for good (a hidden prompt is deleted, so it cannot be shown again); discoverable lets it into or out of the public feeds; profile_pinned pins it to your profile, three at most. Fields left out stay as they are. Takes a key holding community:write — Account offers it unticked — or the desktop's own session key. Spends nothing. While our team has paused publishing, a new title or description waits — 503 publishing_paused — and every other change here still goes through.
#Authentication
Authorization: Bearer auray_sk_… — community:write — Account offers it unticked; the desktop's session key holds it.
#Request
#Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes |
#Body
application/json, required.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
title | string | no | — | One line. 0 to 100 characters. May be null. |
description | string | no | — | 0 to 2000 characters. May be null. |
show_prompt | boolean | no | — | One of false. |
discoverable | boolean | no | — | |
profile_pinned | boolean | no | — |
#Example request
curl -X POST https://api.auray.ai/v1/community/publications/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d \
-H "Authorization: Bearer $AURAY_API_KEY" \
-H "content-type: application/json" \
-d '{
"title": "Lighthouse, morning fog",
"discoverable": true
}'import { createClient } from "@auray/client";
const auray = createClient(); // reads AURAY_API_KEY
const answer = await auray.platform.community.publications.update("3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d", { title: "Lighthouse, morning fog", discoverable: true });
console.dir(answer, { depth: null });from auray_client import Client
auray = Client() # reads AURAY_API_KEY
answer = auray.platform.community.publications.update("3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d", title="Lighthouse, morning fog", discoverable=True)
print(answer)const res = await fetch("https://api.auray.ai/v1/community/publications/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.AURAY_API_KEY}`,
"content-type": "application/json",
},
body: JSON.stringify({
"title": "Lighthouse, morning fog",
"discoverable": true
}),
});
console.log(await res.json());import os, requests
r = requests.post(
"https://api.auray.ai/v1/community/publications/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d",
headers={"Authorization": f"Bearer {os.environ['AURAY_API_KEY']}"},
json={
"title": "Lighthouse, morning fog",
"discoverable": True
},
)
r.raise_for_status()
print(r.json())package main
import (
"bytes"
"fmt"
"io"
"net/http"
"os"
)
func main() {
body := []byte(`{
"title": "Lighthouse, morning fog",
"discoverable": true
}`)
req, err := http.NewRequest("POST", "https://api.auray.ai/v1/community/publications/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d", bytes.NewReader(body))
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("AURAY_API_KEY"))
req.Header.Set("Content-Type", "application/json")
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/community/publications/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("AURAY_API_KEY"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"title" => "Lighthouse, morning fog",
"discoverable" => true,
], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE),
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response, PHP_EOL;require "net/http"
require "json"
uri = URI("https://api.auray.ai/v1/community/publications/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("AURAY_API_KEY")}"
req["Content-Type"] = "application/json"
req.body = {
"title" => "Lighthouse, morning fog",
"discoverable" => true
}.to_json
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 {
String body = """
{
"title": "Lighthouse, morning fog",
"discoverable": true
}""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.auray.ai/v1/community/publications/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d"))
.header("Authorization", "Bearer " + System.getenv("AURAY_API_KEY"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString(body))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("AURAY_API_KEY"));
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.auray.ai/v1/community/publications/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d");
var body = """
{
"title": "Lighthouse, morning fog",
"discoverable": true
}
""";
request.Content = new StringContent(body, Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");#Responses
#200 OK
OK: the work as it stands now.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
object | string | yes | — | One of "publication". |
id | string | yes | — | The work's public id. |
kind | string | yes | — | One of "image", "video", "audio", "model3d", "project". |
title | string | yes | — | May be null. |
model | object | yes | — | |
model.address | string | yes | — | The model address it was made with, as GET /v1/models lists it: the path a job is submitted to, such as auray-ai/krea-2-turbo/text-to-image. May be null. |
model.id | string | yes | — | The same model's id, as GET /v1/models lists it: the catalogue slug, such as krea2. May be null. |
model.label | string | yes | — | The model's name, as a person reads it. May be null. |
attribution | string | yes | — | The licence text the model's output travels with. Show it wherever the work is shown. May be null. |
ai_generated | boolean | yes | — | Every work here is a generation's result. Label it so wherever it is shown. One of true. |
media | object[] | yes | — | |
media[].role | string | yes | — | primary is the work as it was made; the rest are what the feeds draw: an image's thumbnail, a video's or a model's poster and thumbnail, a song's waveform (JSON: {version, peaks}). One of "primary", "poster", "preview", "thumbnail", "waveform". |
media[].position | integer | yes | — | |
media[].url | string | yes | — | Where to load it. Kept until its author unpublishes the work. A URL. |
media[].content_type | string | yes | — | |
media[].width | integer | yes | — | May be null. |
media[].height | integer | yes | — | May be null. |
media[].duration_ms | integer | yes | — | May be null. |
media[].supplied | boolean | yes | — | True for a poster, or its thumbnail, that the work's author supplied rather than one our services made: it is not what the model made, and the work's ai_generated does not describe it. |
author | object or null | yes | — | |
counts | object | yes | — | |
counts.likes | integer | yes | — | |
counts.views | integer | yes | — | Counted once a day per visitor. |
counts.comments | integer | yes | — | |
counts.remixes | integer | yes | — | |
made_at | string | yes | — | When the result was made. May be null. |
published_at | string | yes | — | May be null. |
featured | boolean | yes | — | Featured by our team. |
pinned | boolean | yes | — | Pinned by our team to the top of the public feeds. |
original | boolean | yes | — | An Original: made by our own team. |
remixed | boolean | yes | — | Made from another work. |
liked | boolean | yes | — | The reader's own like; null when no key that holds community:write was sent. May be null. |
url | string | yes | — | The work's page. A URL. |
description | string | yes | — | May be null. |
show_prompt | boolean | yes | — | |
prompt | string | yes | — | Only while its author shows it. A hidden prompt is not stored anywhere. May be null. |
params | object | yes | — | The settings it was made with, only while shown — never a file that was uploaded to make it. May be null. |
remix_kind | string | yes | — | One of "recreate", "animate", "upscale", "edit", null. May be null. |
remix_of | object | yes | — | The work it was made from, while that is shown. May be null. |
remix_of.id | string | no | — | |
remix_of.kind | string | no | — | One of "image", "video", "audio", "model3d", "project". |
remix_of.title | string | no | — | May be null. |
remix_of.author | object or null | no | — | |
remix_of.url | string | no | — | A URL. |
mine | object | no | — | Where an author's own work stands and why. Only ever answered to its author. |
mine.state | string | yes | — | published is shown on the profile and at its link; hidden while a severe report is reviewed; withdrawn unpublished while a report held it; removed taken down by our team; staging while its files are copied. One of "staging", "published", "hidden", "withdrawn", "removed". |
mine.state_reason | string | yes | — | Why our team hid or removed it. May be null. |
mine.approval | string | yes | — | Whether it is in the public feeds and search. Approval gates the feeds only — never the profile or the link. One of "pending", "approved", "rejected". |
mine.approval_reason | string | yes | — | Why our team declined it for the feeds. May be null. |
mine.discoverable | boolean | yes | — | The author lets it into the public feeds once approved. |
mine.profile_pinned | boolean | yes | — | |
mine.held | boolean | yes | — | An open report holds it: it is kept until the report is decided. |
mine.licence_version | string | no | — | The Terms version whose display and remix licences were granted. |
mine.created_at | string | yes | — | |
request_id | string | no | — | Mirrored in the X-Request-Id header. |
Headers:
| Header | Description |
|---|---|
RateLimit-Limit | Burst capacity. |
RateLimit-Remaining | |
RateLimit-Reset | Seconds until refill. |
X-RateLimit-Limit | |
X-RateLimit-Remaining | |
X-RateLimit-Reset | Unix seconds. The X- spelling is what client libraries read. |
X-Request-Id |
#400 Bad Request
#401 Unauthorized
#403 Forbidden
#404 Not Found
#409 Conflict
#422 Unprocessable Content
#429 Too Many Requests
#503 Service Unavailable
#Status codes
| Status | Meaning |
|---|---|
200 | OK: the work as it stands now. |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
422 | Unprocessable Content |
429 | Too Many Requests |
503 | Service Unavailable |
Every refusal names its code, and every code is explained at Errors.