OpenAPI YAMLOpenAPI JSONProbleme YAMLAPI-Überblick
Diese Gruppe hat 1 Operation, generiert aus api/openapi.yaml. Filtern Sie nach Pfad, Aktion oder Authentifizierung. Jeder Endpunkt listet seine Eingaben auf; klappen Sie ihn auf, um eine Anfragevorlage und die Antwortcodes zu sehen. Die Vorlagen brauchen Ihre eigenen Werte und einen schemagültigen Anfragekörper.
Großgeschriebene Platzhalter durch Ihre Werte ersetzen. Für eine JSON-Anfrage speichern Sie einen Body, der dem Schema in request.json entspricht. Cookie-Beispiele verwenden ein lokales Cookie-Archiv aus einer authentifizierten Sitzung.
Einrichtungscodes der Website
Einrichtungscode des Besuchers abrufen
Anonymer Same-Origin-Aufruf aus den Agent-Prompts der Website. Antwortet mit dem Einrichtungscode des Erstanbieter-Besucher-Cookies der Anfrage (sr_vid) und erzeugt ihn beim ersten Mal: Derselbe Besucher erhält denselben Code, solange er gültig ist (90 Tage ab Erzeugung).
Eine Person fügt ihn mit dem Einrichtungs-Prompt in ihren Agenten ein, und der Agent übergibt ihn an die CLI-Registrierung, die das neue Projekt mit diesem Besuch verknüpft. Erfordert den Origin der Website. Eine Anfrage ohne genau ein wohlgeformtes Besucher-Cookie erhält 204 und erzeugt nichts. Der Code gewährt nichts; er benennt nur einen Besuch.
Höchstens 60 neue Codes pro Client-IP und Stunde (IPv6 nach /64 gruppiert); alle Anfragen teilen sich ein Limit von 120 pro IP und Minute. Maßgeblich ist Retry-After.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| Herkunft | Überschrift | erforderlich |
Anfragevorlage und Antworten
curl --request POST --header 'Origin: https://screenrig.ai' 'https://screenrig.ai/website/setup-codes'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Der Einrichtungscode des Besuchers. | WebsiteSetupCode (application/json); Header: Cache-Control |
| 204 | Die Anfrage enthielt kein Besucher-Cookie, daher gibt es keinen Besuch zu benennen. | kein Körper; Header: Cache-Control |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |