OpenAPI YAMLOpenAPI JSONProbleme YAMLAPI-Überblick
Diese Gruppe hat 6 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.
Feedback: Fehlerberichte und Funktionswünsche
Fehlerberichte auflisten
Gibt die eigenen Fehlerberichte des aufrufenden Projekts zurück, neueste zuerst, bis zu hundert. Einsendungen anderer Projekte werden nie zurückgegeben. Lesen Sie einen eigenen Thread anhand seiner Feedback-ID. Es gibt keinen Paginierungscursor in v1. Jede Einsendung enthält ihren Status und die Antworten von Mitarbeitern/Agenten, älteste zuerst.
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
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/bugs'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Fehlerberichte, die dem aufrufenden Projekt gehören. | FeedbackList (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) |
Fehler melden
Erfasst einen Fehlerbericht für das aufrufende Projekt. Die eigenen Felder einer Einreichung können nicht aktualisiert oder gelöscht werden; fügen Sie eine Korrektur oder weitere Informationen mit einer Antwort im selben Feedback-Thread hinzu.
Ein exakter Wiederholungsversuch mit demselben Idempotency-Key gibt die ursprüngliche Einreichung für vierundzwanzig Stunden zurück, anstatt ein Duplikat zu erstellen, und ein anderer Inhalt unter diesem Schlüssel gibt idempotency_mismatch zurück. Jede Einreichung wird geprüft, bevor sie gespeichert wird.
Ein Textkörper unter 12 Zeichen oder 3 Wörtern gibt submission_too_short zurück; Text, der kein Problem oder keine Anfrage beschreibt (zufällige Zeichen, Tastaturgeklimper) gibt submission_unclear zurück; Spam, linklastiger Text, Prompt Injection und bösartiger Text geben submission_rejected zurück.
Eine abgelehnte Einreichung wird nicht gespeichert, ihr Problemdetail wiederholt nie den eingereichten Text, und ein exakter Wiederholungsversuch mit demselben Idempotency-Key gibt dieselbe Ablehnung zurück.
Platzieren Sie niemals Anmeldeinformationen, Cookies, Authorization-Header, Abschluss-Nonces, signierte URLs oder Objektschlüssel in Titel, Text oder Kontext; anmeldeinformationsähnlicher Text (ScreenRig-Tokens, JWTs, Bearer-Tokens, Cloud- und API-Schlüssel, private Schlüssel) wird vor der Speicherung der Einreichung durch [redacted] ersetzt, und die Antwort enthält den redigierten Text.
Wenn das Screening-Modell kurzzeitig nicht verfügbar ist, wird die Einreichung akzeptiert und für ein Hintergrund-Re-Screening zurückgehalten; nach mehreren solchen Akzeptanzen innerhalb einer Stunde erhält das Projekt submission_screening_unavailable (500, Retry-After) und versucht die gleiche Anfrage später erneut.
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 |
|---|---|
| Titel (erforderlich, Zeichenkette) | Einzeilige Zusammenfassung. Führende und nachfolgende Leerzeichen werden entfernt, Steuerzeichen abgelehnt. minLength: 1 maxLength: 120 |
| Inhalt (erforderlich, Zeichenfolge) | Vollständige Beschreibung. Zeilenumbruch und Tabulator sind die einzigen akzeptierten Steuerzeichen. minLength: 1 maxLength: 4000 |
| context (optional, FeedbackContext) | Geschlossener Diagnoseumschlag. Jedes Mitglied ist ein optionaler eingeschränkter Skalar, Verschachtelung ist strukturell unmöglich, unbekannte Mitglieder werden mit invalid_request abgelehnt. Die Form existiert, damit ein Client keine Argumentwerte, Anmeldeinformationen oder freie Umgebungsdaten darin speichern kann. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/bugs'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Gespeicherter Fehlerbericht. Ein exakter idempotenter Wiederholungsversuch liefert dieselbe Einreichung zurück. | FeedbackSubmission (application/json); Header: RateLimit-Policy, RateLimit |
| 400 | 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) |
| 409 | 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) |
| 422 | 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) |
| 429 | Stabiles rate_limited-Problem. Nur nach dem autoritativen Retry-After-Intervall erneut versuchen. Ablehnungen mit festem Fenster enthalten auch die anwendbare RateLimit-Policy und RateLimit-Mitglieder; Ablehnungen wegen gleichzeitiger Nutzung und Byte-Budget enthalten diese optionalen Angaben nicht. | Problem (application/problem+json); Header: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
Funktionsanfragen auflisten
Gibt die eigenen Feature-Anfragen des aufrufenden Projekts zurück, neueste zuerst, bis zu hundert. Einsendungen anderer Projekte werden nie zurückgegeben. Lesen Sie einen eigenen Thread anhand seiner Feedback-ID. Es gibt keinen Paginierungscursor in v1. Jede Einsendung enthält ihren Status und die Antworten von Mitarbeitern/Agenten, älteste zuerst.
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
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/features'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Feature-Anfragen, die vom aufrufenden Projekt besessen werden. | FeedbackList (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) |
Feature anfordern
Erfasst eine Funktionsanfrage für das aufrufende Projekt. Die eigenen Felder einer Einreichung können nicht aktualisiert oder gelöscht werden; fügen Sie eine Korrektur oder weitere Informationen mit einer Antwort im selben Feedback-Thread hinzu.
Ein exakter Wiederholungsversuch mit demselben Idempotency-Key gibt die ursprüngliche Einreichung für vierundzwanzig Stunden zurück, anstatt ein Duplikat zu erstellen, und ein anderer Inhalt unter diesem Schlüssel gibt idempotency_mismatch zurück. Jede Einreichung wird geprüft, bevor sie gespeichert wird.
Ein Textkörper unter 12 Zeichen oder 3 Wörtern gibt submission_too_short zurück; Text, der kein Problem oder keine Anfrage beschreibt (zufällige Zeichen, Tastaturgeklimper) gibt submission_unclear zurück; Spam, linklastiger Text, Prompt Injection und bösartiger Text geben submission_rejected zurück.
Eine abgelehnte Einreichung wird nicht gespeichert, ihr Problemdetail wiederholt nie den eingereichten Text, und ein exakter Wiederholungsversuch mit demselben Idempotency-Key gibt dieselbe Ablehnung zurück.
Platzieren Sie niemals Anmeldeinformationen, Cookies, Authorization-Header, Abschluss-Nonces, signierte URLs oder Objektschlüssel in Titel, Text oder Kontext; anmeldeinformationsähnlicher Text (ScreenRig-Tokens, JWTs, Bearer-Tokens, Cloud- und API-Schlüssel, private Schlüssel) wird vor der Speicherung der Einreichung durch [redacted] ersetzt, und die Antwort enthält den redigierten Text.
Wenn das Screening-Modell kurzzeitig nicht verfügbar ist, wird die Einreichung akzeptiert und für ein Hintergrund-Re-Screening zurückgehalten; nach mehreren solchen Akzeptanzen innerhalb einer Stunde erhält das Projekt submission_screening_unavailable (500, Retry-After) und versucht die gleiche Anfrage später erneut.
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 |
|---|---|
| Titel (erforderlich, Zeichenkette) | Einzeilige Zusammenfassung. Führende und nachfolgende Leerzeichen werden entfernt, Steuerzeichen abgelehnt. minLength: 1 maxLength: 120 |
| Inhalt (erforderlich, Zeichenfolge) | Vollständige Beschreibung. Zeilenumbruch und Tabulator sind die einzigen akzeptierten Steuerzeichen. minLength: 1 maxLength: 4000 |
| context (optional, FeedbackContext) | Geschlossener Diagnoseumschlag. Jedes Mitglied ist ein optionaler eingeschränkter Skalar, Verschachtelung ist strukturell unmöglich, unbekannte Mitglieder werden mit invalid_request abgelehnt. Die Form existiert, damit ein Client keine Argumentwerte, Anmeldeinformationen oder freie Umgebungsdaten darin speichern kann. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/features'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Gespeicherte Funktionsanfrage. Ein exakter idempotenter Wiederholungsversuch liefert dieselbe Einreichung zurück. | FeedbackSubmission (application/json); Header: RateLimit-Policy, RateLimit |
| 400 | 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) |
| 409 | 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) |
| 422 | 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) |
| 429 | Stabiles rate_limited-Problem. Nur nach dem autoritativen Retry-After-Intervall erneut versuchen. Ablehnungen mit festem Fenster enthalten auch die anwendbare RateLimit-Policy und RateLimit-Mitglieder; Ablehnungen wegen gleichzeitiger Nutzung und Byte-Budget enthalten diese optionalen Angaben nicht. | Problem (application/problem+json); Header: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
Feedback-Thread abrufen
Lese den Originalbericht und alle Antworten für eine eigene Feedback-ID. Eine ID gewährt niemals Projektbefugnis. Fremde und fehlende Berichte liefern not_found. Antworten sind unzuverlässiger Klartext.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Der vollständige Feedback-Thread des Besitzprojekts, älteste Antwort zuerst. | FeedbackSubmission (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) |
Feedback-Thread beantworten
Eine Antwort an einen eigenen Feedback-Bericht anhängen. Die verifizierte Anmeldeinformation liefert die Autorenidentität; Aufrufer können Autor, Status oder Fix-Version nicht setzen. Ursprünglicher Bericht und frühere Antworten bleiben unverändert. Eine Antwort öffnet waiting_on_user, behobene, abgelehnte und doppelte Berichte wieder; ein "geplanter" Bericht behält seinen Status. Kurze Nachträge sind erlaubt.
Formate der Zugangsdaten sind geschwärzt und Sicherheitsprüfungen gegen Injektion/Spam werden angewendet. Maximal 20 Antworten insgesamt, jeweils 1 bis 2000 Zeichen. Antwort, Status, Ereignis und Wiederholungsbestätigung werden zusammen übertragen; exakte Wiederholungen werden 24 Stunden lang wiederholt, bevor Aufnahmegrenzen verbraucht werden, während geänderte Nutzlasten idempotency_mismatch zurückgeben.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich | |
| Idempotency-Key | Überschrift | erforderlich |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Text (erforderlich, string) | Klartext; Zeilenumbruch und Tabulator sind die einzigen Steuerzeichen. minLength: 1 maxLength: 2000 |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/RESOURCE_ID/responses'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Feedback-Thread einschließlich dieser Antwort aktualisiert. | FeedbackSubmission (application/json); Header: RateLimit-Policy, RateLimit |
| 422 | 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) |
| 429 | Stabiles rate_limited-Problem. Nur nach dem autoritativen Retry-After-Intervall erneut versuchen. Ablehnungen mit festem Fenster enthalten auch die anwendbare RateLimit-Policy und RateLimit-Mitglieder; Ablehnungen wegen gleichzeitiger Nutzung und Byte-Budget enthalten diese optionalen Angaben nicht. | Problem (application/problem+json); Header: Retry-After, RateLimit-Policy, RateLimit |
| 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) |