Docs

Start here

Ask for help from the desktop

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

File a support request as the person signed in: whether something is not working or they need help, the app they asked from, and what they wrote.

File a support request as the person signed in: whether something is not working or they need help, the app they asked from, and what they wrote. It is filed at once, with no confirmation mail because the sign-in is the proof, under the account's own email address, which is read off the account and never off the request; we mail the reference and a status link there, and our answers arrive there and in the desktop's Messages app. 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.

#Request

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
kindstringyes—problem — something is not working; question — help with how to do something; appeal — a decision about the account or its work the person thinks is wrong (a limit on the account, a refused result, a report upheld against their work), which waits for our trust and safety team. A limited account may file and answer requests, an appeal among them. One of "problem", "question", "appeal".
appstringno—The desktop app it is about, as the desktop names its apps. Optional; one this API does not know files the request naming none. One of "photos", "video", "music", "threed", "studio", "community", "explore", "code", "messages", "finder", "settings".
subjectstringno—One line. Optional: absent, it is the app and the kind — Photos — Something isn't working. 1 to 300 characters.
messagestringyes—Secrets are removed from this before it is stored, as the help form's are. 1 to 20000 characters.
metaobjectno—What the client can say about itself. Only these keys are kept, each held to its shape; anything else is dropped.
meta.viewportstringno—
meta.app_versionstringno—0 to 32 characters.
meta.source_shastringno—
meta.job_idstringno—A job the request is about. Kept instead of request_id when both are sent. 0 to 128 characters.
meta.request_idstringno—0 to 128 characters.
meta.appeal_ofstringno—What an appeal disputes: the limit on the account, a refused result or a report about the person's work. Kept only when kind is appeal. One of "limit", "refusal", "report".
meta.appeal_idstringno—The reference of the decision an appeal disputes — a refused result's job. Kept only beside appeal_of.

#Example request

curl -X POST https://api.auray.ai/v1/support/tickets \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "kind": "problem",
  "message": "…"
}'

#Responses

#201 Created

Filed.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "support_ticket".
referencestringyes—
statusstringyes—One of "new".

Headers:

HeaderDescription
RateLimit-LimitBurst capacity.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-Request-Id

#400 Bad Request

invalid_kind, support_subject_invalid, support_message_invalid, support_email_invalid (the account has no address we can reply to), invalid_body or invalid_json.

The error body: error, message, docs (the entry that explains it) and 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.

#413 Payload Too Large

body_too_large — the body must be at most 65536 bytes.

The error body: error, message, docs (the entry that explains it) and request_id.

#429 Too Many Requests

support_rate_limited — this account's address has sent several requests just now — or rate_limited, the key's write bucket.

The error body: error, message, docs (the entry that explains it) and request_id.

#503 Service Unavailable

support_disabled, support_not_configured, support_closed or support_unavailable.

The error body: error, message, docs (the entry that explains it) and request_id.

#Status codes

StatusMeaning
201Filed.
400invalid_kind, support_subject_invalid, support_message_invalid, support_email_invalid (the account has no address we can reply to), invalid_body or invalid_json.
401missing_authorization, invalid_api_key, key_revoked or key_expired.
403support_session_only — this is the desktop's door.
413body_too_large — the body must be at most 65536 bytes.
429support_rate_limited — this account's address has sent several requests just now — or rate_limited, the key's write bucket.
503support_disabled, support_not_configured, support_closed or support_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