Referencia API

API de Almacenamiento clave/valor

Almacenamiento clave/valor de aplicación

Referencia HTTP. Generada a partir del contrato backend. Explore los endpoints abajo o descargue OpenAPI.

Este grupo tiene 9 operaciones, generadas a partir de api/openapi.yaml. Filtre por ruta, acción o autenticación. Cada endpoint indica sus entradas; despliéguelo para ver una plantilla de solicitud y los códigos de respuesta. Las plantillas necesitan sus propios valores y un cuerpo válido según el esquema.

Reemplace los marcadores en mayúsculas con sus valores. Para una solicitud JSON, guarde un cuerpo que coincida con el esquema en request.json. Los ejemplos de cookies usan un frasco de cookies local de una sesión autenticada.

Almacenamiento clave/valor de aplicación

GET/api/applications/{application_id}/kv

Listar KV

Devuelve como máximo 200 entradas en orden ascendente de clave. next_cursor es la última clave devuelta; pásela como after para obtener la siguiente página. next_cursor es nulo cuando no hay más entradas. Una sesión del panel lee aquí las entradas de su proyecto para la vista previa de la app web; el panel no tiene escritura de KV.

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
listKV

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
application_idrutarequerido
despuésconsultaopcional
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Entradas KVKVList (application/json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
GET/api/applications/{application_id}/kv/{key}

Obtener KV

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
getKV

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
application_idrutarequerido
keyrutarequerido
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv/KEY'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Entrada KVKVEntry (application/json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
PUT/api/applications/{application_id}/kv/{key}

Poner KV

Autenticación
projectBearer
Cuerpo de la solicitud
Escritura KV
ID de operación
putKV

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
application_idrutarequerido
keyrutarequerido
If-MatchencabezadoopcionalRevisión positiva opcional de recurso. Omitir para crear o sobrescribir una clave; una revisión obsoleta suministrada es revision_conflict.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

CampoDescripción
value_base64 (requerido, cadena)maxLength: 1398104
content_type (opcional, cadena)predeterminado: "application/octet-stream" minLength: 1 maxLength: 127
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv/KEY'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Entrada KVKVEntry (application/json)
429

Problema estable rate_limited. Reintente solo después del intervalo Retry-After autorizado. Las denegaciones de ventana fija también incluyen la política RateLimit-Policy y los miembros RateLimit aplicables; las denegaciones por concurrencia y presupuesto de bytes omiten esas divulgaciones opcionales.

Problema (application/problem+json); encabezados: Retry-After, RateLimit-Policy, RateLimit
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
ELIMINAR/api/applications/{application_id}/kv/{key}

Eliminar KV

Autenticación
projectBearer
Cuerpo de la solicitud
ninguno
ID de operación
deleteKV

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
application_idrutarequerido
keyrutarequerido
If-MatchencabezadoopcionalRevisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv/KEY'

Respuestas

EstadoSignificadoCuerpo y encabezados
204Eliminadosin cuerpo
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
GET/api/applications/{application_id}/kv-webhooks

Listar KVWebhooks

Lista los webhooks entrantes de la aplicación, los más antiguos primero (máximo 20), cada uno con la clave que escribe, su URL de ingestión y last_used_at una vez que ha escrito. El secreto nunca se devuelve aquí.

Autenticación
projectBearer
Cuerpo de la solicitud
ninguno
ID de operación
listKVWebhooks

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
application_idrutarequerido
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Los webhooks de clave/valor de la aplicación.Lista de webhook KV (application/json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
POST/api/applications/{application_id}/kv-webhooks

Crear KVWebhook

Crea un webhook entrante de clave/valor: una URL que escribe una clave de esta aplicación, para que un sistema externo (Zapier, Make, un punto de venta, un cron job, curl) envíe datos a pantallas con un POST HTTP; vea POST /api/applications/{application_id}/kv-webhooks/{webhook_id}/write. La clave no necesita existir aún.

La respuesta es el único lugar donde aparece el secreto (con la respuesta de rotación): guárdelo en el sistema de envío de inmediato; el servidor mantiene un resumen. Una aplicación tiene como máximo 20 webhooks (kv_webhook_limit_reached). Se añade kv_webhook.created. Un reintento exacto con la misma Idempotency-Key devuelve esta misma respuesta, incluido el secreto, durante veinticuatro horas.

Autenticación
projectBearer
Cuerpo de la solicitud
Crear webhook KV
ID de operación
createKVWebhook

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
application_idrutarequerido
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

CampoDescripción
key (requerido, cadena)minLength: 1 maxLength: 256 patrón: "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,255}$"
descripción (opcional, cadena)Lo que envía para las personas que leen la lista. Recortado; no debe contener credenciales. maxLength: 200
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks'

Respuestas

EstadoSignificadoCuerpo y encabezados
201Creado, con su URL y secreto.Webhook KV con secreto (application/json); encabezados: Cache-Control
400invalid_request, incluyendo una clave malformada o una descripción que contiene una credencial.Problema (application/problem+json)
404not_found — la aplicación no está en este proyecto.Problema (application/problem+json)
409kv_webhook_limit_reached o idempotency_mismatch.Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
ELIMINAR/api/applications/{application_id}/kv-webhooks/{webhook_id}

Eliminar KVWebhook

Elimina el webhook. Su URL deja de funcionar de inmediato; la clave que escribió mantiene su valor. Añade kv_webhook.deleted.

Autenticación
projectBearer
Cuerpo de la solicitud
ninguno
ID de operación
deleteKVWebhook

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
application_idrutarequerido
webhook_idrutarequeridoEl id de uno de los webhooks clave/valor de la aplicación.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks/WEBHOOK_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
204Eliminado.sin cuerpo
404not_found — el webhook no está en esta aplicación.Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
POST/api/applications/{application_id}/kv-webhooks/{webhook_id}/rotate-secret

Rotar secreto KVWebhook

Reemplaza el secreto del webhook y devuelve el nuevo, una vez. El secreto antiguo deja de funcionar de inmediato; actualice el sistema de envío. Añade kv_webhook.secret_rotated. Un reintento exacto con la misma Idempotency-Key devuelve esta misma respuesta, secreto incluido, durante veinticuatro horas.

Autenticación
projectBearer
Cuerpo de la solicitud
ninguno
ID de operación
rotateKVWebhookSecret

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
application_idrutarequerido
webhook_idrutarequeridoEl id de uno de los webhooks clave/valor de la aplicación.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks/WEBHOOK_ID/rotate-secret'

Respuestas

EstadoSignificadoCuerpo y encabezados
200El webhook con su nuevo secreto.Webhook KV con secreto (application/json); encabezados: Cache-Control
404not_found — el webhook no está en esta aplicación.Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
POST/api/applications/{application_id}/kv-webhooks/{webhook_id}/write

Recibir KVWebhook

La URL a la que un sistema externo envía el nuevo valor de una clave. Se autentica solo con el secreto propio del webhook en el encabezado Authorization: Bearer <secret>, o HTTP Basic con el id del webhook como usuario y el secreto como contraseña. Nunca se acepta un secreto en la URL o consulta.

Un webhook desconocido, uno de otra aplicación y un secreto incorrecto responden con el mismo 401. El cuerpo sin procesar, máximo 1 MiB, se convierte en el valor de la clave del webhook, y el encabezado Content-Type en su content_type (application/octet-stream cuando falta; un encabezado que no es un tipo de medio es invalid_request).

La escritura es PUT /api/applications/{application_id}/kv/{key} sin If-Match: reemplaza el valor, incrementa la revisión, se mide y se verifica su cuota como cualquier escritura K/V, es una solicitud API facturada que nunca se rechaza por saldo, y agrega kv.updated.

Idempotency-Key (de 8 a 200 caracteres) deduplica los reintentos de un remitente de una escritura durante veinticuatro horas, y la misma clave con otro cuerpo o tipo de contenido es idempotency_mismatch; sin ella cada envío es una nueva escritura. La respuesta son los nuevos metadatos de la clave, nunca su valor.

Como máximo 120 escrituras por minuto por webhook; cada una cuenta además para las tasas de escritura de la organización y de la clave (PUT /api/card-data/{key}).

Autenticación
kvWebhookBearer O kvWebhookBasic
Cuerpo de la solicitud
string
ID de operación
receiveKVWebhook

Parámetros

NombreEnviar¿Requerido?Descripción
application_idrutarequerido
webhook_idrutarequeridoEl id de uno de los webhooks clave/valor de la aplicación.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request POST --header 'Content-Type: */*' --data-binary '@request.bin' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks/WEBHOOK_ID/write'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Los nuevos metadatos de la clave.Resultado de escritura KVWebhook (application/json); encabezados: RateLimit-Policy, RateLimit, Cache-Control
400invalid_request — el cuerpo es mayor a 1 MiB, el Content-Type no es un tipo de medio único, o la Idempotency-Key está malformada.Problema (application/problem+json)
401no autorizado — credenciales faltantes o incorrectas, o un webhook desconocido. WWW-Authenticate indica los ámbitos Bearer y Basic.Problema (application/problem+json)
409idempotency_mismatch — la Idempotency-Key se usó para otro cuerpo o tipo de contenido.Problema (application/problem+json)
429

Problema estable rate_limited. Reintente solo después del intervalo Retry-After autorizado. Las denegaciones de ventana fija también incluyen la política RateLimit-Policy y los miembros RateLimit aplicables; las denegaciones por concurrencia y presupuesto de bytes omiten esas divulgaciones opcionales.

Problema (application/problem+json); encabezados: Retry-After, RateLimit-Policy, RateLimit
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)