Comentários: referência da API, endpoints e exemplos

OpenAPI YAML OpenAPI JSON problemas YAML Visão geral da API

Este grupo tem 9 operações, geradas a partir de api/openapi.yaml. Filtre por caminho, ação ou autenticação. Cada endpoint lista suas entradas; expanda-o para ver um modelo de solicitação e os códigos de resposta. Os modelos precisam de seus próprios valores e de um corpo válido conforme o esquema.

Substitua os espaços reservados em maiúsculas pelos seus valores. Para uma solicitação JSON, salve um corpo que corresponda ao esquema em request.json. Exemplos de cookies usam um jar local de cookies de uma sessão autenticada.

Comentários

GET/api/comment/screen/{id}¶

Obter comentários da tela

Comentários opacos do agente na tela nomeada. ScreenRig não os lê nem usa. Eles não são autorização e não estão no manifesto em tempo de execução. Uma tela sem comentários retorna comentários nulo. Telas arquivadas permanecem acessíveis. Leitura autenticada /api control-plane; custa 1 crédito.

Autenticação: projectBearer
Corpo da solicitação: nenhum
ID da operação: getScreenComments

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Comentários	Comentários (application/json)
403	outside_screen_scope - o chamador é limitado a telas e a tela, pasta de telas, seletor ou público que a requisição nomeia ou alcança está fora delas (docs/screen-scope.md). Um id fora do escopo e um id que não existe recebem a mesma resposta; errors[0].screen_scope traz o escopo do chamador, e a escrita é recusada por inteiro, nunca restringida.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

PUT/api/comment/screen/{id}¶

Colocar comentários da tela

Substitui comentários opacos de agente na tela nomeada. O valor dos comentários deve ser um objeto JSON cuja forma UTF-8 compacta tenha no máximo 1024 bytes. Última gravação vence apenas no campo de comentários; revisão, updated_at e manifesto de tempo de execução permanecem inalterados.

Autenticação: projectBearer
Corpo da solicitação: CommentsWrite
ID da operação: putScreenComments

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
Idempotency-Key	cabeçalho	opcional	Omitir para uma operação nova. Forneça e reutilize uma chave para deduplicar tentativas; o CLI gerencia as chaves automaticamente.

Campos do corpo da solicitação

Campo	Descrição
comentários (obrigatório, objeto)	Objeto JSON opaco do agente. A serialização UTF-8 compacta deve ter no máximo 1024 bytes. Objetos aninhados, arrays e strings são permitidos. Arrays, strings, números, booleanos e null são rejeitados como valor de comentários em si.

Modelo e respostas da solicitação

shell · modelo de requisição

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'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Comentários	Comentários (application/json)
403	outside_screen_scope - o chamador é limitado a telas e a tela, pasta de telas, seletor ou público que a requisição nomeia ou alcança está fora delas (docs/screen-scope.md). Um id fora do escopo e um id que não existe recebem a mesma resposta; errors[0].screen_scope traz o escopo do chamador, e a escrita é recusada por inteiro, nunca restringida.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

EXCLUIR/api/comment/screen/{id}¶

Excluir comentários da tela

Remove comentários da tela. Operação idempotente se já estiver removido. Não altera a revisão nem recria o manifesto de runtime.

Autenticação: projectBearer
Corpo da solicitação: nenhum
ID da operação: deleteScreenComments

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
Idempotency-Key	cabeçalho	opcional	Omitir para uma operação nova. Forneça e reutilize uma chave para deduplicar tentativas; o CLI gerencia as chaves automaticamente.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/screen/RESOURCE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
204	Desconfigurado	sem corpo
403	outside_screen_scope - o chamador é limitado a telas e a tela, pasta de telas, seletor ou público que a requisição nomeia ou alcança está fora delas (docs/screen-scope.md). Um id fora do escopo e um id que não existe recebem a mesma resposta; errors[0].screen_scope traz o escopo do chamador, e a escrita é recusada por inteiro, nunca restringida.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/comment/playlist/{id}¶

Obter comentários da playlist

Comentários opacos do agente na playlist nomeada. ScreenRig não os lê nem usa. Uma playlist sem comentários retorna comentários nulo. Leitura autenticada /api control-plane; custa 1 crédito.

Autenticação: projectBearer
Corpo da solicitação: nenhum
ID da operação: getPlaylistComments

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Comentários	Comentários (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

PUT/api/comment/playlist/{id}¶

Colocar comentários da playlist

Substitui comentários opacos de agente na playlist nomeada. JSON UTF-8 compacto do objeto de comentários deve ter no máximo 1024 bytes. Última gravação vence apenas no campo de comentários; revisão e manifesto de tempo de execução permanecem inalterados.

Autenticação: projectBearer
Corpo da solicitação: CommentsWrite
ID da operação: putPlaylistComments

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
Idempotency-Key	cabeçalho	opcional	Omitir para uma operação nova. Forneça e reutilize uma chave para deduplicar tentativas; o CLI gerencia as chaves automaticamente.

Campos do corpo da solicitação

Campo	Descrição
comentários (obrigatório, objeto)	Objeto JSON opaco do agente. A serialização UTF-8 compacta deve ter no máximo 1024 bytes. Objetos aninhados, arrays e strings são permitidos. Arrays, strings, números, booleanos e null são rejeitados como valor de comentários em si.

Modelo e respostas da solicitação

shell · modelo de requisição

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'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Comentários	Comentários (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

EXCLUIR/api/comment/playlist/{id}¶

Excluir comentários da playlist

Remove comentários da playlist. Idempotente se já removido. Não aumenta revisão nem recria o manifesto runtime.

Autenticação: projectBearer
Corpo da solicitação: nenhum
ID da operação: deletePlaylistComments

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
Idempotency-Key	cabeçalho	opcional	Omitir para uma operação nova. Forneça e reutilize uma chave para deduplicar tentativas; o CLI gerencia as chaves automaticamente.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
204	Desconfigurado	sem corpo
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/comment/playlist/{id}/page/{page_id}¶

Obter comentários da página da playlist

Comentários opacos do agente em uma página de playlist, endereçados pela string de id da página. Uma página sem comentários retorna comentários nulo. Playlist ou página ausente é not_found. Leitura autenticada /api control-plane; custa 1 crédito.

Autenticação: projectBearer
Corpo da solicitação: nenhum
ID da operação: getPlaylistPageComments

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
page_id	caminho	obrigatório	ID da página da playlist.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Comentários	Comentários (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

PUT/api/comment/playlist/{id}/page/{page_id}¶

Colocar comentários da página da playlist

Substitui comentários opacos de agente em uma página de playlist. JSON UTF-8 compacto do objeto de comentários deve ter no máximo 1024 bytes. Última gravação vence apenas no campo de comentários dessa página; revisão da playlist e manifesto de tempo de execução permanecem inalterados.

Autenticação: projectBearer
Corpo da solicitação: CommentsWrite
ID da operação: putPlaylistPageComments

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
page_id	caminho	obrigatório	ID da página da playlist.
Idempotency-Key	cabeçalho	opcional	Omitir para uma operação nova. Forneça e reutilize uma chave para deduplicar tentativas; o CLI gerencia as chaves automaticamente.

Campos do corpo da solicitação

Campo	Descrição
comentários (obrigatório, objeto)	Objeto JSON opaco do agente. A serialização UTF-8 compacta deve ter no máximo 1024 bytes. Objetos aninhados, arrays e strings são permitidos. Arrays, strings, números, booleanos e null são rejeitados como valor de comentários em si.

Modelo e respostas da solicitação

shell · modelo de requisição

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'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Comentários	Comentários (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

EXCLUIR/api/comment/playlist/{id}/page/{page_id}¶

Excluir comentários da página da playlist

Remove comentários em uma página de playlist. Idempotente se já removido. Não aumenta revisão nem recria o manifesto runtime.

Autenticação: projectBearer
Corpo da solicitação: nenhum
ID da operação: deletePlaylistPageComments

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
page_id	caminho	obrigatório	ID da página da playlist.
Idempotency-Key	cabeçalho	opcional	Omitir para uma operação nova. Forneça e reutilize uma chave para deduplicar tentativas; o CLI gerencia as chaves automaticamente.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/comment/playlist/RESOURCE_ID/page/PAGE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
204	Desconfigurado	sem corpo
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)