Docs

Start here

Change your profile

POST/v1/community/profiles/{handle}on https://api.auray.ai/v1

Change your own profile: its handle (once in 30 days; the old one keeps leading to you and stays yours for 30 days), its name, headline and bio (read by the automatic check), its links — at most fi…

Change your own profile: its handle (once in 30 days; the old one keeps leading to you and stays yours for 30 days), its name, headline and bio (read by the automatic check), its links — at most five, each https to the host its kind names — or whether it is hidden from everyone else (hidden at once; shown again no sooner than an hour after, visibility_cooldown with after before then). Fields left out stay as they are. Answered at your own handle only. 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

#Path parameters

NameTypeRequiredDescription
handlestringyesA profile's handle; one @ before it is read past.

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
handlestringno—0 to 31 characters.
namestringno—0 to 50 characters. May be null.
headlinestringno—0 to 80 characters. May be null.
biostringno—0 to 500 characters. May be null.
linksobject[]no—
links[].kindstringyes—One of "website", "x", "instagram", "tiktok", "youtube", "linkedin", "github", "behance", "dribbble", "artstation", "vimeo", "threads", "bluesky".
links[].urlstringyes—https, at the host its kind names; a website anywhere. A URL.
hiddenbooleanno—Hide your profile from everyone else — its works, comments and collections with it, and their files no longer served — or show it again, no sooner than an hour after you hid it. Showing it gives every file a new address, so a direct link to a file stops working; links to the profile and its works keep working. Your works stay published.

#Example request

curl -X POST https://api.auray.ai/v1/community/profiles/ada \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "bio": "I make quiet pictures.",
  "links": [
    {
      "kind": "github",
      "url": "https://github.com/ada"
    }
  ]
}'

#Responses

#200 OK

OK: your standing, with the profile.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "community".
standingstringyes—The account's standing: active, limited, suspended or banned.
creatorobjectyes—The account's public profile, or null before one is claimed. May be null.
creator.idstringno—
creator.handlestringno—
creator.namestringno—May be null.
creator.headlinestringno—May be null.
creator.biostringno—May be null.
creator.linksobject[]no—
creator.links[].kindstringyes—One of "website", "x", "instagram", "tiktok", "youtube", "linkedin", "github", "behance", "dribbble", "artstation", "vimeo", "threads", "bluesky".
creator.links[].urlstringyes—https, at the host its kind names; a website anywhere. A URL.
creator.avatar_urlstringno—A URL. May be null.
creator.banner_urlstringno—A URL. May be null.
creator.teambooleanno—
creator.urlstringno—A URL.
creator.moderationstringno—One of "visible", "hidden".
creator.moderation_notestringno—May be null.
creator.followersintegerno—
creator.followingintegerno—
creator.worksintegerno—
creator.handle_change_afterstringno—May be null.
creator.created_atstringno—
creator.hiddenbooleanno—You hid your profile from everyone else (hidden on Change your profile).
creator.show_afterstringno—While you hid it less than an hour ago, when it can be shown again; null otherwise. May be null.
can_publishbooleanyes—An active account with a profile our team has not hidden.
countsobjectyes—
counts.likedintegerno—
counts.collectionsintegerno—
counts.publicationsobjectno—Works by state.
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

#422 Unprocessable Content

#429 Too Many Requests

#503 Service Unavailable

#Status codes

StatusMeaning
200OK: your standing, with the profile.
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Unprocessable Content
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