Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Platform Sessions API
version: v1
tags:
- name: Sessions
paths:
/api/v1/sessions/{sessionId}:
get:
tags:
- Sessions
summary: Get one session with its parts and tags
operationId: GetSession
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SessionDto'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
/api/v1/sessions/{sessionId}/tags/{tag}:
put:
tags:
- Sessions
summary: 'Add a tag to a session. Idempotent: adding an existing tag is a no-op'
operationId: AddSessionTag
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
- name: tag
in: path
required: true
schema:
maxLength: 64
minLength: 1
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SessionDto'
components:
schemas:
SessionDto:
type: object
description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
x-ae-placeholder: true
ProblemDetails:
type: object
description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
x-ae-placeholder: true
securitySchemes:
bearer:
type: http
scheme: bearer
bearerFormat: JWT