How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Obsidian Periodic Notes API

The Periodic Notes API from Obsidian — 2 operation(s) for periodic notes.

Obsidian Periodic Notes API is one of 10 APIs that Obsidian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Periodic Notes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.2, at version 1.0.

Requests are made against 2 base URLs: https://{host}:{port}, http://{host}:{port}.

10 operations 2 paths 2 schemas 2 DELETE2 GET2 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0
Base URL
local
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Obsidian Periodic Notes API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Find your API Key in your Obsidian settings in the "Local REST API" section under "Plugins".

Paths & Operations 10

Across 2 paths, the API surfaces 10 operations — 2 DELETE, 2 GET, 2 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Periodic Notes 10
DELETE
/periodic/{period}/
Delete the current periodic note for the specified period.
1 param → 204404405
GET
/periodic/{period}/
Get current periodic note for the specified period.
4 params → 200404
PATCH
/periodic/{period}/
Partially update content in the current periodic note for the specified period.
8 params body → 200400404405
POST
/periodic/{period}/
Append content to the current periodic note for the specified period.
7 params body → 200204400405
PUT
/periodic/{period}/
Update the content of the current periodic note for the specified period.
6 params body → 200204400405
DELETE
/periodic/{period}/{year}/{month}/{day}/
Delete the periodic note for the specified period and date.
4 params → 204404405
GET
/periodic/{period}/{year}/{month}/{day}/
Get the periodic note for the specified period and date.
7 params → 200404
PATCH
/periodic/{period}/{year}/{month}/{day}/
Partially update content in the periodic note for the specified period and date.
11 params body → 200400404405
POST
/periodic/{period}/{year}/{month}/{day}/
Append content to the periodic note for the specified period and date.
10 params body → 200204400405
PUT
/periodic/{period}/{year}/{month}/{day}/
Update the content of the periodic note for the specified period and date.
9 params body → 200204400405

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are NoteJson (5 properties), Error (2 properties). Each schema is shown below with its type and property counts.

NoteJson
object
5 properties 5 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

obsidian-periodic-notes-api-openapi.yml Raw ↑

Other APIs Obsidian publishes across the network.

Obsidian Plugin API
Obsidian Active File API
Obsidian Commands API
Obsidian Open API
Obsidian Search API
Obsidian System API
Obsidian Tags API
Obsidian Vault Directories API
Obsidian Vault Files API
Where this information came from

This is an independent, third-party profile of Obsidian Periodic Notes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.