screenRIG
AccediInizia

Riferimento API

API Commenti

Commenti

Riferimento HTTP. Generato dal contratto backend. Esplora gli endpoint qui sotto o scarica OpenAPI.

OpenAPI YAMLOpenAPI JSONproblemi YAMLPanoramica dell’API

Questo gruppo ha 9 operazioni, generate da api/openapi.yaml. Filtra per percorso, azione o autenticazione. Ogni endpoint elenca i suoi input; espandilo per vedere un modello di richiesta e i codici di risposta. I modelli richiedono i tuoi valori e un corpo valido secondo lo schema.

Sostituisci i segnaposto maiuscoli con i tuoi valori. Per una richiesta JSON, salva un corpo che corrisponde allo schema in request.json. Gli esempi di cookie usano un cookie jar locale da una sessione autenticata.

Commenti

GET/api/comment/screen/{id}

Ottieni commenti schermo

Commenti agente opachi sullo schermo nominato. ScreenRig non li legge né usa. Non sono autorizzazioni e non sono nel manifest runtime. Uno schermo senza commenti restituisce comments null. Gli schermi archiviati restano indirizzabili. Lettura autenticata /api control-plane; costa 1 credito.

Autenticazione
projectBearer
Corpo della richiesta
nessuno
ID operazione
getScreenComments

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
idpathobbligatorio
Modello richiesta e risposte
shell · modello richiesta
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

Risposte

StatoSignificatoCorpo e intestazioni
200CommentiCommenti (application/json)
403

outside_screen_scope - il chiamante è limitato agli schermi e lo schermo, la cartella di schermi, il selettore o il pubblico che la richiesta nomina o raggiunge è fuori da essi (docs/screen-scope.md). Un id fuori dall’ambito e un id che non esiste ricevono la stessa risposta; errors[0].screen_scope riporta l’ambito del chiamante, e la scrittura viene rifiutata per intero, mai ridotta.

Problema (application/problem+json)
predefinito

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
PUT/api/comment/screen/{id}

Inserisci commenti schermo

Sostituisce i commenti agent opachi sullo schermo nominato. Il valore commenti deve essere un oggetto JSON la cui forma UTF-8 compatta è al massimo di 1024 byte. Ultima scrittura vince solo sul campo commenti; revisione, updated_at e manifest runtime restano invariati.

Autenticazione
projectBearer
Corpo della richiesta
CommentsWrite
ID operazione
putScreenComments

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
idpathobbligatorio
Idempotency-KeyintestazioneopzionaleOmetti per un’operazione fresca. Fornisci e riutilizza una chiave per deduplicare i retry; la CLI gestisce automaticamente le chiavi.

Campi del corpo della richiesta

CampoDescrizione
commenti (obbligatorio, oggetto)

Oggetto JSON agente opaco. La serializzazione UTF-8 compatta deve essere al massimo di 1024 byte. Sono ammessi oggetti annidati, array e stringhe. Array, stringhe, numeri, booleani e null sono rifiutati come valore dei commenti stessi.

Modello richiesta e risposte
shell · modello richiesta
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'

Risposte

StatoSignificatoCorpo e intestazioni
200CommentiCommenti (application/json)
403

outside_screen_scope - il chiamante è limitato agli schermi e lo schermo, la cartella di schermi, il selettore o il pubblico che la richiesta nomina o raggiunge è fuori da essi (docs/screen-scope.md). Un id fuori dall’ambito e un id che non esiste ricevono la stessa risposta; errors[0].screen_scope riporta l’ambito del chiamante, e la scrittura viene rifiutata per intero, mai ridotta.

Problema (application/problem+json)
predefinito

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
ELIMINA/api/comment/screen/{id}

Elimina commenti schermo

Rimuove i commenti dello schermo. Operazione idempotente se già rimossi. Non aggiorna la revisione né rigenera il manifesto di runtime.

Autenticazione
projectBearer
Corpo della richiesta
nessuno
ID operazione
deleteScreenComments

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
idpathobbligatorio
Idempotency-KeyintestazioneopzionaleOmetti per un’operazione fresca. Fornisci e riutilizza una chiave per deduplicare i retry; la CLI gestisce automaticamente le chiavi.
Modello richiesta e risposte
shell · modello richiesta
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

Risposte

StatoSignificatoCorpo e intestazioni
204Non impostatonessun corpo
403

outside_screen_scope - il chiamante è limitato agli schermi e lo schermo, la cartella di schermi, il selettore o il pubblico che la richiesta nomina o raggiunge è fuori da essi (docs/screen-scope.md). Un id fuori dall’ambito e un id che non esiste ricevono la stessa risposta; errors[0].screen_scope riporta l’ambito del chiamante, e la scrittura viene rifiutata per intero, mai ridotta.

Problema (application/problem+json)
predefinito

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
GET/api/comment/playlist/{id}

Ottieni commenti playlist

Commenti agente opachi sulla playlist nominata. ScreenRig non li legge né usa. Una playlist senza commenti restituisce comments null. Lettura autenticata /api control-plane; costa 1 credito.

Autenticazione
projectBearer
Corpo della richiesta
nessuno
ID operazione
getPlaylistComments

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
idpathobbligatorio
Modello richiesta e risposte
shell · modello richiesta
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

Risposte

StatoSignificatoCorpo e intestazioni
200CommentiCommenti (application/json)
predefinito

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
PUT/api/comment/playlist/{id}

Inserisci commenti playlist

Sostituisce i commenti agent opachi sulla playlist nominata. Il JSON UTF-8 compatto dell’oggetto commenti deve essere al massimo di 1024 byte. Ultima scrittura vince solo sul campo commenti; revisione e manifest runtime restano invariati.

Autenticazione
projectBearer
Corpo della richiesta
CommentsWrite
ID operazione
putPlaylistComments

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
idpathobbligatorio
Idempotency-KeyintestazioneopzionaleOmetti per un’operazione fresca. Fornisci e riutilizza una chiave per deduplicare i retry; la CLI gestisce automaticamente le chiavi.

Campi del corpo della richiesta

CampoDescrizione
commenti (obbligatorio, oggetto)

Oggetto JSON agente opaco. La serializzazione UTF-8 compatta deve essere al massimo di 1024 byte. Sono ammessi oggetti annidati, array e stringhe. Array, stringhe, numeri, booleani e null sono rifiutati come valore dei commenti stessi.

Modello richiesta e risposte
shell · modello richiesta
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'

Risposte

StatoSignificatoCorpo e intestazioni
200CommentiCommenti (application/json)
predefinito

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
ELIMINA/api/comment/playlist/{id}

Elimina commenti playlist

Rimuove commenti dalle playlist. Idempotente se già rimosso. Non incrementa la revisione né rigenera il manifesto runtime.

Autenticazione
projectBearer
Corpo della richiesta
nessuno
ID operazione
deletePlaylistComments

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
idpathobbligatorio
Idempotency-KeyintestazioneopzionaleOmetti per un’operazione fresca. Fornisci e riutilizza una chiave per deduplicare i retry; la CLI gestisce automaticamente le chiavi.
Modello richiesta e risposte
shell · modello richiesta
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

Risposte

StatoSignificatoCorpo e intestazioni
204Non impostatonessun corpo
predefinito

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
GET/api/comment/playlist/{id}/page/{page_id}

Ottieni commenti pagina playlist

Commenti agente opachi su una pagina playlist, indirizzati dalla stringa id pagina. Una pagina senza commenti restituisce comments null. Playlist o pagina mancanti sono not_found. Lettura autenticata /api control-plane; costa 1 credito.

Autenticazione
projectBearer
Corpo della richiesta
nessuno
ID operazione
getPlaylistPageComments

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
idpathobbligatorio
page_idpathobbligatorioID stringa pagina playlist.
Modello richiesta e risposte
shell · modello richiesta
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

Risposte

StatoSignificatoCorpo e intestazioni
200CommentiCommenti (application/json)
predefinito

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
PUT/api/comment/playlist/{id}/page/{page_id}

Inserisci commenti pagina playlist

Sostituisce i commenti agent opachi su una pagina playlist. Il JSON UTF-8 compatto dell’oggetto commenti deve essere al massimo di 1024 byte. Ultima scrittura vince solo sul campo commenti di quella pagina; revisione playlist e manifest runtime restano invariati.

Autenticazione
projectBearer
Corpo della richiesta
CommentsWrite
ID operazione
putPlaylistPageComments

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
idpathobbligatorio
page_idpathobbligatorioID stringa pagina playlist.
Idempotency-KeyintestazioneopzionaleOmetti per un’operazione fresca. Fornisci e riutilizza una chiave per deduplicare i retry; la CLI gestisce automaticamente le chiavi.

Campi del corpo della richiesta

CampoDescrizione
commenti (obbligatorio, oggetto)

Oggetto JSON agente opaco. La serializzazione UTF-8 compatta deve essere al massimo di 1024 byte. Sono ammessi oggetti annidati, array e stringhe. Array, stringhe, numeri, booleani e null sono rifiutati come valore dei commenti stessi.

Modello richiesta e risposte
shell · modello richiesta
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'

Risposte

StatoSignificatoCorpo e intestazioni
200CommentiCommenti (application/json)
predefinito

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
ELIMINA/api/comment/playlist/{id}/page/{page_id}

Elimina commenti pagina playlist

Rimuove commenti da una pagina playlist. Idempotente se già rimosso. Non incrementa la revisione né rigenera il manifesto runtime.

Autenticazione
projectBearer
Corpo della richiesta
nessuno
ID operazione
deletePlaylistPageComments

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
idpathobbligatorio
page_idpathobbligatorioID stringa pagina playlist.
Idempotency-KeyintestazioneopzionaleOmetti per un’operazione fresca. Fornisci e riutilizza una chiave per deduplicare i retry; la CLI gestisce automaticamente le chiavi.
Modello richiesta e risposte
shell · modello richiesta
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

Risposte

StatoSignificatoCorpo e intestazioni
204Non impostatonessun corpo
predefinito

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)