Start here

File a support request

POST/v1/support/requestson https://api.auray.ai/v1

The one unauthenticated write path on this surface.

The one unauthenticated write path on this surface. Answers 202 identically whether the address is known, unknown or blocked — a different answer for an address we recognise would be an enumeration oracle anybody could query, and telling a sender they are blocked hands them a free signal. Every request is answered by email: the address receives a confirmation link, and the request becomes a ticket, with its reference, only when that link is opened — including for an address that has confirmed before, because nothing in this request proves the caller holds that mailbox today.

#Authentication

No key needed — this document is public.

#Request

#Body

application/json, required.

Field	Type	Required	Default	Description
`email`	string	yes	—	Checked for shape only. The mail round trip is what proves an address. 0 to 320 characters.
`subject`	string	yes	—	1 to 300 characters.
`message`	string	yes	—	Secrets are removed from this before it is stored — an API key, a session token, a JWT or a bearer header is redacted deterministically, before the round trip, so no copy is ever made. 1 to 20000 characters.
`topic`	string	no	—	One of the `id` values from GET /v1/support/topics. Optional.
`meta`	object	no	—	Whatever your client can say about what the person actually saw: a request id, an error code, an app version. Read whole, by a person.
`challenge`	string	yes	—	From POST /v1/support/challenge, unchanged.
`nonce`	string	yes	—	0 to 64 characters.

#Example request

curl -X POST https://api.auray.ai/v1/support/requests \
  -H "content-type: application/json" \
  -d '{
  "email": "…",
  "subject": "…",
  "message": "…",
  "challenge": "…",
  "nonce": "…"
}'

const res = await fetch("https://api.auray.ai/v1/support/requests", {
  method: "POST",
  headers: {
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "email": "…",
    "subject": "…",
    "message": "…",
    "challenge": "…",
    "nonce": "…"
  }),
});
console.log(await res.json());

import requests

r = requests.post(
    "https://api.auray.ai/v1/support/requests",
    json={
        "email": "…",
        "subject": "…",
        "message": "…",
        "challenge": "…",
        "nonce": "…"
    },
)
r.raise_for_status()
print(r.json())

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	body := []byte(`{
  "email": "…",
  "subject": "…",
  "message": "…",
  "challenge": "…",
  "nonce": "…"
}`)
	req, err := http.NewRequest("POST", "https://api.auray.ai/v1/support/requests", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	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/support/requests");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "email" => "…",
        "subject" => "…",
        "message" => "…",
        "challenge" => "…",
        "nonce" => "…",
    ], 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/support/requests")
req = Net::HTTP::Post.new(uri)
req["Content-Type"] = "application/json"
req.body = {
  "email" => "…",
  "subject" => "…",
  "message" => "…",
  "challenge" => "…",
  "nonce" => "…"
}.to_json

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.code, res.body

import 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 = """
            {
              "email": "…",
              "subject": "…",
              "message": "…",
              "challenge": "…",
              "nonce": "…"
            }""";

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.auray.ai/v1/support/requests"))
            .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.Text;

using var client = new HttpClient();

using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.auray.ai/v1/support/requests");
var body = """
    {
      "email": "…",
      "subject": "…",
      "message": "…",
      "challenge": "…",
      "nonce": "…"
    }
    """;
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

#202 Accepted

Received. The same answer for every address.

Field	Type	Required	Default	Description
`status`	string	no	—	One of `"received"`.

Headers:

Header	Description
`RateLimit-Limit`	Burst capacity for the bucket that answered.
`RateLimit-Remaining`
`RateLimit-Reset`	Seconds until refill.
`X-Request-Id`

#400 Bad Request

support_email_invalid, support_subject_invalid, support_message_invalid, support_topic_unknown, challenge_required, challenge_invalid, challenge_expired, challenge_unsolved, invalid_body or invalid_json.