Skip to content

Create Session ​

http
POST /api/v1/sessions

Create Session

operationId: create_session

Authentication ​

HTTPBearer

See browser access. Session mutations require a Bearer key.

Parameters ​

NameInRequiredTypeDescription and constraints
Idempotency-KeyheaderNostring / null

Request body ​

application/json: CreateSession

json
{
  "$ref": "#/components/schemas/CreateSession"
}

Responses ​

CodeDescriptionContent
202Successful Responseapplication/json: Accepted
400Bad Requestapplication/json: ErrorResponse
401Unauthorizedapplication/json: ErrorResponse
403Browser sessions allow reading only (read_only_access).application/json: ErrorResponse
404Not Foundapplication/json: ErrorResponse
409Conflictapplication/json: ErrorResponse
413Content Too Largeapplication/json: ErrorResponse
415Unsupported Media Typeapplication/json: ErrorResponse
422Unprocessable Contentapplication/json: ErrorResponse
503Service Unavailableapplication/json: ErrorResponse

Response headers 202 ​

  • Location: URL of the accepted run. string

HTTP API