Start here
List your support requests
/v1/support/ticketson https://api.auray.ai/v1The requests the signed-in account has filed from the desktop, or that our team has linked to it, newest movement first — at most twenty, each with what was said on it.
The requests the signed-in account has filed from the desktop, or that our team has linked to it, newest movement first — at most twenty, each with what was said on it. Called by the desktop for the person signed in; a key you hold is refused 403 support_session_only, since it is not the person asking. Without the desktop, the help form (POST /support/requests) needs no key at all.
#Authentication
Authorization: Bearer auray_sk_… — The desktop's own session key, signed in — a key you hold is refused 403 support_session_only. Without the desktop, the help form needs no key.
#Example request
curl https://api.auray.ai/v1/support/tickets \
-H "Authorization: Bearer $AURAY_API_KEY"const res = await fetch("https://api.auray.ai/v1/support/tickets", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.AURAY_API_KEY}` },
});
console.log(await res.json());import os, requests
r = requests.get(
"https://api.auray.ai/v1/support/tickets",
headers={"Authorization": f"Bearer {os.environ['AURAY_API_KEY']}"},
)
r.raise_for_status()
print(r.json())package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("GET", "https://api.auray.ai/v1/support/tickets", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("AURAY_API_KEY"))
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/support/tickets");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("AURAY_API_KEY"),
],
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response, PHP_EOL;require "net/http"
uri = URI("https://api.auray.ai/v1/support/tickets")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("AURAY_API_KEY")}"
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 {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.auray.ai/v1/support/tickets"))
.header("Authorization", "Bearer " + System.getenv("AURAY_API_KEY"))
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("AURAY_API_KEY"));
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.auray.ai/v1/support/tickets");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");#Responses
#200 OK
OK
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
object | string | yes | — | One of "list". |
data | object[] | yes | — | |
data[].object | string | yes | — | One of "support_ticket". |
data[].reference | string | yes | — | The request's label, as our mails print it — AU-7K2M9Q. A label, never a credential. |
data[].subject | string | yes | — | |
data[].status | string | yes | — | Where the request stands. solved and closed reopen when you write back. One of "new", "open", "pending", "on_hold", "solved", "closed". |
data[].app | string | yes | — | The desktop app it was asked from, or null when it named none. One of "photos", "video", "music", "threed", "studio", "community", "explore", "code", "messages", "finder", "settings", null. May be null. |
data[].kind | string | yes | — | problem when something was not working, question for help with how, appeal when the person disputed a decision about the account or its work; null for a request filed another way. One of "problem", "question", "appeal", null. May be null. |
data[].opened_at | string | yes | — | |
data[].updated_at | string | yes | — | |
data[].messages | object[] | yes | — | What was said on it, oldest first: the person's own words, and every answer of ours once it has been sent — never an answer still waiting to go, and never a note our team keeps. |
data[].messages[].seq | integer | yes | — | Its place in the conversation, from 1. |
data[].messages[].from | string | yes | — | you for what the person wrote, support for what we answered. One of "you", "support". |
data[].messages[].body | string | yes | — | |
data[].messages[].at | string | yes | — |
Headers:
| Header | Description |
|---|---|
RateLimit-Limit | Burst capacity. |
RateLimit-Remaining | |
RateLimit-Reset | Seconds until refill. |
X-Request-Id |
#401 Unauthorized
missing_authorization, invalid_api_key, key_revoked or key_expired.
The error body: error, message, docs (the entry that explains it) and request_id.
#403 Forbidden
support_session_only — this is the desktop's door.
The error body: error, message, docs (the entry that explains it) and request_id.
#429 Too Many Requests
rate_limited — the key's read bucket.
The error body: error, message, docs (the entry that explains it) and request_id.
#503 Service Unavailable
support_disabled, support_not_configured or support_unavailable.
The error body: error, message, docs (the entry that explains it) and request_id.
#Status codes
| Status | Meaning |
|---|---|
200 | OK |
401 | missing_authorization, invalid_api_key, key_revoked or key_expired. |
403 | support_session_only — this is the desktop's door. |
429 | rate_limited — the key's read bucket. |
503 | support_disabled, support_not_configured or support_unavailable. |
Every refusal names its code, and every code is explained at Errors.