The Spote REST API gives you programmatic access to your notes, buckets, tags, and files. All endpoints require authentication via a Personal Access Token or a Clerk session. Use this reference to build integrations, automate note workflows, or connect AI agents to your Spote account.Documentation Index
Fetch the complete documentation index at: https://docs.spote.cloud/llms.txt
Use this file to discover all available pages before exploring further.
Base URL
Authentication
Every request must include anAuthorization header with a Bearer token. See Authentication for details on obtaining and using Personal Access Tokens.
Content type
All request and response bodies useapplication/json, except file uploads which use multipart/form-data. Always set Content-Type: application/json on requests that include a body.
Available resources
Notes
Create, read, update, delete, and list notes. The core resource of the Spote API.
Search
Semantic search by natural language query, and find notes similar to a given note.
Shares
Invite collaborators to a note by email. Set read or write permission and revoke access.
Files
Upload file attachments and retrieve them via the secure proxy endpoint.
Buckets & Tags
List the folders and tags that make up your note organization structure.
Tokens
Create, list, and delete Personal Access Tokens programmatically.
Response format
All endpoints return standard HTTP status codes. Successful responses return JSON. Error responses return JSON with at least amessage field describing the problem.
| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 204 | No content (delete operations) |
| 400 | Bad request (validation error) |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not found |
| 409 | Conflict (duplicate or version mismatch) |