Back 日本語

Umibudo API Manual

The Umibudo API lets external apps and tools connect with an API key. This manual explains how to get an API key, check it with the sayHello endpoint, and read your notes through the API.

Getting an API key

Using your API key

Send the key in the Authorization header as Bearer <key> when calling the API. Do not put the key in the URL or the request body.

sayHello (connectivity check)

This endpoint checks that your API key works.

Example (curl):

On success it returns JSON like this:

Listing your notes

Returns a list of your notes (read-only).

Getting a note's contents

Returns a note's details and its items (read-only). Pass the id from the list as file_id.

Creating a note

Creates a new note. You can use the returned file_id right away to write items.

Writing to a note

You can also create, update, and delete items in a note with an API key. Writes use POST with a JSON body (file_id is required).

Example (curl):

An API key acts with the full permissions of the user who created it, so a leaked key could be used to modify your notes. Do not create keys you do not need for writing, and delete any key that may have leaked right away.

Errors

Notes