API docs by Redocly

neurotap API (v1)

Download OpenAPI specification:

[ADMIN] Auth

Authenticate an admin and issue access + refresh tokens

Request Body schema: application/json
email
required
string <email>
password
required
string >= 12 characters

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "stringstring"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0,
  • "user": {
    }
}

Revoke the current admin session

header Parameters
Authorization
required
string

Responses

Return the current admin user profile

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "name": "string",
  • "role": "super_admin",
  • "is_active": true,
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Rotate refresh token, issue a new access token

Request Body schema: application/json
refresh_token
required
string

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0,
  • "user": {
    }
}

[ADMIN] Authors

Create a new author

header Parameters
Authorization
required
string
Request Body schema: application/json
name
required
string
image_url
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "image_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "bio": "string",
  • "image_url": "string",
  • "has_image_upload": true,
  • "is_imported": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List authors

query Parameters
q
string

Case-insensitive name search

page
integer
items_per_page
integer

Default 25, max 100

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Delete an author

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Get a single author

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "bio": "string",
  • "image_url": "string",
  • "has_image_upload": true,
  • "is_imported": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update an author

path Parameters
id
required
integer
header Parameters
Authorization
required
string
Request Body schema: application/json
name
string
image_url
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "image_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "bio": "string",
  • "image_url": "string",
  • "has_image_upload": true,
  • "is_imported": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

[ADMIN] Avatars

Create a new avatar

header Parameters
Authorization
required
string
Request Body schema: application/json
position
integer >= 0
image_url
string

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "image_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "image_url": "string",
  • "has_image_upload": true,
  • "position": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List avatars

query Parameters
page
integer
items_per_page
integer

Default 25, max 1000

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Delete an avatar

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Get a single avatar

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "image_url": "string",
  • "has_image_upload": true,
  • "position": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update an avatar

path Parameters
id
required
integer
header Parameters
Authorization
required
string
Request Body schema: application/json
position
integer >= 0
image_url
string

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "image_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "image_url": "string",
  • "has_image_upload": true,
  • "position": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Reorder avatars globally

header Parameters
Authorization
required
string
Request Body schema: application/json
avatar_ids
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "avatar_ids": [
    ]
}

[ADMIN] Background Images

Create a new background image

header Parameters
Authorization
required
string
Request Body schema: application/json
position
integer >= 0
image_url
string

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "image_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "image_url": "string",
  • "has_image_upload": true,
  • "position": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List background images

query Parameters
page
integer
items_per_page
integer

Default 25, max 1000

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Delete a background image

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Get a single background image

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "image_url": "string",
  • "has_image_upload": true,
  • "position": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a background image

path Parameters
id
required
integer
header Parameters
Authorization
required
string
Request Body schema: application/json
position
integer >= 0
image_url
string

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "image_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "image_url": "string",
  • "has_image_upload": true,
  • "position": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Reorder background images globally

header Parameters
Authorization
required
string
Request Body schema: application/json
background_image_ids
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "background_image_ids": [
    ]
}

[ADMIN] Background Sounds

Create a new background sound

header Parameters
Authorization
required
string
Request Body schema: application/json
name
required
string <= 255 characters
position
integer >= 0
file_url
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "position": 0,
  • "file_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "file_url": "string",
  • "has_file_upload": true,
  • "position": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List background sounds

query Parameters
q
string

Case-insensitive name search

page
integer
items_per_page
integer

Default 25, max 1000

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Delete a background sound

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Get a single background sound

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "file_url": "string",
  • "has_file_upload": true,
  • "position": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a background sound

path Parameters
id
required
integer
header Parameters
Authorization
required
string
Request Body schema: application/json
name
string <= 255 characters
position
integer >= 0
file_url
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "position": 0,
  • "file_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "file_url": "string",
  • "has_file_upload": true,
  • "position": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Reorder background sounds globally

header Parameters
Authorization
required
string
Request Body schema: application/json
background_sound_ids
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "background_sound_ids": [
    ]
}

[ADMIN] Bulk Imports

Run the actual import in a transaction

header Parameters
Authorization
required
string
Request Body schema: application/json
tracks_csv
string or null
phases_csv
string or null
categories_csv
string or null
authors_csv
string or null
sessions_csv
string or null
session_taps_csv
string or null
object
object

Responses

Request samples

Content type
application/json
{
  • "tracks_csv": "string",
  • "phases_csv": "string",
  • "categories_csv": "string",
  • "authors_csv": "string",
  • "sessions_csv": "string",
  • "session_taps_csv": "string",
  • "audio_files": {
    },
  • "image_files": {
    }
}

Generate a preview plan from CSVs + uploaded file manifests

header Parameters
Authorization
required
string
Request Body schema: application/json
tracks_csv
string or null
phases_csv
string or null
categories_csv
string or null
authors_csv
string or null
sessions_csv
string or null
session_taps_csv
string or null
object
object

Responses

Request samples

Content type
application/json
{
  • "tracks_csv": "string",
  • "phases_csv": "string",
  • "categories_csv": "string",
  • "authors_csv": "string",
  • "sessions_csv": "string",
  • "session_taps_csv": "string",
  • "audio_files": {
    },
  • "image_files": {
    }
}

[ADMIN] Captions Bulk

Queue caption generation for many sessions (AssemblyAI)

header Parameters
Authorization
required
string
Request Body schema: application/json
session_ids
required
Array of integers <= 500 items
language
string

Responses

Request samples

Content type
application/json
{
  • "session_ids": [
    ],
  • "language": "string"
}

Queue cue re-packing for many sessions (no transcription)

header Parameters
Authorization
required
string
Request Body schema: application/json
session_ids
required
Array of integers <= 500 items
language
string

Responses

Request samples

Content type
application/json
{
  • "session_ids": [
    ],
  • "language": "string"
}

Approve pending tracks for many sessions (synchronous)

header Parameters
Authorization
required
string
Request Body schema: application/json
session_ids
required
Array of integers <= 500 items
language
string

Responses

Request samples

Content type
application/json
{
  • "session_ids": [
    ],
  • "language": "string"
}

[ADMIN] Categories

Create a new category

header Parameters
Authorization
required
string
Request Body schema: application/json
name
required
string <= 255 characters
ui_color
required
string^#[0-9A-Fa-f]{6}$
parent_id
integer or null
position
integer or null >= 0

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ui_color": "string",
  • "parent_id": 0,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "ui_color": "string",
  • "parent_id": 0,
  • "position": 0,
  • "is_imported": true,
  • "is_hidden": true,
  • "subcategories": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List categories (hierarchical by default; flat when q/parent_id/top_level_only=false)

query Parameters
include_hidden
boolean

Include hidden categories

parent_id
integer

Filter by parent. Pass null for top-level categories.

top_level_only
boolean
q
string

Case-insensitive name search

page
integer
items_per_page
integer

Default 25, up to 1000

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Hide a category

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Get a single category (including hidden ones)

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "ui_color": "string",
  • "parent_id": 0,
  • "position": 0,
  • "is_imported": true,
  • "is_hidden": true,
  • "subcategories": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a category

path Parameters
id
required
integer
header Parameters
Authorization
required
string
Request Body schema: application/json
name
string <= 255 characters
ui_color
string^#[0-9A-Fa-f]{6}$
parent_id
integer or null
position
integer or null >= 0

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "ui_color": "string",
  • "parent_id": 0,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "ui_color": "string",
  • "parent_id": 0,
  • "position": 0,
  • "is_imported": true,
  • "is_hidden": true,
  • "subcategories": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Reorder sessions belonging to a category

path Parameters
id
required
integer
header Parameters
Authorization
required
string
Request Body schema: application/json
session_ids
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "session_ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Reorder root categories

header Parameters
Authorization
required
string
Request Body schema: application/json
category_ids
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "category_ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Reorder subcategories of a parent

path Parameters
id
required
integer
header Parameters
Authorization
required
string
Request Body schema: application/json
category_ids
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "category_ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Unhide a hidden category

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "ui_color": "string",
  • "parent_id": 0,
  • "position": 0,
  • "is_imported": true,
  • "is_hidden": true,
  • "subcategories": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

[ADMIN] CmsUsers

Create a new admin user (super_admin only)

header Parameters
Authorization
required
string
Request Body schema: application/json
email
required
string <email>
name
required
string <= 255 characters
role
required
string
Enum: "super_admin" "clinical_admin" "content_manager" "support" "reporting"
password
required
string >= 12 characters

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "name": "string",
  • "role": "super_admin",
  • "password": "stringstring"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "name": "string",
  • "role": "super_admin",
  • "is_active": true,
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "last_login_ip": "string",
  • "deactivated_at": "2019-08-24T14:15:22Z",
  • "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List admin users (super_admin only)

query Parameters
include_inactive
boolean
role
string
q
string

Case-insensitive search on name and email

page
integer
items_per_page
integer

Default 25, max 100

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Deactivate an admin user (super_admin only; cannot self-deactivate or take down last super_admin)

path Parameters
id
required
string
header Parameters
Authorization
required
string
Request Body schema: application/json
reason
required
string <= 500 characters

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Get a single admin user (super_admin only)

path Parameters
id
required
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "name": "string",
  • "role": "super_admin",
  • "is_active": true,
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "last_login_ip": "string",
  • "deactivated_at": "2019-08-24T14:15:22Z",
  • "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update an admin user (super_admin only; cannot self-demote or demote last super_admin)

path Parameters
id
required
string
header Parameters
Authorization
required
string
Request Body schema: application/json
name
string <= 255 characters
role
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "role": "string"
}

Reactivate an admin user (super_admin only)

path Parameters
id
required
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "name": "string",
  • "role": "super_admin",
  • "is_active": true,
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "last_login_ip": "string",
  • "deactivated_at": "2019-08-24T14:15:22Z",
  • "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

[ADMIN] Import Runs

List recent background runs (newest first)

header Parameters
Authorization
required
string

Responses

Fetch one background run (the UI polls this)

path Parameters
id
required
string

Run UUID

header Parameters
Authorization
required
string

Responses

[ADMIN] Library Imports

Apply the curated-library spreadsheet import

header Parameters
Authorization
required
string
Request Body schema: multipart/form-data
required

The NeuroTap_Library .xlsx (same file as /preview)

file

Responses

Dry-run the curated-library spreadsheet import

header Parameters
Authorization
required
string
Request Body schema: multipart/form-data
required

The NeuroTap_Library .xlsx

file

Responses

[ADMIN] Phases

Create a new phase

header Parameters
Authorization
required
string
Request Body schema: application/json
name
required
string <= 255 characters
description
required
string
cluster
required
string
track_type
required
string
position
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "cluster": "string",
  • "track_type": "string",
  • "position": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "cluster": "string",
  • "track_type": "string",
  • "position": 0,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "sessions_count": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List phases

query Parameters
q
string

Case-insensitive search on name and description

page
integer
items_per_page
integer

Default 25, up to 1000

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Delete a phase

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Get a single phase

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "cluster": "string",
  • "track_type": "string",
  • "position": 0,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "sessions_count": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a phase

path Parameters
id
required
integer
header Parameters
Authorization
required
string
Request Body schema: application/json
name
string <= 255 characters
description
string
cluster
string
track_type
string
position
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "cluster": "string",
  • "track_type": "string",
  • "position": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "cluster": "string",
  • "track_type": "string",
  • "position": 0,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "sessions_count": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Reorder sessions belonging to a phase

path Parameters
id
required
integer
header Parameters
Authorization
required
string
Request Body schema: application/json
phase_session_ids
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "phase_session_ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

List the sessions composed into a phase

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Add a session to a phase

path Parameters
id
required
integer
session_id
required
integer
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "phase_id": 0,
  • "session_id": 0,
  • "position": 0,
  • "session": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Remove one session occurrence from a phase

path Parameters
id
required
integer
phase_session_id
required
integer
header Parameters
Authorization
required
string

Responses

[ADMIN] Session Captions

Upload a caption track (multipart VTT)

path Parameters
session_id
required
integer
header Parameters
Authorization
required
string
Request Body schema: multipart/form-data
required
file

Responses

List a session's caption tracks

path Parameters
session_id
required
integer
header Parameters
Authorization
required
string

Responses

Hard-delete a caption track

path Parameters
session_id
required
integer
id
required
integer
header Parameters
Authorization
required
string

Responses

Replace the VTT and/or update status / language

path Parameters
session_id
required
integer
id
required
integer
header Parameters
Authorization
required
string
Request Body schema: multipart/form-data
file

Responses

Generate a caption track via AssemblyAI (NT-side, async)

path Parameters
session_id
required
integer
header Parameters
Authorization
required
string
Request Body schema: application/json
language
string

Defaults to en

Responses

Request samples

Content type
application/json
{
  • "language": "string"
}

Re-pack cues from the stored word sidecar (synchronous)

path Parameters
session_id
required
integer
id
required
integer
header Parameters
Authorization
required
string

Responses

[ADMIN] Sessions

Unhide many sessions at once

header Parameters
Authorization
required
string
Request Body schema: application/json
session_ids
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "session_ids": [
    ]
}

Hide many sessions at once

header Parameters
Authorization
required
string
Request Body schema: application/json
session_ids
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "session_ids": [
    ]
}

Create a new session

header Parameters
Authorization
required
string
Request Body schema: application/json
name
required
string <= 255 characters
duration
required
integer >= 1
position
required
integer >= 0
description
string
audio_url
string
author_id
integer or null
category_id
integer or null
phase_id
integer or null
is_hidden
boolean
start_stress_checkin_time
integer or null >= 0
end_stress_checkin_time
integer or null >= 0
disable_ratings
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "duration": 1,
  • "position": 0,
  • "description": "string",
  • "audio_url": "string",
  • "author_id": 0,
  • "category_id": 0,
  • "phase_id": 0,
  • "is_hidden": true,
  • "start_stress_checkin_time": 0,
  • "end_stress_checkin_time": 0,
  • "disable_ratings": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "duration": 0,
  • "position": 0,
  • "audio_url": "string",
  • "has_audio_upload": true,
  • "author_id": 0,
  • "category_id": 0,
  • "phase_ids": [
    ],
  • "start_stress_checkin_time": 0,
  • "end_stress_checkin_time": 0,
  • "disable_ratings": true,
  • "content_start_time": 0,
  • "is_hidden": true,
  • "is_imported": true,
  • "session_taps": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List sessions (visible by default)

query Parameters
include_hidden
boolean
visibility
string

:

  • visible
  • hidden
  • all
category_id
integer
phase_id
integer
author_id
integer
q
string

Case-insensitive match on name

page
integer
items_per_page
integer

Default 25, max 1000 (allow_more_items)

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Hide a session

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Get a single session (including hidden)

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "duration": 0,
  • "position": 0,
  • "audio_url": "string",
  • "has_audio_upload": true,
  • "author_id": 0,
  • "category_id": 0,
  • "phase_ids": [
    ],
  • "start_stress_checkin_time": 0,
  • "end_stress_checkin_time": 0,
  • "disable_ratings": true,
  • "content_start_time": 0,
  • "is_hidden": true,
  • "is_imported": true,
  • "session_taps": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a session

path Parameters
id
required
integer
header Parameters
Authorization
required
string
Request Body schema: application/json
name
string <= 255 characters
duration
integer >= 1
position
integer >= 0
description
string
is_hidden
boolean
disable_ratings
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "duration": 1,
  • "position": 0,
  • "description": "string",
  • "is_hidden": true,
  • "disable_ratings": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "duration": 0,
  • "position": 0,
  • "audio_url": "string",
  • "has_audio_upload": true,
  • "author_id": 0,
  • "category_id": 0,
  • "phase_ids": [
    ],
  • "start_stress_checkin_time": 0,
  • "end_stress_checkin_time": 0,
  • "disable_ratings": true,
  • "content_start_time": 0,
  • "is_hidden": true,
  • "is_imported": true,
  • "session_taps": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Duplicate a session

path Parameters
id
required
integer
header Parameters
Authorization
required
string
Request Body schema: application/json
phase_id
integer or null
category_id
integer or null

Responses

Request samples

Content type
application/json
{
  • "phase_id": 0,
  • "category_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "duration": 0,
  • "position": 0,
  • "audio_url": "string",
  • "has_audio_upload": true,
  • "author_id": 0,
  • "category_id": 0,
  • "phase_ids": [
    ],
  • "start_stress_checkin_time": 0,
  • "end_stress_checkin_time": 0,
  • "disable_ratings": true,
  • "content_start_time": 0,
  • "is_hidden": true,
  • "is_imported": true,
  • "session_taps": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Unhide a hidden session

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "duration": 0,
  • "position": 0,
  • "audio_url": "string",
  • "has_audio_upload": true,
  • "author_id": 0,
  • "category_id": 0,
  • "phase_ids": [
    ],
  • "start_stress_checkin_time": 0,
  • "end_stress_checkin_time": 0,
  • "disable_ratings": true,
  • "content_start_time": 0,
  • "is_hidden": true,
  • "is_imported": true,
  • "session_taps": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Detect tapping-point cues from the session's caption word sidecar

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "suggestions": [
    ]
}

[ADMIN] Tapping Points

Create a new tapping point

header Parameters
Authorization
required
string
Request Body schema: application/json
name
required
string <= 255 characters ^[a-z0-9_]+$
image_url
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "image_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "image_url": "string",
  • "has_image_upload": true,
  • "is_imported": true,
  • "position": 0
}

List tapping points

query Parameters
q
string

Case-insensitive name search

page
integer
items_per_page
integer

Default 25, max 1000 (dropdown source)

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Delete a tapping point

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Get a single tapping point

path Parameters
id
required
integer
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "image_url": "string",
  • "has_image_upload": true,
  • "is_imported": true,
  • "position": 0
}

Update a tapping point

path Parameters
id
required
integer
header Parameters
Authorization
required
string
Request Body schema: application/json
name
string <= 255 characters ^[a-z0-9_]+$
image_url
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "image_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "image_url": "string",
  • "has_image_upload": true,
  • "is_imported": true,
  • "position": 0
}

Reorder the tapping point catalog globally

header Parameters
Authorization
required
string
Request Body schema: application/json
tapping_point_ids
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "tapping_point_ids": [
    ]
}

Health

Rails health check

Responses