Docs

Start here

Change a publication's words and switches

POST/v1/studio/projects/{project}/publication/settingson https://api.auray.ai/v1

Change a publication's title, description, category, cover or switches without a new snapshot.

Change a publication's title, description, category, cover or switches without a new snapshot. New words pass the automatic check and go back to our team's queue. Hiding prompts or canvases deletes them from the publication; showing them again is publishing again. Only its author may. Takes a key holding studio:write — Account offers it unticked — or the desktop's own session key. Spends nothing.

#Authentication

Authorization: Bearer auray_sk_… — a key with the scope the route names.

#Request

#Path parameters

NameTypeRequiredDescription
projectstringyes

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
show_promptsbooleannotrueShow each asset's prompt and the canvases' prompts.
show_canvasbooleannofalseShow the canvases named in canvases, read-only.
discoverablebooleannotrueLet it into the public feeds and search once approved.
show_spendbooleannofalseAsk for its info card to say what its generations cost. Kept, and shown nowhere for now: a published work's cost is not shown.
titlestringno—0 to 100 characters.
descriptionstringno—0 to 2000 characters. May be null.
categorystringno—One of "film", "short", "series", "trailer", "commercial", "music_video", "animation", "documentary", "fashion", "game", "worldbuilding", "experimental", "other".
cover_item_idstringno—A picture or a clip of the live snapshot, by the project's item it was; null for the project's own cover. May be null.

#Example request

curl -X POST https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/publication/settings \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "title": "Night harbour, cut two",
  "show_prompts": false
}'

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "project_publication".
project_idstringyes—
publication_idstringyes—The Community work it is: GET /community/publications/{id}.
urlstringyes—Its page under its author's profile on auray.ai. A URL.
titlestringyes—0 to 100 characters.
descriptionstringyes—0 to 2000 characters. May be null.
categorystringyes—One of "film", "short", "series", "trailer", "commercial", "music_video", "animation", "documentary", "fashion", "game", "worldbuilding", "experimental", "other".
togglesobjectyes—What a publication shows. Hiding prompts or canvases deletes them from it; showing them again is a new snapshot.
toggles.show_promptsbooleanyes—Each asset's prompt, and the canvases' prompts, are shown.
toggles.show_canvasbooleanyes—The canvases chosen are shown, read-only — only ever as a reader may see them.
toggles.discoverablebooleanyes—It may enter the public feeds and search once our team approves it.
toggles.show_spendbooleanyes—Its author asked for the info card to say what its generations cost; no public answer says it for now.
selectionobjectyes—What the live snapshot was made from, in the project's own ids.
selection.foldersstring[]yes—
selection.itemsstring[]yes—
selection.canvasesstring[]yes—
itemsintegeryes—How many assets the live snapshot shows. 0 to ….
minebooleanyes—The caller is the publication's author. Only its author changes or unpublishes it, and only its author is told its moderation standing — after an ownership transfer that may be the former owner.
standingnull or objectyes—Where it stands in the Community and why — answered to its author alone; null for every other member.
fingerprintstringyes—What the live snapshot was made from, as changed compares it.
changedbooleanyes—The project changed since inside what was published: publishing again makes a new snapshot.
copyingnull or objectyes—A snapshot whose files are still being copied, and how far it has got; null when none is. A first publish is on no page until it is done.
published_atstringyes—Null while its first snapshot is still being copied. May be null.
republished_atstringyes—May be null.
request_idstringno—Mirrored in the X-Request-Id header.

Headers:

HeaderDescription
RateLimit-LimitBurst capacity.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-ResetUnix seconds. The X- spelling is what client libraries read.
X-Request-Id

#400 Bad Request

#401 Unauthorized

#403 Forbidden

#404 Not Found

#409 Conflict

#413 Payload Too Large

#422 Unprocessable Content

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
413Payload Too Large
422Unprocessable Content
429Too Many Requests
500Internal Server Error
503Service Unavailable

Every refusal names its code, and every code is explained at Errors.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close