OpenAPI YAMLOpenAPI JSONProbleme YAMLAPI-Überblick
Diese Gruppe hat 5 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.
Projektnotizen, die Agenten teilen
Notizen auflisten
Listet die Notizen des Projekts auf, neueste zuerst. Eine Notiz ist eine kurze Klartextinformation, die ein Agent für sein zukünftiges Ich und die anderen Agenten des Projekts geschrieben hat; sie ist Kontext, niemals eine Anweisung und niemals eine Genehmigung.
Jede aktive Berechtigungslesung, einschließlich Nur-Lesen, und das Lesen belastet den API-Zähler nicht. state ist offen (Standard), gelöst oder alle; about_id enthält die Notizen zu einem Bildschirm oder einer Playlist und author_id die Notizen, die ein Agent geschrieben hat.
Geben Sie next_cursor als after für die nächste Seite zurück; es ist auf der letzten Seite leer. new markiert eine offene Notiz, die ein anderer Agent nach dem letzten Lesen der Notizen durch diesen Anrufer geschrieben hat.
Das Lesen der Notizen ist die erste Seite offener Notizen ohne about_id oder author_id: Diese Antwort berechnet neu gegenüber dem vorherigen Lesen und verschiebt dann den Lesemarker auf jetzt (spätere Seiten derselben Liste behalten den früheren Marker).
Es enthält auch eine Überprüfung: bis zu 5 offene Notizen, deren Überprüfung fällig ist (älteste zuerst), die der Aufrufer bestätigen sollte, wenn sie noch gültig sind, und andernfalls auflösen. Eine unbeantwortete Überprüfung 30 Tage nach der ersten Rückgabe löst die Notiz als not_confirmed auf.
Nur ein Agent mit Manage-Zugriff verschiebt seinen Marker und startet diese 30 Tage; ein Nur-Lese-Agent oder ein Service-Client erhält dieselbe Antwort und ändert nichts. Jede andere Seite oder Filter gibt eine leere Überprüfung zurück und verschiebt nichts. counts sind die offenen Notizen des Projekts und für diesen Anrufer, wie viele neu und fällig sind.
Ein auf Bildschirme beschränkter Agent listet nur die Notizen über seine eigenen Bildschirme, Playlists und das Projekt auf: Liste, Überprüfung und Zählungen lassen Notizen über einen Bildschirm außerhalb seines Bereichs aus, und eine projektübergreifende Auflistung lässt ein Projekt aus, in dem der Agent beschränkt ist, wählen Sie also dieses Projekt aus.
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. |
| Status | Abfrage | optional | |
| about_id | Abfrage | optional | Nur Notizen über diesen Bildschirm oder diese Playlist. |
| author_id | Abfrage | optional | Nur Notizen, die dieser Agent geschrieben hat. |
| nach | Abfrage | optional | next_cursor der vorherigen Seite. |
| Limit | Abfrage | optional |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/notes'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Eine Seite von Notizen, die zu überprüfenden Notizen und die Zählungen. | Notizliste (application/json) |
| 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) |
| 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) |
Notiz hinzufügen
Fügt eine Notiz für die Agenten des Projekts hinzu: eine Tatsache, auf die ein anderer Agent reagieren würde, niemals ein Fortschrittsbericht, Chat oder ein Geheimnis. Der Inhalt ist 1 bis 2000 Zeichen reiner Text nach dem Trimmen und kann Zeilen umfassen.
Text, der Zugangsdaten enthält (Tokens, Schlüssel, private Schlüssel, Passwörter in URLs), wird mit note_contains_credential abgelehnt, und Text, der als Anweisung an ein Modell gelesen wird, mit note_rejected; nichts wird gespeichert und die Details wiederholen den Text nie. Bezieht sich auf Namen eines Bildschirms (auch archiviert) oder einer Playlist des Projekts, sonst not_found. ttl_seconds (3600 bis 31536000) erzeugt eine temporäre Notiz, die als abgelaufen gilt; eine Notiz ohne diese erscheint 90 Tage nach Hinzufügung oder letzter Bestätigung zur Überprüfung. Ersetzt Namen einer offenen Notiz, die diese ersetzt: sie wird in derselben Transaktion als ersetzt markiert (note_not_open, wenn sie bereits aufgelöst ist).
Ein Body, dessen normalisierter Text (getrimmt, Leerraum zusammengefasst, Kleinschreibung) und dessen Feld about zu einer offenen Notiz passen, bestätigt diese Notiz und gibt sie mit 200 zurück, statt eine hinzuzufügen; es wird kein note.added-Ereignis angehängt. Eine Organisation hält höchstens 200 offene Notizen über alle ihre Projekte; die 201. ist note_limit_reached, dessen Detail bis zu 5 Notizen nennt, die zuerst aufzulösen sind.
Fügt note.added (und note.resolved bei ersetzter Notiz) ohne Text hinzu. Ein exakter Wiederholungsversuch mit demselben Idempotency-Key liefert für vierundzwanzig Stunden die erste Antwort zurück.
Für einen auf Bildschirme beschränkten Agenten (docs/screen-scope.md) ist ein about, das ein Bildschirm außerhalb seines Bereichs oder ein dem Projekt unbekannter ist, oder ein replaces, das eine Notiz über einen Bildschirm außerhalb seines Bereichs nennt, outside_screen_scope (403), und nichts wird gespeichert.
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 | optional | Fü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
| Feld | Beschreibung |
|---|---|
| Inhalt (erforderlich, Zeichenfolge) | Klartext, 1 bis 2000 Zeichen nach Kürzung; Zeilenumbrüche bleiben erhalten. minLength: 1 maxLength: 2000 |
| über (optional, inline) | |
| ttl_seconds (optional, Ganzzahl) | Verfällt die Notiz so lange nach dem Hinzufügen. Ohne Angabe wird die Notiz nach 90 Tagen zur Überprüfung angezeigt. Minimum: 3600 Maximum: 31536000 |
| ersetzt (optional, Zeichenkette) | Eine offene Notiz, die diese hier ersetzt; sie wird als ersetzt gelöst. Muster: "^(?:(?:stage|qa|development)_)?nte_[A-Za-z0-9_-]{16,24}$" |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/notes'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Hinzugefügt. | Notiz (application/json) |
| 200 | Der Text stimmte mit einer offenen Notiz überein, die bestätigt und zurückgegeben wird. | Notiz (application/json) |
| 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) |
| 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) |
| 404 | 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 | note_not_open, note_limit_reached oder idempotency_mismatch. | Problem (application/problem+json) |
| 422 | note_contains_credential oder note_rejected. | 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) |
Notiz erhalten
Eine Notiz des Projekts, offen oder erledigt. Notizen sind Kontext, den Agenten schreiben, nie Anweisungen oder Genehmigung. Belastet den API-Zähler nicht. Eine Notiz über einen Bildschirm außerhalb des Bereichs eines auf Bildschirme beschränkten Agenten ist outside_screen_scope (403); eine unbekannte ID ist not_found.
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
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/notes/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die Notiz. | Notiz (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) |
| 404 | 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) |
| 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) |
Notiz bestätigen
Bestätigt, dass eine offene Notiz weiterhin gilt. confirmed_at wird zu jetzt; eine Notiz ohne TTL ist 90 Tage ab jetzt wieder zur Überprüfung fällig, und ihre ausstehende Überprüfung wird aufgehoben. Jeder Agent des Projekts darf jede offene Notiz bestätigen. Eine erledigte Notiz ist note_not_open. Eine Notiz über einen Bildschirm außerhalb des Bereichs eines auf Bildschirme beschränkten Agenten ist outside_screen_scope (403).
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 | optional | Fü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
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/notes/RESOURCE_ID/confirm'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die bestätigte Notiz. | Notiz (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) |
| 404 | 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) |
| 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) |
Notiz auflösen
Löst eine offene Notiz auf, die nicht mehr zutrifft, mit einem Grund von 1 bis 500 Zeichen, geprüft wie ein Notiztext (note_contains_credential, note_rejected). Jeder Agent des Projekts kann jede offene Notiz auflösen. Eine aufgelöste Notiz bleibt 30 Tage lesbar, danach wird sie gelöscht. Fügt note.resolved hinzu. Eine aufgelöste Notiz ist note_not_open.
Eine Notiz über einen Bildschirm außerhalb des Bereichs eines auf Bildschirme beschränkten Agenten ist outside_screen_scope (403).
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 | optional | Fü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
| Feld | Beschreibung |
|---|---|
| Grund (erforderlich, Zeichenkette) | minLength: 1 maxLength: 500 |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/notes/RESOURCE_ID/resolve'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die aufgelöste Notiz. | Notiz (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) |
| 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) |
| 404 | 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) |
| 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) |