Docs

Start here

List your works

GET/v1/community/me/publicationson https://api.auray.ai/v1

A page of your own works in any state, newest first, each with where it stands and why — published, awaiting approval or declined for the feeds, hidden while a report is reviewed, withdrawn, removed.

A page of your own works in any state, newest first, each with where it stands and why — published, awaiting approval or declined for the feeds, hidden while a report is reviewed, withdrawn, removed. Takes a key holding community:write — Account offers it unticked — or the desktop's own session key. Spends nothing.

#Authentication

Authorization: Bearer auray_sk_… — community:write — Account offers it unticked; the desktop's session key holds it.

#Request

#Query parameters

NameTypeRequiredDescription
statestringnoOnly works in this state. Unsaid, every state but staging. One of "staging", "published", "hidden", "withdrawn", "removed".
cursorstringnoThe next_cursor the previous page answered, unchanged, with the same filters. None for the first page. 0 to 200 characters.
limitintegernoHow many on a page. 1 to 60.

#Example request

curl https://api.auray.ai/v1/community/me/publications \
  -H "Authorization: Bearer $AURAY_API_KEY"

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "list".
dataobject[]yes—
data[].idstringyes—The work's public id.
data[].kindstringyes—One of "image", "video", "audio", "model3d", "project".
data[].titlestringyes—May be null.
data[].modelobjectyes—
data[].model.addressstringyes—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.
data[].model.idstringyes—The same model's id, as GET /v1/models lists it: the catalogue slug, such as krea2. May be null.
data[].model.labelstringyes—The model's name, as a person reads it. May be null.
data[].attributionstringyes—The licence text the model's output travels with. Show it wherever the work is shown. May be null.
data[].ai_generatedbooleanyes—Every work here is a generation's result. Label it so wherever it is shown. One of true.
data[].mediaobject[]yes—
data[].media[].rolestringyes—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".
data[].media[].positionintegeryes—
data[].media[].urlstringyes—Where to load it. Kept until its author unpublishes the work. A URL.
data[].media[].content_typestringyes—
data[].media[].widthintegeryes—May be null.
data[].media[].heightintegeryes—May be null.
data[].media[].duration_msintegeryes—May be null.
data[].media[].suppliedbooleanyes—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.
data[].authorobject or nullyes—
data[].countsobjectyes—
data[].counts.likesintegeryes—
data[].counts.viewsintegeryes—Counted once a day per visitor.
data[].counts.commentsintegeryes—
data[].counts.remixesintegeryes—
data[].made_atstringyes—When the result was made. May be null.
data[].published_atstringyes—May be null.
data[].featuredbooleanyes—Featured by our team.
data[].pinnedbooleanyes—Pinned by our team to the top of the public feeds.
data[].originalbooleanyes—An Original: made by our own team.
data[].remixedbooleanyes—Made from another work.
data[].likedbooleanyes—The reader's own like; null when no key that holds community:write was sent. May be null.
data[].urlstringyes—The work's page. A URL.
data[].projectobjectno—Only on a project's card: its address, category, how many assets it shows, and the three largest bands of its Stack.
data[].project.slugstringyes—
data[].project.categorystringyes—One of "film", "short", "series", "trailer", "commercial", "music_video", "animation", "documentary", "fashion", "game", "worldbuilding", "experimental", "other".
data[].project.itemsintegeryes—0 to ….
data[].project.stackobject[]yes—
data[].project.stack[].modelobjectyes—
data[].project.stack[].tenthsintegeryes—Its share in tenths of a percent; the bands of one Stack add up to exactly 1000. 0 to 1000.
data[].project.stack[].percentnumberyes—tenths / 10, for display only.
data[].project.stack[].countintegeryes—0 to ….
data[].project.stack[].colorstringyes—
data[].project.stack[].otherbooleanyes—The band that gathers every model past the top ones.
data[].mineobjectyes—Where an author's own work stands and why. Only ever answered to its author.
data[].mine.statestringyes—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".
data[].mine.state_reasonstringyes—Why our team hid or removed it. May be null.
data[].mine.approvalstringyes—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".
data[].mine.approval_reasonstringyes—Why our team declined it for the feeds. May be null.
data[].mine.discoverablebooleanyes—The author lets it into the public feeds once approved.
data[].mine.profile_pinnedbooleanyes—
data[].mine.heldbooleanyes—An open report holds it: it is kept until the report is decided.
data[].mine.licence_versionstringno—The Terms version whose display and remix licences were granted.
data[].mine.created_atstringyes—
next_cursorstringyes—The cursor of the next page; null on the last. 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

#429 Too Many Requests

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
401Unauthorized
403Forbidden
429Too Many Requests
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