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 notesSENDARTICLE: Create articlesADDREACTION: Add reactionsDELETEREACTION: Delete reactionsEDITPROFILE: 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: Paginationarchived: true|falsetag: 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.4---56# Rote Notes Skill78This skill allows you to interact with a Rote instance programmatically using an **OpenKey**.910## Authentication1112All API requests **must** include the `openkey` parameter.1314- **GET Requests**: Use it as a query parameter: `?openkey=YOUR_API_KEY`15- **POST/PUT/DELETE Requests**: Include `{"openkey": "YOUR_API_KEY"}` in the JSON body.1617## Permissions1819Ensure the OpenKey has the necessary permissions for the task:2021- `SENDROTE`: Create notes (POST /v2/api/openkey/notes)22- `GETROTE`: Retrieve/Search notes (GET /v2/api/openkey/notes)23- `EDITROTE`: Edit/Delete notes24- `SENDARTICLE`: Create articles25- `ADDREACTION`: Add reactions26- `DELETEREACTION`: Delete reactions27- `EDITPROFILE`: Get/Update user profile2829## Endpoints3031### 1. Create Note3233**POST** `/v2/api/openkey/notes`3435- **Headers**: `Content-Type: application/json`36- **Body**:37 ```json38 {39 "openkey": "...",40 "content": "Note content (required)",41 "title": "Optional title",42 "state": "private|public",43 "type": "rote|article|other",44 "tags": ["tag1", "tag2"],45 "pin": false,46 "articleId": "optional-article-uuid"47 }48 ```4950### 2. Create Article5152**POST** `/v2/api/openkey/articles`5354- **Body**: `{"openkey": "...", "content": "..."}`5556### 3. Retrieve/List Notes5758**GET** `/v2/api/openkey/notes`5960- **Params**:61 - `openkey`: (Required)62 - `skip`, `limit`: Pagination63 - `archived`: `true`|`false`64 - `tag`: Filter by tag (supports `tag` or `tag[]`). Multiple tags use AND logic.6566### 4. Search Notes6768**GET** `/v2/api/openkey/notes/search`6970- **Params**: `openkey`, `keyword` (required), `skip`, `limit`, `archived`, `tag`.7172### 5. Reactions7374- **Add**: **POST** `/v2/api/openkey/reactions`75 - **Body**: `{"openkey": "...", "type": "like", "roteid": "note_uuid", "metadata": {}}`76- **Remove**: **DELETE** `/v2/api/openkey/reactions/:roteid/:type?openkey=...`7778### 6. User Profile7980- **Get**: **GET** `/v2/api/openkey/profile?openkey=...`81- **Update**: **PUT** `/v2/api/openkey/profile`82 - **Body**: `{"openkey": "...", "nickname": "...", "description": "...", "avatar": "...", "username": "..."}`8384### 7. Check Permissions8586**GET** `/v2/api/openkey/permissions?openkey=...`8788## Helper Scripts8990For 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.9192- `scripts/rote_openkey.ts`
rabithua