screenRIG
AnmeldenErste Schritte

API-Referenz

Kommentare-API

Kommentare

HTTP-Referenz. Generiert aus dem Backend-Vertrag. Durchsuchen Sie die Endpunkte unten oder laden Sie OpenAPI herunter.

OpenAPI YAMLOpenAPI JSONProbleme YAMLAPI-Ü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.

Kommentare

GET/api/comment/screen/{id}

Bildschirmkommentare erhalten

Undurchsichtige Agentenkommentare auf dem benannten Bildschirm. ScreenRig liest oder verwendet sie nicht. Sie sind keine Autorisierung und sind nicht im Laufzeitmanifest. Ein Bildschirm ohne Kommentare gibt comments null zurück. Archivierte Bildschirme bleiben adressierbar. Authentifizierter /api control-plane Lesezugriff; kostet 1 Kredit.

Authentifizierung
projectBearer
Anfrageinhalt
keine
Operations-ID
getScreenComments

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
idPfaderforderlich
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

Antworten

StatusBedeutungTextkörper und Header
200KommentareKommentare (application/json)
403

outside_screen_scope - der Aufrufer ist auf Bildschirme beschränkt, und der Bildschirm, Bildschirmordner, Selektor oder die Zielgruppe, die die Anfrage nennt oder erreicht, liegt außerhalb davon (docs/screen-scope.md). Eine ID außerhalb des Bereichs und eine ID, die nicht existiert, erhalten dieselbe Antwort; errors[0].screen_scope trägt den Bereich des Aufrufers, und der Schreibvorgang wird vollständig abgelehnt, nie eingegrenzt.

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/comment/screen/{id}

Bildschirm-Kommentare einstellen

Ersetzt undurchsichtige Agentenkommentare auf dem benannten Bildschirm. Der Kommentarwert muss ein JSON-Objekt sein, dessen kompakte UTF-8-Form höchstens 1024 Bytes groß ist. Last-write-wins nur im Kommentarfeld; Revision, updated_at und Laufzeitmanifest bleiben unverändert.

Authentifizierung
projectBearer
Anfrageinhalt
Kommentare schreiben
Operations-ID
putScreenComments

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
idPfaderforderlich
Idempotency-KeyÜberschriftoptionalFür einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch.

Anfrageinhalt-Felder

FeldBeschreibung
Kommentare (erforderlich, Objekt)

Undurchsichtiges Agent-JSON-Objekt. Kompakte UTF-8-Serialisierung darf höchstens 1024 Bytes groß sein. Verschachtelte Objekte, Arrays und Strings sind erlaubt. Arrays, Strings, Zahlen, Booleans und null werden als Wert für comments selbst abgelehnt.

Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

Antworten

StatusBedeutungTextkörper und Header
200KommentareKommentare (application/json)
403

outside_screen_scope - der Aufrufer ist auf Bildschirme beschränkt, und der Bildschirm, Bildschirmordner, Selektor oder die Zielgruppe, die die Anfrage nennt oder erreicht, liegt außerhalb davon (docs/screen-scope.md). Eine ID außerhalb des Bereichs und eine ID, die nicht existiert, erhalten dieselbe Antwort; errors[0].screen_scope trägt den Bereich des Aufrufers, und der Schreibvorgang wird vollständig abgelehnt, nie eingegrenzt.

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)
LÖSCHEN/api/comment/screen/{id}

Bildschirm-Kommentare löschen

Setzt Bildschirmkommentare zurück. Idempotent, wenn bereits zurückgesetzt. Erhöht nicht die Revision und erstellt das Laufzeitmanifest nicht neu.

Authentifizierung
projectBearer
Anfrageinhalt
keine
Operations-ID
deleteScreenComments

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
idPfaderforderlich
Idempotency-KeyÜberschriftoptionalFür einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch.
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

Antworten

StatusBedeutungTextkörper und Header
204Nicht gesetztkein Körper
403

outside_screen_scope - der Aufrufer ist auf Bildschirme beschränkt, und der Bildschirm, Bildschirmordner, Selektor oder die Zielgruppe, die die Anfrage nennt oder erreicht, liegt außerhalb davon (docs/screen-scope.md). Eine ID außerhalb des Bereichs und eine ID, die nicht existiert, erhalten dieselbe Antwort; errors[0].screen_scope trägt den Bereich des Aufrufers, und der Schreibvorgang wird vollständig abgelehnt, nie eingegrenzt.

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/comment/playlist/{id}

Playlist-Kommentare erhalten

Undurchsichtige Agentenkommentare auf der benannten Playlist. ScreenRig liest oder verwendet sie nicht. Eine Playlist ohne Kommentare gibt comments null zurück. Authentifizierter /api control-plane Lesezugriff; kostet 1 Kredit.

Authentifizierung
projectBearer
Anfrageinhalt
keine
Operations-ID
getPlaylistComments

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
idPfaderforderlich
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

Antworten

StatusBedeutungTextkörper und Header
200KommentareKommentare (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)
PUT/api/comment/playlist/{id}

Playlist-Kommentare einstellen

Ersetzt undurchsichtige Agentenkommentare auf der benannten Playlist. Kompakter UTF-8-JSON des Kommentarobjekts darf höchstens 1024 Bytes groß sein. Last-write-wins nur im Kommentarfeld; Revision und Laufzeitmanifest bleiben unverändert.

Authentifizierung
projectBearer
Anfrageinhalt
Kommentare schreiben
Operations-ID
putPlaylistComments

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
idPfaderforderlich
Idempotency-KeyÜberschriftoptionalFür einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch.

Anfrageinhalt-Felder

FeldBeschreibung
Kommentare (erforderlich, Objekt)

Undurchsichtiges Agent-JSON-Objekt. Kompakte UTF-8-Serialisierung darf höchstens 1024 Bytes groß sein. Verschachtelte Objekte, Arrays und Strings sind erlaubt. Arrays, Strings, Zahlen, Booleans und null werden als Wert für comments selbst abgelehnt.

Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

Antworten

StatusBedeutungTextkörper und Header
200KommentareKommentare (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)
LÖSCHEN/api/comment/playlist/{id}

Playlist-Kommentare löschen

Setzt Playlist-Kommentare zurück. Idempotent, wenn bereits zurückgesetzt. Erhöht nicht die Revision und erstellt das Laufzeitmanifest nicht neu.

Authentifizierung
projectBearer
Anfrageinhalt
keine
Operations-ID
deletePlaylistComments

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
idPfaderforderlich
Idempotency-KeyÜberschriftoptionalFür einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch.
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

Antworten

StatusBedeutungTextkörper und Header
204Nicht gesetztkein Körper
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/comment/playlist/{id}/page/{page_id}

Playlist-Seitenkommentare erhalten

Undurchsichtige Agentenkommentare auf einer Playlist-Seite, adressiert durch die Seiten-ID-Zeichenfolge. Eine Seite ohne Kommentare gibt comments null zurück. Fehlende Playlist oder Seite ist not_found. Authentifizierter /api control-plane Lesezugriff; kostet 1 Kredit.

Authentifizierung
projectBearer
Anfrageinhalt
keine
Operations-ID
getPlaylistPageComments

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
idPfaderforderlich
page_idPfaderforderlichPlaylist-Seiten-ID-String.
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

Antworten

StatusBedeutungTextkörper und Header
200KommentareKommentare (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)
PUT/api/comment/playlist/{id}/page/{page_id}

Playlist-Seitenkommentare einstellen

Ersetzt undurchsichtige Agentenkommentare auf einer Playlist-Seite. Kompakter UTF-8-JSON des Kommentarobjekts darf höchstens 1024 Bytes groß sein. Last-write-wins nur im Kommentarfeld dieser Seite; Playlist-Revision und Laufzeitmanifest bleiben unverändert.

Authentifizierung
projectBearer
Anfrageinhalt
Kommentare schreiben
Operations-ID
putPlaylistPageComments

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
idPfaderforderlich
page_idPfaderforderlichPlaylist-Seiten-ID-String.
Idempotency-KeyÜberschriftoptionalFür einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch.

Anfrageinhalt-Felder

FeldBeschreibung
Kommentare (erforderlich, Objekt)

Undurchsichtiges Agent-JSON-Objekt. Kompakte UTF-8-Serialisierung darf höchstens 1024 Bytes groß sein. Verschachtelte Objekte, Arrays und Strings sind erlaubt. Arrays, Strings, Zahlen, Booleans und null werden als Wert für comments selbst abgelehnt.

Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

Antworten

StatusBedeutungTextkörper und Header
200KommentareKommentare (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)
LÖSCHEN/api/comment/playlist/{id}/page/{page_id}

Playlist-Seitenkommentare löschen

Setzt Kommentare auf einer Playlist-Seite zurück. Idempotent, wenn bereits zurückgesetzt. Erhöht nicht die Revision und erstellt das Laufzeitmanifest nicht neu.

Authentifizierung
projectBearer
Anfrageinhalt
keine
Operations-ID
deletePlaylistPageComments

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
idPfaderforderlich
page_idPfaderforderlichPlaylist-Seiten-ID-String.
Idempotency-KeyÜberschriftoptionalFür einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch.
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

Antworten

StatusBedeutungTextkörper und Header
204Nicht gesetztkein Körper
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)