IdeaStorage_API

Idea
Operations
Notes

Управление заметками

Получить список заметок
GET /api/notes

Возвращает список заметок пользователя с поддержкой фильтрации.

Можно фильтровать по:

  • статусу (draft, published, archived)
  • тегам
  • поиску по содержанию и названию

Request parameters

status
string optional

Фильтрация по статусу заметки

Enumeration:
draft
published
archived
Example:
draft
tag
string optional

Фильтрация по тэгу (ключевому слову)

Example:
проект
search
string optional

Поиск по названию или содержанию заметки

Example:
идея

Responses

200 200

Список заметок успешно получен

Body
application/json
Object
notes
Array of Note
total
integer

Общее количество найденных заметок

filters_applied
Object

Примененные фильтры

Examples
Создать новую заметку
POST /api/notes

Добавляет новую заметку в систему с указанными параметрами

Request body

application/json
Examples

Responses

201 201

Заметка успешно создана

Body
application/json
Object
message
string
note
Examples
Обновить заметку
PATCH /api/notes/{id}

Частично обновляет поля выбранной заметки. Обновляются только те поля, которые переданы в запросе.

Path variables

id
integer required

ID заметки для обновления

Example:
1

Request body

application/json
Examples

Responses

200 200

Заметка успешно обновлена

Body
application/json
Object
message
string
note
404 404

Заметка не найдена

Body
application/json
Object
error
string
Examples
Documents

Работа с документами

Конвертировать заметку в документ
POST /api/documents/convert

Создает полноценный структурированный документ на основе существующей заметки.

Позволяет применить шаблон для автоматического форматирования контента.

Request body

application/json
Object
note_id
integer required

ID исходной заметки для конвертации

template_id
integer

ID шаблона документа (опционально)

Examples

Responses

201 201

Документ успешно создан

Body
application/json
Object
message
string
document
404 404

Заметка не найдена

Body
application/json
Object
error
string
Templates

Шаблоны документов

Получить список шаблонов
GET /api/templates

Возвращает доступные шаблоны документов для различных сценариев использования.

Шаблоны помогают структурировать контент для исследований, статей, встреч и т.д.

Request parameters

type
string optional

Тип шаблона для фильтрации

Enumeration:
all
research
article
meeting
Example:
research

Responses

200 200

Список шаблонов

Body
application/json
Object
templates
Array of Template
Examples
AI Assistant

Взаимодействие с AI-ассистентом

Взаимодействие с AI-ассистентом
POST /api/ai-assistant/chat

Отправляет текстовый запрос AI-ассистенту для получения помощи.

AI может помочь с:

  • Поиском заметок и документов
  • Созданием нового контента
  • Структурированием информации
  • Генерацией идей и рекомендаций

Request body

application/json
Object
message
string required

Запрос пользователя к AI

context
Object

Дополнительный контекст для AI

Examples

Responses

200 200

Ответ от AI-ассистента

Body
application/json
Object
message
string

Текстовый ответ AI

action_type
string

Тип действия, распознанного AI

Enumeration:
search
create
organize
general
suggestions
Array of string

Список рекомендаций

confidence
number float

Уровень уверенности AI (0-1)

timestamp
string date-time
context_used
boolean

Был ли использован контекст

search_results
Array of Note

Результаты поиска (если применимо)

Users

Профили и настройки пользователей

Получить профиль пользователя
GET /api/users/profile

Возвращает полный профиль пользователя с настройками и статистикой

Request parameters

user_id
integer optional

ID пользователя (опционально, по умолчанию текущий)

Responses

200 200

Профиль пользователя

Body
application/json
Examples
Обновить настройки пользователя
PATCH /api/users/settings

Обновляет пользовательские настройки интерфейса, приватности, интеграций и уведомлений

Request body

application/json
Object
theme
string

Тема интерфейса

Enumeration:
light
dark
language
string

Язык интерфейса (ru, en)

privacy
Object
profile_public
boolean
notes_discoverable
boolean
integrations
Object
google_calendar
boolean
google_drive
boolean
notifications
Object
email_notifications
boolean
push_notifications
boolean
reminders
boolean
Examples

Responses

200 200

Настройки успешно обновлены

Body
application/json
Object
message
string
settings
Object
Type Definitions
Note

Полная модель заметки

Object
id
integer

Уникальный идентификатор заметки

title
string

Название заметки

content
string

Содержание заметки

tags
Array of string

Теги для категоризации

status
string

Статус заметки

Enumeration:
draft
published
archived
created_at
string date-time

Дата создания

updated_at
string date-time

Дата последнего обновления

type
string

Тип записи

priority
string

Приоритет заметки

Enumeration:
low
normal
high
linked_events
Array of string

Связанные события в календаре

NewNote

Модель для создания новой заметки

Object
title
string

Название заметки

content
string

Содержание заметки

tags
Array of string

Теги

status
string

Статус

Enumeration:
draft
published
archived
priority
string

Приоритет

Enumeration:
low
normal
high
linked_events
Array of string

Связанные события

PatchNote

Модель для частичного обновления заметки

Object
title
string
content
string
tags
Array of string
status
string
Enumeration:
draft
published
archived
priority
string
Enumeration:
low
normal
high
Document

Полная модель документа

Object
id
integer
title
string
type
string
structure
Object
sections
Array of string
formatting
string
media_attachments
Array of string
status
string
created_at
string date-time
updated_at
string date-time
content
string
template_id
integer
original_note_id
integer
Template

Шаблон документа

Object
id
integer
name
string

Название шаблона

type
string

Тип шаблона

structure
Array of string

Структура разделов шаблона

description
string

Описание назначения шаблона

UserProfile

Профиль пользователя

Object
id
integer
username
string
email
string email
settings
Object
theme
string
language
string
privacy
Object
integrations
Object
notifications
Object
subscription
Object
plan
string
Enumeration:
free
premium
expires_at
string date-time
stats
Object
total_notes
integer
total_documents
integer
created_this_month
integer