OpenAPI YAMLOpenAPI JSONproblèmes YAMLVue d’ensemble de l’API
Ce groupe compte 4 opérations, générées à partir de api/openapi.yaml. Filtrez par chemin, action ou authentification. Chaque point de terminaison liste ses entrées ; développez-le pour voir un modèle de requête et les codes de réponse. Les modèles demandent vos propres valeurs et un corps conforme au schéma.
Remplacez les espaces réservés en majuscules par vos valeurs. Pour une requête JSON, enregistrez un corps correspondant au schéma dans request.json. Les exemples de cookies utilisent un pot à cookies local issu d’une session authentifiée.
K/V d’application d’exécution
Lister les paires clé/valeur d’exécution
Retourne au maximum 200 entrées dans l’ordre croissant des clés et ne pagine pas ; un espace de noms avec plus de clés est seulement partiellement listé. Liste les métadonnées pour une application que le contenu actuel de l’écran détient.
Le KV d’exécution est autorisé par la session d’exécution du Lecteur (kv.read, et kv.write pour les écritures) et la subvention actuelle de l’écran, qui doit détenir une version prête de l’application ; un en-tête ScreenRig-Primitive-Capability est ignoré. Les images téléversées n’appellent jamais ces routes et doivent utiliser le pont SDK parent validé.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| application_id | chemin | obligatoire |
Modèle de requête et réponses
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | KV d’application autorisée par le manifeste | Liste RuntimeKV (application/json) |
| par défaut | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
Obtenir Runtime KV
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| application_id | chemin | obligatoire | |
| clé | chemin | obligatoire |
Modèle de requête et réponses
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Valeur KV d’application autorisée par le manifeste | Entrée RuntimeKV (application/json) |
| par défaut | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
Mettre KV d’exécution
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| application_id | chemin | obligatoire | |
| clé | chemin | obligatoire | |
| If-Match | en-tête | optionnel | Révision positive optionnelle de ressource. Omettre pour créer ou écraser une clé ; une révision périmée fournie est revision_conflict. |
| Idempotency-Key | en-tête | optionnel | Omettre pour une opération fraîche. Fournissez et réutilisez une clé pour dédupliquer les tentatives ; le CLI gère les clés automatiquement. |
Champs du corps de la requête
| Champ | Description |
|---|---|
| value_base64 (obligatoire, chaîne) | maxLength : 1398104 |
| content_type (optionnel, chaîne) | par défaut : « application/octet-stream » minLength : 1 maxLength : 127 |
Modèle de requête et réponses
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'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Mutation KV de l’appareil jumelé | Entrée RuntimeKV (application/json) ; en-têtes : RateLimit-Policy, RateLimit |
| par défaut | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
Supprimer Runtime KV
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| application_id | chemin | obligatoire | |
| clé | chemin | obligatoire | |
| If-Match | en-tête | optionnel | Révision positive optionnelle de ressource. Omettre pour écrire la ressource actuelle ; une révision périmée fournie est revision_conflict. |
| Idempotency-Key | en-tête | optionnel | Omettre pour une opération fraîche. Fournissez et réutilisez une clé pour dédupliquer les tentatives ; le CLI gère les clés automatiquement. |
Modèle de requête et réponses
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 204 | Suppression KV de l’appareil jumelé | pas de corps; en-têtes : RateLimit-Policy, RateLimit |
| par défaut | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |