Rote Notes Skill
This skill allows you to interact with a Rote instance programmatically using an OpenKey.
Authentication
All API requests must include the openkey parameter.
- GET Requests: Use it as a query parameter:
?openkey=YOUR_API_KEY
- POST/PUT/DELETE Requests: Include
{"openkey": "YOUR_API_KEY"} in the JSON body.
Permissions
Ensure the OpenKey has the necessary permissions for the task:
SENDROTE: Create notes (POST /v2/api/openkey/notes)
GETROTE: Retrieve/Search notes (GET /v2/api/openkey/notes)
EDITROTE: Edit/Delete notes
SENDARTICLE: Create articles
ADDREACTION: Add reactions
DELETEREACTION: Delete reactions
EDITPROFILE: Get/Update user profile
Endpoints
1. Create Note
POST /v2/api/openkey/notes
- Headers:
Content-Type: application/json
- Body:
{
"openkey": "...",
"content": "Note content (required)",
"title": "Optional title",
"state": "private|public",
"type": "rote|article|other",
"tags": ["tag1", "tag2"],
"pin": false,
"articleId": "optional-article-uuid"
}
2. Create Article
POST /v2/api/openkey/articles
- Body:
{"openkey": "...", "content": "..."}
3. Retrieve/List Notes
GET /v2/api/openkey/notes
- Params:
openkey: (Required)
skip, limit: Pagination
archived: true|false
tag: Filter by tag (supports tag or tag[]). Multiple tags use AND logic.
4. Search Notes
GET /v2/api/openkey/notes/search
- Params:
openkey, keyword (required), skip, limit, archived, tag.
5. Reactions
- Add: POST
/v2/api/openkey/reactions
- Body:
{"openkey": "...", "type": "like", "roteid": "note_uuid", "metadata": {}}
- Remove: DELETE
/v2/api/openkey/reactions/:roteid/:type?openkey=...
6. User Profile
- Get: GET
/v2/api/openkey/profile?openkey=...
- Update: PUT
/v2/api/openkey/profile
- Body:
{"openkey": "...", "nickname": "...", "description": "...", "avatar": "...", "username": "..."}
7. Check Permissions
GET /v2/api/openkey/permissions?openkey=...
Helper Scripts
For deterministic calls from the host machine, you may use the provided script if applicable, but prefer direct API calls based on the documentation above for full feature support.
1---2name: rote-notes3description: Interact with the Rote platform via OpenKey (API Key). Capabilities include creating notes/articles, searching/retrieving notes, managing reactions, and updating user profiles.4metadata:5 source: https://skillmd.com/skills/rabithua/rote-notes6---78# Rote Notes Skill910This skill allows you to interact with a Rote instance programmatically using an **OpenKey**.1112## Authentication1314All API requests **must** include the `openkey` parameter.1516- **GET Requests**: Use it as a query parameter: `?openkey=YOUR_API_KEY`17- **POST/PUT/DELETE Requests**: Include `{"openkey": "YOUR_API_KEY"}` in the JSON body.1819## Permissions2021Ensure the OpenKey has the necessary permissions for the task:2223- `SENDROTE`: Create notes (POST /v2/api/openkey/notes)24- `GETROTE`: Retrieve/Search notes (GET /v2/api/openkey/notes)25- `EDITROTE`: Edit/Delete notes26- `SENDARTICLE`: Create articles27- `ADDREACTION`: Add reactions28- `DELETEREACTION`: Delete reactions29- `EDITPROFILE`: Get/Update user profile3031## Endpoints3233### 1. Create Note3435**POST** `/v2/api/openkey/notes`3637- **Headers**: `Content-Type: application/json`38- **Body**:39 ```json40 {41 "openkey": "...",42 "content": "Note content (required)",43 "title": "Optional title",44 "state": "private|public",45 "type": "rote|article|other",46 "tags": ["tag1", "tag2"],47 "pin": false,48 "articleId": "optional-article-uuid"49 }50 ```5152### 2. Create Article5354**POST** `/v2/api/openkey/articles`5556- **Body**: `{"openkey": "...", "content": "..."}`5758### 3. Retrieve/List Notes5960**GET** `/v2/api/openkey/notes`6162- **Params**:63 - `openkey`: (Required)64 - `skip`, `limit`: Pagination65 - `archived`: `true`|`false`66 - `tag`: Filter by tag (supports `tag` or `tag[]`). Multiple tags use AND logic.6768### 4. Search Notes6970**GET** `/v2/api/openkey/notes/search`7172- **Params**: `openkey`, `keyword` (required), `skip`, `limit`, `archived`, `tag`.7374### 5. Reactions7576- **Add**: **POST** `/v2/api/openkey/reactions`77 - **Body**: `{"openkey": "...", "type": "like", "roteid": "note_uuid", "metadata": {}}`78- **Remove**: **DELETE** `/v2/api/openkey/reactions/:roteid/:type?openkey=...`7980### 6. User Profile8182- **Get**: **GET** `/v2/api/openkey/profile?openkey=...`83- **Update**: **PUT** `/v2/api/openkey/profile`84 - **Body**: `{"openkey": "...", "nickname": "...", "description": "...", "avatar": "...", "username": "..."}`8586### 7. Check Permissions8788**GET** `/v2/api/openkey/permissions?openkey=...`8990## Helper Scripts9192For deterministic calls from the host machine, you may use the provided script if applicable, but prefer direct API calls based on the documentation above for full feature support.9394- `scripts/rote_openkey.ts`