Start here
Claim a profile
/v1/community/profileson https://api.auray.ai/v1Claim your public profile: a handle — lower case, 3 to 30 letters, digits, dots and underscores, unique, not reserved — and if you like a name, a headline and a bio, which the automatic check reads.
Claim your public profile: a handle — lower case, 3 to 30 letters, digits, dots and underscores, unique, not reserved — and if you like a name, a headline and a bio, which the automatic check reads. One per account; your account's own name and address are never shown. 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
#Body
application/json, required.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
handle | string | yes | — | 0 to 31 characters. |
name | string | no | — | 0 to 50 characters. May be null. |
headline | string | no | — | 0 to 80 characters. May be null. |
bio | string | no | — | 0 to 500 characters. May be null. |
#Example request
curl -X POST https://api.auray.ai/v1/community/profiles \
-H "Authorization: Bearer $AURAY_API_KEY" \
-H "content-type: application/json" \
-d '{
"handle": "ada",
"name": "Ada",
"headline": "Light and fog"
}'import { createClient } from "@auray/client";
const auray = createClient(); // reads AURAY_API_KEY
const answer = await auray.platform.community.profiles.claim({ handle: "ada", name: "Ada", headline: "Light and fog" });
console.dir(answer, { depth: null });from auray_client import Client
auray = Client() # reads AURAY_API_KEY
answer = auray.platform.community.profiles.claim(handle="ada", name="Ada", headline="Light and fog")
print(answer)const res = await fetch("https://api.auray.ai/v1/community/profiles", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.AURAY_API_KEY}`,
"content-type": "application/json",
},
body: JSON.stringify({
"handle": "ada",
"name": "Ada",
"headline": "Light and fog"
}),
});
console.log(await res.json());import os, requests
r = requests.post(
"https://api.auray.ai/v1/community/profiles",
headers={"Authorization": f"Bearer {os.environ['AURAY_API_KEY']}"},
json={
"handle": "ada",
"name": "Ada",
"headline": "Light and fog"
},
)
r.raise_for_status()
print(r.json())package main
import (
"bytes"
"fmt"
"io"
"net/http"
"os"
)
func main() {
body := []byte(`{
"handle": "ada",
"name": "Ada",
"headline": "Light and fog"
}`)
req, err := http.NewRequest("POST", "https://api.auray.ai/v1/community/profiles", 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/profiles");
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([
"handle" => "ada",
"name" => "Ada",
"headline" => "Light and fog",
], 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/profiles")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("AURAY_API_KEY")}"
req["Content-Type"] = "application/json"
req.body = {
"handle" => "ada",
"name" => "Ada",
"headline" => "Light and fog"
}.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 = """
{
"handle": "ada",
"name": "Ada",
"headline": "Light and fog"
}""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.auray.ai/v1/community/profiles"))
.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/profiles");
var body = """
{
"handle": "ada",
"name": "Ada",
"headline": "Light and fog"
}
""";
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
#201 Created
Claimed: your standing, with the profile.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
object | string | yes | — | One of "community". |
standing | string | yes | — | The account's standing: active, limited, suspended or banned. |
creator | object | yes | — | The account's public profile, or null before one is claimed. May be null. |
creator.id | string | no | — | |
creator.handle | string | no | — | |
creator.name | string | no | — | May be null. |
creator.headline | string | no | — | May be null. |
creator.bio | string | no | — | May be null. |
creator.links | object[] | no | — | |
creator.links[].kind | string | yes | — | One of "website", "x", "instagram", "tiktok", "youtube", "linkedin", "github", "behance", "dribbble", "artstation", "vimeo", "threads", "bluesky". |
creator.links[].url | string | yes | — | https, at the host its kind names; a website anywhere. A URL. |
creator.avatar_url | string | no | — | A URL. May be null. |
creator.banner_url | string | no | — | A URL. May be null. |
creator.team | boolean | no | — | |
creator.url | string | no | — | A URL. |
creator.moderation | string | no | — | One of "visible", "hidden". |
creator.moderation_note | string | no | — | May be null. |
creator.followers | integer | no | — | |
creator.following | integer | no | — | |
creator.works | integer | no | — | |
creator.handle_change_after | string | no | — | May be null. |
creator.created_at | string | no | — | |
creator.hidden | boolean | no | — | You hid your profile from everyone else (hidden on Change your profile). |
creator.show_after | string | no | — | While you hid it less than an hour ago, when it can be shown again; null otherwise. May be null. |
can_publish | boolean | yes | — | An active account with a profile our team has not hidden. |
counts | object | yes | — | |
counts.liked | integer | no | — | |
counts.collections | integer | no | — | |
counts.publications | object | no | — | Works by state. |
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
#409 Conflict
#422 Unprocessable Content
#429 Too Many Requests
#503 Service Unavailable
#Status codes
| Status | Meaning |
|---|---|
201 | Claimed: your standing, with the profile. |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
409 | Conflict |
422 | Unprocessable Content |
429 | Too Many Requests |
503 | Service Unavailable |
Every refusal names its code, and every code is explained at Errors.