Riferimento API

API Archiviazione chiave/valore

Archiviazione chiave/valore applicazione

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

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.

Archiviazione chiave/valore applicazione

GET/api/applications/{application_id}/kv

Elenca KV

Restituisce al massimo 200 voci in ordine crescente di chiave. next_cursor è l’ultima chiave restituita; passala come after per ottenere la pagina successiva. next_cursor è null quando non ci sono più voci. Una sessione della dashboard legge qui le voci del suo progetto per l’anteprima dell’app web; la dashboard non ha scrittura KV.

Autenticazione
projectBearer O dashboardSession
Corpo della richiesta
nessuno
ID operazione
listKV

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.
application_idpathobbligatorio
dopoqueryopzionale
Modello richiesta e risposte
shell · modello richiesta
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv'

Risposte

StatoSignificatoCorpo e intestazioni
200Voci KVKVList (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)
GET/api/applications/{application_id}/kv/{key}

Ottieni KV

Autenticazione
projectBearer O dashboardSession
Corpo della richiesta
nessuno
ID operazione
getKV

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

Risposte

StatoSignificatoCorpo e intestazioni
200Voce KVKVEntry (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/applications/{application_id}/kv/{key}

Inserisci KV

Autenticazione
projectBearer
Corpo della richiesta
KVWrite
ID operazione
putKV

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.
application_idpathobbligatorio
keypathobbligatorio
If-MatchintestazioneopzionaleRevisione positiva opzionale della risorsa. Ometti per creare o sovrascrivere una chiave; una revisione obsoleta fornita è revision_conflict.
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
value_base64 (obbligatorio, stringa)maxLength: 1398104
content_type (opzionale, stringa)predefinito: "application/octet-stream" minLength: 1 maxLength: 127
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/applications/APPLICATION_ID/kv/KEY'

Risposte

StatoSignificatoCorpo e intestazioni
200Voce KVKVEntry (application/json)
429

Problema rate_limited stabile. Ritenta solo dopo l'intervallo Retry-After autorevole. I dinieghi a finestra fissa includono anche RateLimit-Policy e membri RateLimit applicabili; i dinieghi per concorrenza e budget byte omettono tali divulgazioni opzionali.

Problema (application/problem+json); intestazioni: Retry-After, RateLimit-Policy, RateLimit
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/applications/{application_id}/kv/{key}

Elimina KV

Autenticazione
projectBearer
Corpo della richiesta
nessuno
ID operazione
deleteKV

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.
application_idpathobbligatorio
keypathobbligatorio
If-MatchintestazioneopzionaleRevisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.
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/applications/APPLICATION_ID/kv/KEY'

Risposte

StatoSignificatoCorpo e intestazioni
204Eliminatonessun 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/applications/{application_id}/kv-webhooks

Elenca webhook KV

Elenca i webhook key/value in ingresso dell’applicazione, dal più vecchio (massimo 20), ognuno con la chiave scritta, la sua URL di ingestione e last_used_at una volta scritta. Il segreto non è mai restituito qui

Autenticazione
projectBearer
Corpo della richiesta
nessuno
ID operazione
listKVWebhooks

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.
application_idpathobbligatorio
Modello richiesta e risposte
shell · modello richiesta
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks'

Risposte

StatoSignificatoCorpo e intestazioni
200I webhook key/value dell’applicazione.KVWebhookList (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)
POST/api/applications/{application_id}/kv-webhooks

Crea KVWebhook

Crea un webhook in ingresso chiave/valore: un URL che scrive una chiave di questa applicazione, così un sistema esterno (Zapier, Make, un punto vendita, un cron job, curl) invia dati agli schermi con un POST HTTP; vedi POST /api/applications/{application_id}/kv-webhooks/{webhook_id}/write. La chiave può non esistere ancora.

La risposta è l’unico luogo in cui appare il segreto (con la risposta di rotazione): memorizzalo subito nel sistema di invio; il server conserva un digest. Un’applicazione ha al massimo 20 webhook (kv_webhook_limit_reached). Aggiunge kv_webhook.created. Un retry esatto con la stessa Idempotency-Key restituisce la stessa risposta, segreto incluso, per ventiquattro ore.

Autenticazione
projectBearer
Corpo della richiesta
KVWebhookCreate
ID operazione
createKVWebhook

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.
application_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
key (obbligatorio, stringa)minLength: 1 maxLength: 256 pattern: "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,255}$"
descrizione (opzionale, stringa)Cosa invia a esso, per le persone che leggono la lista. Ridotto; non deve contenere credenziali. maxLength: 200
Modello richiesta e risposte
shell · modello richiesta
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'

Risposte

StatoSignificatoCorpo e intestazioni
201Creato, con il suo URL e segreto.KVWebhookWithSecret (application/json); headers: Cache-Control
400invalid_request, incluso una chiave malformata o una descrizione che contiene una credenziale.Problema (application/problem+json)
404not_found — l’applicazione non è in questo progetto.Problema (application/problem+json)
409kv_webhook_limit_reached o idempotency_mismatch.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/applications/{application_id}/kv-webhooks/{webhook_id}

Elimina KVWebhook

Elimina il webhook. La sua URL smette di funzionare immediatamente; la chiave scritta mantiene il suo valore. Aggiunge kv_webhook.deleted.

Autenticazione
projectBearer
Corpo della richiesta
nessuno
ID operazione
deleteKVWebhook

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.
application_idpathobbligatorio
webhook_idpathobbligatorioL’id di uno dei webhook chiave/valore dell’applicazione.
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/applications/APPLICATION_ID/kv-webhooks/WEBHOOK_ID'

Risposte

StatoSignificatoCorpo e intestazioni
204Eliminato.nessun corpo
404not_found — il webhook non è su questa applicazione.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)
POST/api/applications/{application_id}/kv-webhooks/{webhook_id}/rotate-secret

Ruota KVWebhook Secret

Sostituisce il segreto del webhook e restituisce quello nuovo, una volta. Il vecchio segreto smette di funzionare subito; aggiorna il sistema di invio. Aggiunge kv_webhook.secret_rotated. Un retry esatto con la stessa Idempotency-Key restituisce questa stessa risposta, segreto incluso, per ventiquattro ore.

Autenticazione
projectBearer
Corpo della richiesta
nessuno
ID operazione
rotateKVWebhookSecret

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.
application_idpathobbligatorio
webhook_idpathobbligatorioL’id di uno dei webhook chiave/valore dell’applicazione.
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 POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks/WEBHOOK_ID/rotate-secret'

Risposte

StatoSignificatoCorpo e intestazioni
200Il webhook con il suo nuovo segreto.KVWebhookWithSecret (application/json); headers: Cache-Control
404not_found — il webhook non è su questa applicazione.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)
POST/api/applications/{application_id}/kv-webhooks/{webhook_id}/write

Ricevi KVWebhook

L’URL a cui un sistema esterno invia il nuovo valore di una chiave. Si autentica solo con il segreto del webhook nell’intestazione Authorization: Bearer <secret>, o HTTP Basic con l’ID webhook come nome utente e il segreto come password. Un segreto nell’URL o nella query non è mai accettato.

Un webhook sconosciuto, uno di un’altra applicazione e un segreto errato rispondono tutti con lo stesso 401. Il corpo raw, massimo 1 MiB, diventa il valore della chiave del webhook, e l’header Content-Type il suo content_type (application/octet-stream se assente; un header che non è un tipo media è invalid_request).

La scrittura è PUT /api/applications/{application_id}/kv/{key} senza If-Match: sostituisce il valore, incrementa la revisione, è conteggiata e controllata per quota come ogni scrittura K/V, è una richiesta API fatturata che non viene mai rifiutata per il saldo, e aggiunge kv.updated.

Idempotency-Key (da 8 a 200 caratteri) deduplica i nuovi tentativi di invio di una scrittura per ventiquattro ore, e la stessa chiave con un corpo o tipo di contenuto diverso è idempotency_mismatch; senza di essa ogni invio è una nuova scrittura. La risposta contiene i nuovi metadati della chiave, mai il suo valore.

Al massimo 120 scritture al minuto per webhook; ciascuna conta anche nei limiti di scrittura dell’organizzazione e della chiave (PUT /api/card-data/{key}).

Autenticazione
kvWebhookBearer O kvWebhookBasic
Corpo della richiesta
string
ID operazione
receiveKVWebhook

Parametri

NomeInviaObbligatorio?Descrizione
application_idpathobbligatorio
webhook_idpathobbligatorioL’id di uno dei webhook chiave/valore dell’applicazione.
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 POST --header 'Content-Type: */*' --data-binary '@request.bin' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks/WEBHOOK_ID/write'

Risposte

StatoSignificatoCorpo e intestazioni
200I nuovi metadati della chiave.KVWebhookWriteResult (application/json); headers: RateLimit-Policy, RateLimit, Cache-Control
400invalid_request — il corpo è più grande di 1 MiB, il Content-Type non è un tipo media unico, o la Idempotency-Key è malformata.Problema (application/problem+json)
401non autorizzato — credenziali mancanti o errate, o webhook sconosciuto. WWW-Authenticate indica i realm Bearer e Basic.Problema (application/problem+json)
409idempotency_mismatch — la Idempotency-Key è stata usata per un altro corpo o tipo di contenuto.Problema (application/problem+json)
429

Problema rate_limited stabile. Ritenta solo dopo l'intervallo Retry-After autorevole. I dinieghi a finestra fissa includono anche RateLimit-Policy e membri RateLimit applicabili; i dinieghi per concorrenza e budget byte omettono tali divulgazioni opzionali.

Problema (application/problem+json); intestazioni: Retry-After, RateLimit-Policy, RateLimit
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)