monologue-notes-api

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Monologue Notes API

Monologue Notes API

This skill provides the information needed to call the Monologue Notes REST API directly. Use it for read-only operations on the authenticated user's notes.
Use whatever HTTP client fits the task:
curl
, a short script, or another REST-capable tool. Do not invent client libraries unless the user asks for one.
本技能提供了直接调用Monologue Notes REST API所需的信息。 适用于对已认证用户的笔记执行只读操作。
可使用任何适合任务的HTTP客户端:
curl
、简短脚本或其他支持REST的工具。 除非用户要求,否则不要自行开发客户端库。

Authentication

身份认证

Use the environment variable
MONOLOGUE_API_KEY
as the bearer token.
  • Required auth header:
    Authorization: Bearer $MONOLOGUE_API_KEY
  • Required scope:
    notes:read
  • Never print the token, echo it, log it, or include it in a response to the user
  • Only pass it through the
    Authorization
    header as a shell variable expansion
Check whether the token is available without displaying it:
bash
if [ -z "${MONOLOGUE_API_KEY:-}" ]; then
  echo "MONOLOGUE_API_KEY is not set"
fi
If
MONOLOGUE_API_KEY
is missing:
  • Report that the environment variable is not present
  • Ask the user whether they want to provide an API key
  • Do not attempt authenticated API calls until a token is available
Avoid commands such as these because they would expose secrets:
bash
echo "$MONOLOGUE_API_KEY"
env | grep MONOLOGUE_API_KEY
set | grep MONOLOGUE_API_KEY
使用环境变量
MONOLOGUE_API_KEY
作为Bearer令牌。
  • 必填认证头:
    Authorization: Bearer $MONOLOGUE_API_KEY
  • 必填权限范围:
    notes:read
  • 绝不要打印、回显、记录令牌,也不要在给用户的响应中包含令牌
  • 仅通过
    Authorization
    头以Shell变量展开的形式传递令牌
在不显示令牌的前提下检查其是否可用:
bash
if [ -z "${MONOLOGUE_API_KEY:-}" ]; then
  echo "MONOLOGUE_API_KEY is not set"
fi
如果
MONOLOGUE_API_KEY
缺失:
  • 告知用户该环境变量未设置
  • 询问用户是否想要提供API密钥
  • 在获取到令牌前,不要尝试发起需要认证的API调用
避免使用以下会泄露机密的命令:
bash
echo "$MONOLOGUE_API_KEY"
env | grep MONOLOGUE_API_KEY
set | grep MONOLOGUE_API_KEY

Base URL

基础URL

  • Base URL:
    https://api.monologue.to
  • API shape: read-only Notes API
  • Data format: JSON
  • Timestamps: ISO 8601 date-time strings
  • 基础URL:
    https://api.monologue.to
  • API类型:只读笔记API
  • 数据格式:JSON
  • 时间戳:ISO 8601日期时间字符串

Request Pattern

请求模式

For all requests:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/..."
If structured output is useful, pipe the response to
jq
.
所有请求示例:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/..."
如果需要结构化输出,可将响应通过管道传递给
jq

Endpoints

端点

List notes

列出笔记

GET /v1/public-api/notes
Returns a page of notes for the authenticated user.
Supported query parameters:
  • limit
    : integer from
    1
    to
    100
    , default
    20
  • cursor
    : opaque pagination cursor from a previous response
  • created_after
    : ISO 8601 timestamp
  • created_before
    : ISO 8601 timestamp
  • updated_after
    : ISO 8601 timestamp
  • q
    : full-text search across titles, summaries, and transcripts
Example:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes?limit=20&q=interview"
Example with
jq
:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes?limit=20" \
  | jq '{next_cursor, items: [.items[] | {note_id, title, summary, created_at, updated_at}]}'
Expected response fields:
  • items
    : array of note summaries
  • next_cursor
    : cursor for the next page, if any
Each list item may include:
  • note_id
  • title
  • summary
  • created_at
  • updated_at
Possible errors:
  • 400
    : invalid filter or cursor
  • 401
    : missing or invalid token
  • 403
    : token lacks the required scope
  • 422
    : validation error
GET /v1/public-api/notes
返回已认证用户的一页笔记。
支持的查询参数:
  • limit
    :整数,范围
    1
    100
    ,默认值
    20
  • cursor
    :来自上一次响应的不透明分页游标
  • created_after
    :ISO 8601时间戳
  • created_before
    :ISO 8601时间戳
  • updated_after
    :ISO 8601时间戳
  • q
    :在标题、摘要和转录文本中进行全文搜索
示例:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes?limit=20&q=interview"
结合
jq
的示例:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes?limit=20" \
  | jq '{next_cursor, items: [.items[] | {note_id, title, summary, created_at, updated_at}]}'
预期响应字段:
  • items
    :笔记摘要数组
  • next_cursor
    :下一页的游标(如果存在)
每个列表项可能包含:
  • note_id
  • title
  • summary
  • created_at
  • updated_at
可能的错误:
  • 400
    :无效的过滤器或游标
  • 401
    :令牌缺失或无效
  • 403
    :令牌缺少所需权限范围
  • 422
    :验证错误

Get a single note

获取单条笔记

GET /v1/public-api/notes/{note_id}
Returns the full details for one note belonging to the authenticated user.
Path parameters:
  • note_id
    : note identifier returned by the list endpoint
Example:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes/NOTE_ID"
Example with
jq
:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes/NOTE_ID" \
  | jq '{note_id, title, summary, transcript, transcript_segments, created_at, updated_at}'
In addition to the list fields, the full note response may include:
  • transcript
  • transcript_segments
Notes:
  • transcript_segments
    is loosely typed structured JSON and may be
    null
  • 404
    means the note was not found for the authenticated user
Possible errors:
  • 401
    : missing or invalid token
  • 403
    : token lacks the required scope
  • 404
    : note not found
  • 422
    : validation error
GET /v1/public-api/notes/{note_id}
返回已认证用户的某条笔记的完整详情。
路径参数:
  • note_id
    :列出笔记端点返回的笔记标识符
示例:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes/NOTE_ID"
结合
jq
的示例:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes/NOTE_ID" \
  | jq '{note_id, title, summary, transcript, transcript_segments, created_at, updated_at}'
除了列表字段外,完整笔记响应可能包含:
  • transcript
  • transcript_segments
注意:
  • transcript_segments
    是松散类型的结构化JSON,可能为
    null
  • 404
    表示已认证用户未找到该笔记
可能的错误:
  • 401
    :令牌缺失或无效
  • 403
    :令牌缺少所需权限范围
  • 404
    :笔记未找到
  • 422
    :验证错误

Common Workflows

常见工作流

Search notes by keyword

按关键词搜索笔记

Use the
q
parameter:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes?q=meeting"
Search covers:
  • note titles
  • note summaries
  • note transcripts
使用
q
参数:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes?q=meeting"
搜索范围包括:
  • 笔记标题
  • 笔记摘要
  • 笔记转录文本

Page through results

分页浏览结果

  1. Call
    GET /v1/public-api/notes
  2. Read
    next_cursor
    from the response
  3. Pass that cursor back as the
    cursor
    query parameter
  4. Stop when
    next_cursor
    is absent or
    null
Example:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes?limit=50&cursor=OPAQUE_CURSOR"
  1. 调用
    GET /v1/public-api/notes
  2. 从响应中读取
    next_cursor
  3. 将该游标作为
    cursor
    查询参数传递回去
  4. next_cursor
    不存在或为
    null
    时停止
示例:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes?limit=50&cursor=OPAQUE_CURSOR"

Filter by time

按时间过滤

Use ISO 8601 date-time values:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes?created_after=2026-01-01T00:00:00Z"
使用ISO 8601日期时间值:
bash
curl -sS \
  -H "Authorization: Bearer $MONOLOGUE_API_KEY" \
  "https://api.monologue.to/v1/public-api/notes?created_after=2026-01-01T00:00:00Z"

Operating Rules

操作规则

  • Treat this API as read-only
  • Do not claim write support; this skill only covers listing and reading notes
  • Prefer
    https://api.monologue.to
    for requests
  • When reporting failures, summarise the HTTP status and relevant response body without exposing the token
  • If the user asks for a workflow that requires local post-processing, fetch the data first and then transform it separately
  • 将本API视为只读模式
  • 不要声称支持写入操作;本技能仅涵盖列出和读取笔记的功能
  • 请求优先使用
    https://api.monologue.to
  • 报告失败时,总结HTTP状态和相关响应内容,但不要暴露令牌
  • 如果用户要求需要本地后处理的工作流,先获取数据,再单独进行转换

Source Notes

来源说明

This skill is based on:
  • /Users/eleanor/repos/obsidian/intellectronica/2026-04-21-20-10 Monologue API.md
  • Live OpenAPI checks against
    https://api.monologue.to/public-openapi.json
    on 2026-04-22
本技能基于:
  • /Users/eleanor/repos/obsidian/intellectronica/2026-04-21-20-10 Monologue API.md
  • 2026年4月22日针对
    https://api.monologue.to/public-openapi.json
    的实时OpenAPI检查