API docs by Redocly

Not!ce API (0.0.0)

Download OpenAPI specification:Download

A simple API server for the Not!ce project.

Ping

Check if the server is running.

Responses

Response samples

Content type
application/json
{
  • "message": "Server is running 🎉"
}

audio

Get Audio

path Parameters
filename
required
string (Filename)

The filename of the audio file

Responses

Response samples

Content type
application/json
null

bookshelves

Get Bookshelves

query Parameters
Cursor (string) or Cursor (null) (Cursor)
limit
integer (Limit) [ 1 .. 50 ]
Default: 10
order
string (Order)
Default: "desc"
Enum: "asc" "desc"
sort
string (Sort)
Default: "created_at"
Enum: "title" "created_at"
header Parameters
X-Session-Token (string) or X-Session-Token (null) (X-Session-Token)

Responses

Response samples

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

Create Bookshelf

header Parameters
X-Session-Token (string) or X-Session-Token (null) (X-Session-Token)
Request Body schema: application/json
required
title
required
string (Title)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Bookshelf

path Parameters
bookshelf_id
required
string <uuid> (Bookshelf Id)
header Parameters
X-Session-Token (string) or X-Session-Token (null) (X-Session-Token)

Responses

Response samples

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

Update Bookshelf

path Parameters
bookshelf_id
required
string <uuid> (Bookshelf Id)
header Parameters
X-Session-Token (string) or X-Session-Token (null) (X-Session-Token)
Request Body schema: application/json
required
Title (string) or Title (null) (Title)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": {
    }
}

notes

Get Notes

path Parameters
bookshelf_id
required
string <uuid> (Bookshelf Id)
query Parameters
Cursor (string) or Cursor (null) (Cursor)
limit
integer (Limit) [ 1 .. 50 ]
Default: 10
order
string (Order)
Default: "desc"
Enum: "asc" "desc"
sort
string (Sort)
Default: "created_at"
Enum: "title" "created_at"
header Parameters
X-Session-Token (string) or X-Session-Token (null) (X-Session-Token)

Responses

Response samples

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

Create Note

path Parameters
bookshelf_id
required
string <uuid> (Bookshelf Id)
header Parameters
X-Session-Token (string) or X-Session-Token (null) (X-Session-Token)
Request Body schema: application/json
required
title
required
string (Title)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Note

path Parameters
bookshelf_id
required
string <uuid> (Bookshelf Id)
note_id
required
string <uuid> (Note Id)
header Parameters
X-Session-Token (string) or X-Session-Token (null) (X-Session-Token)

Responses

Response samples

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

Update Note

path Parameters
bookshelf_id
required
string <uuid> (Bookshelf Id)
note_id
required
string <uuid> (Note Id)
header Parameters
X-Session-Token (string) or X-Session-Token (null) (X-Session-Token)
Request Body schema: application/json
required
title
required
string (Title)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": {
    }
}