Protocol Documentation

id is the unique identifier of the API key record.

name is a client-defined label for the API key.

key_prefix is the non-secret prefix used for lookup and display.

created_at is when the API key was created.

last_used is when the API key was most recently used.

data is the raw binary payload of the audio file.

mime_type is the audio media type, for example "audio/mpeg".

email is the account email used for authentication.

password is the plaintext password supplied for verification.

success indicates whether authentication succeeded.

user is set when authentication succeeds and user data is returned.

raw_key is only returned at creation time and should be stored securely.

user_id is the target user identifier.

content is the note body text to store.

tags are initial tag names to associate with the note.

images are image files to attach during note creation.

audios are audio files to attach during note creation.

user_id is the target user identifier.

id is the unique identifier of the note to delete.

user_id is the target user identifier.

id is the unique identifier of the note to fetch.

user_id is the target user identifier.

count is the number of random notes requested.

user_id scopes stats to a single user when provided.

total_blips is the total number of notes.

unique_tags is the number of distinct tags.

words_written is the total word count across matching notes.

data is the raw binary payload of the image file.

mime_type is the image media type, for example "image/jpeg".

user_id is the target user identifier.

search is free-text search input and may include tag: filters.

tags are additional tag names to filter by.

start_date is an inclusive lower bound timestamp in ISO 8601 format.

end_date is an inclusive upper bound timestamp in ISO 8601 format.

limit is the maximum number of results to return.

offset is the number of results to skip before returning rows.

notes is the requested page of notes.

total is the total result count across all pages.

limit echoes the effective page size.

offset echoes the page offset.

user_id is the target user identifier.

id is the unique identifier of the note.

content is the note body text.

tags lists normalized tag names associated with the note.

created_at is when the note was created.

updated_at is when the note was last modified.

images lists image attachments associated with the note.

audios lists audio attachments associated with the note.

id is the unique identifier of the note audio attachment.

url is the publicly accessible URL for the stored audio object.

transcribed_text contains transcription output when available.

mime_type is the media type of the stored audio.

created_at is when the audio attachment was created.

id is the unique identifier of the note image.

url is the publicly accessible URL for the stored image object.

extracted_text contains OCR output for the image when available.

mime_type is the media type of the stored image.

created_at is when the image attachment was created.

email is the unique email for the new account.

password is the plaintext password supplied at registration.

id is the unique identifier of the tag.

name is the normalized tag name.

count is the number of notes currently using the tag.

created_at is when the tag was created.

user_id is the target user identifier.

id is the unique identifier of the note to update.

content updates the note body when provided.

tags is the tag list used when update_tags is true.

update_tags controls whether existing tags are replaced from tags.

add_images appends new image attachments to the note.

add_audios appends new audio attachments to the note.

id is the unique identifier of the user.

email is the user's primary login email.

name is the user's display name when set.

image is an optional avatar URL.

subscription_status is the billing tier, such as "free" or "pro".

subscription_end is when the current subscription period ends.

created_at is when the user account was created.

stripe_customer_id links the user to a Stripe customer record.

notion_key is an optional Notion API token for sync features.

updated_at is when the user record was last updated.

disabled reports whether account access is currently disabled.

disabled_reason explains why the account is disabled when disabled is true.

notion_database_name is the Notion database used for sync.