Support: API-Referenz mit Endpunkten und Beispielen

OpenAPI YAML OpenAPI JSON Probleme YAML API-Überblick

Diese Gruppe hat 9 Operationen, generiert aus api/openapi.yaml. Filtern Sie nach Pfad, Aktion oder Authentifizierung. Jeder Endpunkt listet seine Eingaben auf; klappen Sie ihn auf, um eine Anfragevorlage und die Antwortcodes zu sehen. Die Vorlagen brauchen Ihre eigenen Werte und einen schemagültigen Anfragekörper.

Großgeschriebene Platzhalter durch Ihre Werte ersetzen. Für eine JSON-Anfrage speichern Sie einen Body, der dem Schema in request.json entspricht. Cookie-Beispiele verwenden ein lokales Cookie-Archiv aus einer authentifizierten Sitzung.

Support

POST/website/support-messages¶

Eine Kontaktnachricht über die Website senden

Anonymer JSON-Eingang derselben Herkunft für das Kontaktformular der Website. Erfordert den Origin-Header der Website und einen Idempotency-Key mit 20–128 Buchstaben, Ziffern, Bindestrichen oder Unterstrichen. Erstellt weder Konto noch Sitzung. Speichert Nachricht und Antwortadresse vor der Bestätigung; der Support-Dienst übermittelt sie an den konfigurierten Slack-Supportkanal.

Die vom Besucher angegebene E-Mail-Adresse dient als Kontaktangabe, niemals als Identitätsnachweis. Identische Wiederholungen erhalten dieselbe Bestätigung ohne weitere Zustellung; ein geänderter Inhalt mit demselben Schlüssel führt zu idempotency_mismatch.

Höchstens 10 neue Nachrichten pro Client-IP und Stunde (IPv6 nach /64 gruppiert), 3 pro E-Mail-Adresse und Tag sowie insgesamt 200 pro Stunde; für alle Anfragen gilt ein gemeinsames Limit von 120 pro IP und Minute. Retry-After ist maßgeblich. Bei Zustellfehlern bleiben Nachrichten in der Warteschlange; zugestellte Datensätze verfallen nach 30 Tagen.

Authentifizierung: keine
Anfrageinhalt: object
Operations-ID: submitWebsiteSupportMessage

Parameter

Name	Senden	Erforderlich?	Beschreibung
Herkunft	Überschrift	erforderlich
Idempotency-Key	Überschrift	erforderlich

Anfrageinhalt-Felder

Feld	Beschreibung
E-Mail (erforderlich, Zeichenfolge)	maxLength: 254 Format: "email"
message (erforderlich, Zeichenfolge)	Unveränderter Nachrichtentext mit Absätzen und Einrückung; Text nur aus Leerraum wird abgelehnt. minLength: 1 maxLength: 4000
website (optional, Zeichenfolge)	Antispam-Feld; leer lassen. maxLength: 200

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST --header 'Origin: https://screenrig.ai' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/support-messages'

Antworten

Status	Bedeutung	Textkörper und Header
202	Nachricht zur Zustellung gespeichert oder identische Wiederholung bestätigt. Enthält keine Kontaktdaten.	Objekt (application/json); Header: Cache-Control
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

GET/api/support/status¶

Support-Status

Verfügbarkeit und Stunden für jedes aktive Projekt. chat_allowed ist für jedes aktive Projekt, einschließlich Standard, wahr. human_available ist wahr, wenn auf Anfrage eine Person dem Chat beitreten kann (Education, Premium und Enterprise); Standard und Plus erhalten Dokumentation und KI-Support. staffed gibt an, ob Mitarbeitende gerade in ihren Zeiten erreichbar sind. Luna antwortet auf jedem Plan sofort.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: keine
Operations-ID: supportStatus

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/support/status'

Antworten

Status	Bedeutung	Textkörper und Header
200	Support-Ergebnis.	SupportStatus (application/json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

GET/api/support/conversations¶

Support-Konversationen auflisten

Projektgespräche, neueste zuerst, maximal 100. Unerledigte Mitarbeiterzähler sind pro authentifizierter Person oder Agent.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: keine
Operations-ID: listSupportConversations

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
vor	Abfrage	optional	Konversations-ID vom nächsten Cursor der vorherigen Seite.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/support/conversations'

Antworten

Status	Bedeutung	Textkörper und Header
200	Support-Ergebnis.	SupportConversationList (application/json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

POST/api/support/conversations¶

Support-Konversation erstellen

Auf jedem Plan verfügbar; Luna antwortet zuerst, sofort. Wo eine Person beitreten kann (human_available im Support-Status), pausiert eine entsprechende Anfrage Luna für Mitarbeitende; bei Standard und Plus wird sie ignoriert und Luna antwortet. Vor der Speicherung oder Slack geprüft.

Eine Eröffnungsnachricht unter 8 Zeichen oder 3 Wörtern gibt submission_too_short zurück; eine, die keine Frage oder kein Problem ist, gibt submission_unclear zurück; Spam, linklastiger Text, Prompt-Injektion und unsicherer Text geben submission_rejected zurück. Abgelehnter Text wird nicht gespeichert oder an Luna gesendet, und die Problemdetails wiederholen ihn nie.

Text in Form von Anmeldeinformationen außer ScreenRig-Anmeldeinformationen (Bearer-Tokens, Cloud- und API-Schlüssel, private Schlüssel) wird vor der Speicherung durch [redacted] ersetzt; ScreenRig-Anmeldeinformationen führen zu invalid_request. Ein neues Gespräch beginnt in einem Slack-Thread; Folgebeiträge bleiben darin. Anfragen mit demselben Schlüssel werden 24 Stunden lang wiederholt, auch eine Ablehnung.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: SupportWrite
Operations-ID: createSupportConversation

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
Idempotency-Key	Überschrift	erforderlich

Anfrageinhalt-Felder

Feld	Beschreibung
Inhalt (erforderlich, Zeichenfolge)	minLength: 1 maxLength: 4000
human_requested (optional, boolean)	Eine Person anfordern; das pausiert Luna und wartet auf Mitarbeitende. Zählt nur dort, wo eine Person beitreten kann (human_available: Education, Premium und Enterprise); bei Standard und Plus wird es ignoriert und Luna antwortet. Standard: false

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/support/conversations'

Antworten

Status	Bedeutung	Textkörper und Header
201	Support-Ergebnis.	SupportSubmission (application/json)
422	Die Nachricht wurde durch Screening abgelehnt: submission_too_short oder submission_unclear (nur die Eröffnungsnachricht) oder submission_rejected. Das Detail wiederholt nie den Text.	Problem (application/problem+json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

GET/api/support/conversations/{id}/messages¶

Support-Nachrichten auflisten

Nachrichten im Projektgespräch, aufsteigende Reihenfolge, maximal 100. Fortsetzung nach der letzten Nachrichtenfolge für ältere Gesprächs-Paginierung. Das Lesen bestätigt keinen ungelesenen Mitarbeiterstatus.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: keine
Operations-ID: listSupportMessages

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich
nach	Abfrage	optional	Projekt-Support-Nachrichtenfolge; setzt strikt nach dieser Position fort.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/support/conversations/RESOURCE_ID/messages'

Antworten

Status	Bedeutung	Textkörper und Header
200	Support-Ergebnis.	SupportMessageList (application/json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

POST/api/support/conversations/{id}/messages¶

Support-Konversation beantworten

Fügt einer offenen Unterhaltung eine Kundenmeldung hinzu. Eine Folge hat keine Mindestlänge und wird nie allein als unklar abgelehnt („danke“, „ja“); sie wird auf Sicherheit, Prompt-Injektion und Link-Spam geprüft, mit submission_rejected abgelehnt, und Text in Form von Anmeldedaten wird wie bei einer neuen Unterhaltung behandelt.

Abgelehnter Text wird nicht gespeichert, und eine Ablehnung wird unter demselben Schlüssel 24 Stunden lang wiedergegeben.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: SupportWrite
Operations-ID: replySupportConversation

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich
Idempotency-Key	Überschrift	erforderlich

Anfrageinhalt-Felder

Feld	Beschreibung
Inhalt (erforderlich, Zeichenfolge)	minLength: 1 maxLength: 4000
human_requested (optional, boolean)	Eine Person anfordern; das pausiert Luna und wartet auf Mitarbeitende. Zählt nur dort, wo eine Person beitreten kann (human_available: Education, Premium und Enterprise); bei Standard und Plus wird es ignoriert und Luna antwortet. Standard: false

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/support/conversations/RESOURCE_ID/messages'

Antworten

Status	Bedeutung	Textkörper und Header
201	Support-Ergebnis.	SupportSubmission (application/json)
422	Die Nachricht wurde durch Screening abgelehnt: submission_too_short oder submission_unclear (nur die Eröffnungsnachricht) oder submission_rejected. Das Detail wiederholt nie den Text.	Problem (application/problem+json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

PUT/api/support/conversations/{id}/read¶

Support-Konversation lesen

Monoton Nachrichten über die Sequenz für diesen Leser bestätigen. Kann nicht über die Konversation last_sequence hinaus bestätigen.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: SupportRead
Operations-ID: readSupportConversation

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich

Anfrageinhalt-Felder

Feld	Beschreibung
sequence (erforderlich, Ganzzahl)	Minimum: 0

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/support/conversations/RESOURCE_ID/read'

Antworten

Status	Bedeutung	Textkörper und Header
200	Support-Ergebnis.	SupportRead (application/json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

POST/api/support/conversations/{id}/close¶

Support-Gespräch schließen

Dieses Projektgespräch beenden und ausstehende KI-Antworten abbrechen. Wiederholbar; bewahrt den Verlauf. Mitarbeiter können es in Slack wieder öffnen.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: keine
Operations-ID: closeSupportConversation

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/support/conversations/RESOURCE_ID/close'

Antworten

Status	Bedeutung	Textkörper und Header
200	Gespräch geschlossen.	SupportConversation (application/json)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)

GET/stream/support¶

Stream Support-Nachrichten

Projekt-Support-Nachrichten in jedem Plan als fortsetzbares SSE. event ist support.message; id ist die Projekt-Support-Sequenz, data ist SupportMessage. after hat Vorrang vor Last-Event-ID. Cursor 0 spielt den Verlauf ab. Mitarbeiter-, Kunden- und KI-Nachrichten werden nach Rolle unterschieden. Streams validieren Anmeldeinformationen und aktiven Projektzugang erneut.

Es werden keine Screenshots oder Anmeldedaten gesendet.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: keine
Operations-ID: streamSupportMessages

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
nach	Abfrage	optional	Projekt-Support-Nachrichtenfolge; setzt strikt nach dieser Position fort.
Last-Event-ID	Überschrift	optional

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/stream/support'

Antworten

Status	Bedeutung	Textkörper und Header
200	Support-Nachricht SSE.	string (text/event-stream)
Standard	Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.	Problem (application/problem+json)