screenRIG
Se connecterCommencer

Référence API

API Commentaires

Commentaires

Référence HTTP. Générée à partir du contrat backend. Parcourez les points de terminaison ci-dessous ou téléchargez OpenAPI.

OpenAPI YAMLOpenAPI JSONproblèmes YAMLVue d’ensemble de l’API

Ce groupe compte 9 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.

Commentaires

GET/api/comment/screen/{id}

Obtenir les commentaires d’écran

Commentaires opaques d’agent sur l’écran nommé. ScreenRig ne les lit ni n’utilise. Ils ne sont pas une autorisation et ne figurent pas dans le manifeste d’exécution. Un écran sans commentaires renvoie commentaires nul. Les écrans archivés restent adressables. Lecture authentifiée /api control-plane ; coûte 1 crédit.

Authentification
projectBearer
Corps de la requête
aucun
ID d’opération
getScreenComments

Paramètres

NomEnvoyerRequis ?Description
ScreenRig-Projecten-têteoptionnelObsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
idcheminobligatoire
Modèle de requête et réponses
shell · modèle de requête
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

Réponses

StatutSensCorps et en-têtes
200CommentairesCommentaires (application/json)
403

outside_screen_scope - l’appelant est limité aux écrans et l’écran, le dossier d’écrans, le sélecteur ou l’audience que la requête nomme ou atteint est en dehors de ceux-ci (docs/screen-scope.md). Un ID en dehors du périmètre et un ID qui n’existe pas obtiennent la même réponse ; errors[0].screen_scope porte le périmètre de l’appelant, et l’écriture est refusée en entier, jamais restreinte.

Problème (application/problem+json)
par défaut

Réponse stable RFC 9457 à un problème. 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 (application/problem+json)
PUT/api/comment/screen/{id}

Mettre les commentaires d’écran

Remplace les commentaires opaques d’agent sur l’écran nommé. La valeur commentaires doit être un objet JSON dont la forme UTF-8 compacte fait au plus 1024 octets. Dernier écrit gagne uniquement sur le champ commentaires ; la révision, updated_at et le manifeste d’exécution restent inchangés.

Authentification
projectBearer
Corps de la requête
ÉcrireCommentaires
ID d’opération
putScreenComments

Paramètres

NomEnvoyerRequis ?Description
ScreenRig-Projecten-têteoptionnelObsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
idcheminobligatoire
Idempotency-Keyen-têteoptionnelOmettre 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

ChampDescription
commentaires (obligatoire, objet)

Objet JSON opaque d’agent. La sérialisation compacte UTF-8 doit faire au plus 1024 octets. Objets imbriqués, tableaux et chaînes autorisés. Tableaux, chaînes, nombres, booléens et null sont refusés comme valeur de commentaires elle-même.

Modèle de requête et réponses
shell · modèle de requête
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'

Réponses

StatutSensCorps et en-têtes
200CommentairesCommentaires (application/json)
403

outside_screen_scope - l’appelant est limité aux écrans et l’écran, le dossier d’écrans, le sélecteur ou l’audience que la requête nomme ou atteint est en dehors de ceux-ci (docs/screen-scope.md). Un ID en dehors du périmètre et un ID qui n’existe pas obtiennent la même réponse ; errors[0].screen_scope porte le périmètre de l’appelant, et l’écriture est refusée en entier, jamais restreinte.

Problème (application/problem+json)
par défaut

Réponse stable RFC 9457 à un problème. 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 (application/problem+json)
SUPPRIMER/api/comment/screen/{id}

Supprimer les commentaires de l’écran

Supprime les commentaires de l’écran. Idempotent si déjà supprimé. Ne modifie pas la révision ni ne recrée le manifeste d’exécution.

Authentification
projectBearer
Corps de la requête
aucun
ID d’opération
deleteScreenComments

Paramètres

NomEnvoyerRequis ?Description
ScreenRig-Projecten-têteoptionnelObsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
idcheminobligatoire
Idempotency-Keyen-têteoptionnelOmettre 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
shell · modèle de requête
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

Réponses

StatutSensCorps et en-têtes
204Non définipas de corps
403

outside_screen_scope - l’appelant est limité aux écrans et l’écran, le dossier d’écrans, le sélecteur ou l’audience que la requête nomme ou atteint est en dehors de ceux-ci (docs/screen-scope.md). Un ID en dehors du périmètre et un ID qui n’existe pas obtiennent la même réponse ; errors[0].screen_scope porte le périmètre de l’appelant, et l’écriture est refusée en entier, jamais restreinte.

Problème (application/problem+json)
par défaut

Réponse stable RFC 9457 à un problème. 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 (application/problem+json)
GET/api/comment/playlist/{id}

Obtenir les commentaires de la liste de lecture

Commentaires opaques d’agent sur la liste de lecture nommée. ScreenRig ne les lit ni n’utilise. Une liste de lecture sans commentaires renvoie commentaires nul. Lecture authentifiée /api control-plane ; coûte 1 crédit.

Authentification
projectBearer
Corps de la requête
aucun
ID d’opération
getPlaylistComments

Paramètres

NomEnvoyerRequis ?Description
ScreenRig-Projecten-têteoptionnelObsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
idcheminobligatoire
Modèle de requête et réponses
shell · modèle de requête
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

Réponses

StatutSensCorps et en-têtes
200CommentairesCommentaires (application/json)
par défaut

Réponse stable RFC 9457 à un problème. 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 (application/problem+json)
PUT/api/comment/playlist/{id}

Mettre les commentaires de la liste de lecture

Remplace les commentaires opaques d’agent sur la liste de lecture nommée. Le JSON UTF-8 compact de l’objet commentaires doit faire au plus 1024 octets. Dernier écrit gagne uniquement sur le champ commentaires ; la révision et le manifeste d’exécution restent inchangés.

Authentification
projectBearer
Corps de la requête
ÉcrireCommentaires
ID d’opération
putPlaylistComments

Paramètres

NomEnvoyerRequis ?Description
ScreenRig-Projecten-têteoptionnelObsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
idcheminobligatoire
Idempotency-Keyen-têteoptionnelOmettre 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

ChampDescription
commentaires (obligatoire, objet)

Objet JSON opaque d’agent. La sérialisation compacte UTF-8 doit faire au plus 1024 octets. Objets imbriqués, tableaux et chaînes autorisés. Tableaux, chaînes, nombres, booléens et null sont refusés comme valeur de commentaires elle-même.

Modèle de requête et réponses
shell · modèle de requête
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'

Réponses

StatutSensCorps et en-têtes
200CommentairesCommentaires (application/json)
par défaut

Réponse stable RFC 9457 à un problème. 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 (application/problem+json)
SUPPRIMER/api/comment/playlist/{id}

Supprimer les commentaires de la liste de lecture

Supprime les commentaires de la liste de lecture. Idempotent si déjà supprimé. Ne modifie pas la révision ni ne recrée le manifeste d’exécution.

Authentification
projectBearer
Corps de la requête
aucun
ID d’opération
deletePlaylistComments

Paramètres

NomEnvoyerRequis ?Description
ScreenRig-Projecten-têteoptionnelObsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
idcheminobligatoire
Idempotency-Keyen-têteoptionnelOmettre 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
shell · modèle de requête
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

Réponses

StatutSensCorps et en-têtes
204Non définipas de corps
par défaut

Réponse stable RFC 9457 à un problème. 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 (application/problem+json)
GET/api/comment/playlist/{id}/page/{page_id}

Obtenir les commentaires de la page de la liste de lecture

Commentaires opaques d’agent sur une page de liste de lecture, adressés par la chaîne d’id de la page. Une page sans commentaires renvoie commentaires nul. Liste de lecture ou page manquante est not_found. Lecture authentifiée /api control-plane ; coûte 1 crédit.

Authentification
projectBearer
Corps de la requête
aucun
ID d’opération
getPlaylistPageComments

Paramètres

NomEnvoyerRequis ?Description
ScreenRig-Projecten-têteoptionnelObsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
idcheminobligatoire
page_idcheminobligatoireChaîne d’identification de la page de la liste de lecture.
Modèle de requête et réponses
shell · modèle de requête
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

Réponses

StatutSensCorps et en-têtes
200CommentairesCommentaires (application/json)
par défaut

Réponse stable RFC 9457 à un problème. 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 (application/problem+json)
PUT/api/comment/playlist/{id}/page/{page_id}

Mettre les commentaires de la page de la liste de lecture

Remplace les commentaires opaques d’agent sur une page de liste de lecture. Le JSON UTF-8 compact de l’objet commentaires doit faire au plus 1024 octets. Dernier écrit gagne uniquement sur le champ commentaires de cette page ; la révision de la liste de lecture et le manifeste d’exécution restent inchangés.

Authentification
projectBearer
Corps de la requête
ÉcrireCommentaires
ID d’opération
putPlaylistPageComments

Paramètres

NomEnvoyerRequis ?Description
ScreenRig-Projecten-têteoptionnelObsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
idcheminobligatoire
page_idcheminobligatoireChaîne d’identification de la page de la liste de lecture.
Idempotency-Keyen-têteoptionnelOmettre 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

ChampDescription
commentaires (obligatoire, objet)

Objet JSON opaque d’agent. La sérialisation compacte UTF-8 doit faire au plus 1024 octets. Objets imbriqués, tableaux et chaînes autorisés. Tableaux, chaînes, nombres, booléens et null sont refusés comme valeur de commentaires elle-même.

Modèle de requête et réponses
shell · modèle de requête
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'

Réponses

StatutSensCorps et en-têtes
200CommentairesCommentaires (application/json)
par défaut

Réponse stable RFC 9457 à un problème. 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 (application/problem+json)
SUPPRIMER/api/comment/playlist/{id}/page/{page_id}

Supprimer les commentaires de la page de la liste de lecture

Supprime les commentaires sur une page de liste de lecture. Idempotent si déjà supprimé. Ne modifie pas la révision ni ne recrée le manifeste d’exécution.

Authentification
projectBearer
Corps de la requête
aucun
ID d’opération
deletePlaylistPageComments

Paramètres

NomEnvoyerRequis ?Description
ScreenRig-Projecten-têteoptionnelObsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
idcheminobligatoire
page_idcheminobligatoireChaîne d’identification de la page de la liste de lecture.
Idempotency-Keyen-têteoptionnelOmettre 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
shell · modèle de requête
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

Réponses

StatutSensCorps et en-têtes
204Non définipas de corps
par défaut

Réponse stable RFC 9457 à un problème. 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 (application/problem+json)