remindersAdd
Creates a reminder.
Details
- Method:
POST - Path:
/reminders.add - Operation ID:
reminders_add
Parameters
{
"token": {
"description": "Authentication token. Requires scope: `reminders:write`",
"required": true,
"location": "header",
"type": "string"
},
"text": {
"description": "The content of the reminder",
"required": true,
"location": "formData",
"type": "string"
},
"time": {
"description": "When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. \"in 15 minutes,\" or \"every Thursday\")",
"required": true,
"location": "formData",
"type": "string"
},
"user": {
"description": "The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.",
"required": false,
"location": "formData",
"type": "string"
}
}Response Schema
{
"additionalProperties": false,
"description": "Schema for successful response from reminders.add method",
"properties": {
"ok": {
"enum": [
true
],
"title": "default success response",
"type": "boolean"
},
"reminder": {
"additionalProperties": false,
"properties": {
"complete_ts": {
"type": "integer"
},
"creator": {
"pattern": "^[UW][A-Z0-9]{2,}$",
"title": "User ID",
"type": "string"
},
"id": {
"pattern": "^Rm[A-Z0-9]{8,}$",
"title": "Reminder ID",
"type": "string"
},
"recurring": {
"type": "boolean"
},
"text": {
"type": "string"
},
"time": {
"type": "integer"
},
"user": {
"pattern": "^[UW][A-Z0-9]{2,}$",
"title": "User ID",
"type": "string"
}
},
"required": [
"id",
"creator",
"user",
"text",
"recurring"
],
"type": "object"
}
},
"required": [
"ok",
"reminder"
],
"title": "reminders.add schema",
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('slack')
# Call this tool
result = await agent.call_tool('remindersAdd', {
# Add required parameters here
})