Sign in to the web UI
POST
/api/v1/auth/session
const url = 'https://example.com/api/v1/auth/session';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"key":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/auth/session \ --header 'Content-Type: application/json' \ --data '{ "key": "example" }'Exchanges an API key with print or admin scope — or, while no admin key exists, the one-time bootstrap key — for a browser session. Sets an HttpOnly session cookie and a CSRF cookie. The key itself is never stored in the browser. Rate limited per client IP.
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
SignInRequest
object
key
required
Key
string
Example generated
{ "key": "example"}Responses
Section titled “Responses”Successful Response
Invalid key
Key scope too low (read-only)
Validation Error
Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{ "detail": [ { "ctx": {}, "input": "example", "loc": [ "example" ], "msg": "example", "type": "example" } ]}Too many sign-in attempts