Docs

Start here

Set your banner

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

Set your profile's banner from a picture you send; the one it replaces is deleted.

Set your profile's banner from a picture you send; the one it replaces is deleted. 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
content_typestringyes—One of "image/png", "image/jpeg", "image/webp".
data_base64stringyes—The picture as base64, at most 2,000,000 bytes decoded and at least 64 pixels on each side. It is redrawn at 1600 × 600, cropped where its interest is, as WebP — with every byte of its metadata, a photo's location included, dropped.

#Example request

curl -X POST https://api.auray.ai/v1/community/profiles/ada/banner \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "content_type": "image/png",
  "data_base64": "iVBORw0KGgoAAAANSUhEUgAA…"
}'

#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

#413 Payload Too Large

#428 Precondition Required

#429 Too Many Requests

#502 Bad Gateway

#503 Service Unavailable

#Status codes

StatusMeaning
200OK: your standing, with the profile.
400Bad Request
401Unauthorized
403Forbidden
404Not Found
413Payload Too Large
428Precondition Required
429Too Many Requests
502Bad Gateway
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