OpenAPI YAMLOpenAPI JSONproblemas YAMLResumen de la API
Este grupo tiene 1 operación, generada 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.
Códigos de configuración del sitio web
Obtener el código de configuración del visitante
Llamada anónima del mismo origen desde los prompts de agente del sitio web. Responde con el código de configuración de la cookie de visitante propia de la solicitud (sr_vid) y lo genera la primera vez: el mismo visitante recibe el mismo código mientras sea válido (90 días desde su creación).
Una persona lo pega en su agente junto con el prompt de configuración y el agente lo pasa al registro de la CLI, que vincula el proyecto nuevo con esa visita. Requiere el Origin del sitio web. Una solicitud sin exactamente una cookie de visitante bien formada recibe 204 y no genera nada. El código no concede nada; solo nombra una visita.
Como máximo 60 códigos nuevos por IP de cliente y hora (IPv6 agrupadas por /64); todas las solicitudes comparten un límite de 120 por IP y minuto. Retry-After es la referencia.
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| Origen | encabezado | requerido |
Plantilla y respuestas de solicitud
curl --request POST --header 'Origin: https://screenrig.ai' 'https://screenrig.ai/website/setup-codes'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | El código de configuración del visitante. | WebsiteSetupCode (application/json); encabezados: Cache-Control |
| 204 | La solicitud no llevaba cookie de visitante, así que no hay ninguna visita que nombrar. | sin cuerpo; encabezados: Cache-Control |
| 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) |