OpenAPI YAMLOpenAPI JSONProbleme YAMLAPI-Überblick
Diese Gruppe hat 4 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.
Laufzeit-Anwendungs-K/V
Runtime-KV auflisten
Gibt höchstens 200 Einträge in aufsteigender Schlüsselreihenfolge zurück und paginiert nicht; ein Namespace mit mehr Schlüsseln wird nur teilweise aufgelistet. Listet Metadaten für eine Anwendung, die der aktuelle Inhalt des Bildschirms hält.
Runtime KV wird von der Laufzeitsitzung des Players autorisiert (kv.read und kv.write für Schreibvorgänge) und der aktuellen Berechtigung des Bildschirms, die eine freigegebene Version der Anwendung enthalten muss; ein ScreenRig-Primitive-Capability-Header wird ignoriert. Hochgeladene Frames rufen diese Routen nie auf und müssen die validierte übergeordnete SDK-Brücke verwenden.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| application_id | Pfad | erforderlich |
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Manifest-autorisierte Anwendungs-KV | RuntimeKVList (application/json) |
| Standard | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). 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. | RuntimeProblem (application/problem+json) |
Runtime KV erhalten
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| application_id | Pfad | erforderlich | |
| key | Pfad | erforderlich |
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Manifest-autorisierter Anwendungs-KV-Wert | RuntimeKVEntry (application/json) |
| Standard | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). 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. | RuntimeProblem (application/problem+json) |
Laufzeit-KV einstellen
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| application_id | Pfad | erforderlich | |
| key | Pfad | erforderlich | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um einen Schlüssel zu erstellen oder zu überschreiben; eine übergebene veraltete Revision ist revision_conflict. |
| 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 |
|---|---|
| value_base64 (erforderlich, Zeichenfolge) | maxLength: 1398104 |
| content_type (optional, Zeichenfolge) | Standard: "application/octet-stream" minLength: 1 maxLength: 127 |
Anfragevorlage und Antworten
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Änderung von Schlüssel-Wert-Daten des verbundenen Geräts | RuntimeKVEntry (application/json); Header: RateLimit-Policy, RateLimit |
| Standard | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). 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. | RuntimeProblem (application/problem+json) |
Runtime-KV löschen
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| application_id | Pfad | erforderlich | |
| key | Pfad | erforderlich | |
| If-Match | Überschrift | optional | Optionale positive Ressourcenrevision. Weglassen, um die aktuelle Ressource zu schreiben; eine übergebene veraltete Revision ist revision_conflict. |
| 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 DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 204 | Löschen von Schlüssel-Wert-Daten des verbundenen Geräts | kein Körper; Header: RateLimit-Policy, RateLimit |
| Standard | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). 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. | RuntimeProblem (application/problem+json) |