OpenVibe.Today API

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Server https://openvibe.today. 7 routes performing 2 capabilities. OpenAPI 3.1 document.

GET /api/v1/me/agenda

Read a person's own agenda on OpenVibe.Today, for that person (plan L48 V3, "plan my day"): a first-party service such as OpenVibe.Chat's Vibe names the person with X-OV-Subject and gets the same agen

Capabilities
today.agenda.read
Visibility
first-party
Parameters
  • days (query) — How many days ahead, from two hours ago (default 14).
Input
today.agenda-request@1
Response
application/json today.agenda@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>today.agenda.read</strong> (first-party): Read a person&#39;s own agenda on OpenVibe.Today, for that person (plan L48 V3, &quot;plan my day&quot;): a first-party service such as OpenVibe.Chat&#39;s Vibe names the person with X-OV-Subject and gets the same agenda the person sees at openvibe.today/me (their reminders at their times, their events and saved events, imported calendars, and the streams of people they follow when Today knows them). Read-only: nothing is set, changed or kept by reading it.</p>

GET /api/v1/reminders

Set, list, snooze, stop and remove a person's own reminders on OpenVibe.Today, for that person (plan L48): a first-party service such as OpenVibe.Chat's Vibe names the person with X-OV-Subject, and ev

Capabilities
today.reminder.write
Visibility
first-party
Parameters
  • text (query) — What to remind the person of, and when, in their own words.
  • tz (query) — The person's IANA time zone (America/Chicago); an unknown zone is read as UTC.
  • url (query) — Where the reminder came from: an https link kept on it and opened from the notification. Anything else is dropped.
  • source (query) — The site that set it (vibe, live, work…), shown to the person.
  • minutes (query) — Snooze only: how long, from now.
Input
today.reminder-request@1
Response
application/json today.reminder-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>today.reminder.write</strong> (first-party): Set, list, snooze, stop and remove a person&#39;s own reminders on OpenVibe.Today, for that person (plan L48): a first-party service such as OpenVibe.Chat&#39;s Vibe names the person with X-OV-Subject, and every route answers only that person&#39;s reminders. A reminder is plain words parsed by Today (&quot;stretch every 2 hours from 9 to 5&quot;) and keeps the https link and the source site that set it.</p>

POST /api/v1/reminders

Set, list, snooze, stop and remove a person's own reminders on OpenVibe.Today, for that person (plan L48): a first-party service such as OpenVibe.Chat's Vibe names the person with X-OV-Subject, and ev

Capabilities
today.reminder.write
Visibility
first-party
Request body
application/json today.reminder-request@1
Response
application/json today.reminder-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>today.reminder.write</strong> (first-party): Set, list, snooze, stop and remove a person&#39;s own reminders on OpenVibe.Today, for that person (plan L48): a first-party service such as OpenVibe.Chat&#39;s Vibe names the person with X-OV-Subject, and every route answers only that person&#39;s reminders. A reminder is plain words parsed by Today (&quot;stretch every 2 hours from 9 to 5&quot;) and keeps the https link and the source site that set it.</p>

DELETE /api/v1/reminders/{id}

Set, list, snooze, stop and remove a person's own reminders on OpenVibe.Today, for that person (plan L48): a first-party service such as OpenVibe.Chat's Vibe names the person with X-OV-Subject, and ev

Capabilities
today.reminder.write
Visibility
first-party
Parameters
  • id (path, required)
  • text (query) — What to remind the person of, and when, in their own words.
  • tz (query) — The person's IANA time zone (America/Chicago); an unknown zone is read as UTC.
  • url (query) — Where the reminder came from: an https link kept on it and opened from the notification. Anything else is dropped.
  • source (query) — The site that set it (vibe, live, work…), shown to the person.
  • minutes (query) — Snooze only: how long, from now.
Input
today.reminder-request@1
Response
application/json today.reminder-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>today.reminder.write</strong> (first-party): Set, list, snooze, stop and remove a person&#39;s own reminders on OpenVibe.Today, for that person (plan L48): a first-party service such as OpenVibe.Chat&#39;s Vibe names the person with X-OV-Subject, and every route answers only that person&#39;s reminders. A reminder is plain words parsed by Today (&quot;stretch every 2 hours from 9 to 5&quot;) and keeps the https link and the source site that set it.</p>

POST /api/v1/reminders/{id}/done

Set, list, snooze, stop and remove a person's own reminders on OpenVibe.Today, for that person (plan L48): a first-party service such as OpenVibe.Chat's Vibe names the person with X-OV-Subject, and ev

Capabilities
today.reminder.write
Visibility
first-party
Parameters
  • id (path, required)
Request body
application/json today.reminder-request@1
Response
application/json today.reminder-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>today.reminder.write</strong> (first-party): Set, list, snooze, stop and remove a person&#39;s own reminders on OpenVibe.Today, for that person (plan L48): a first-party service such as OpenVibe.Chat&#39;s Vibe names the person with X-OV-Subject, and every route answers only that person&#39;s reminders. A reminder is plain words parsed by Today (&quot;stretch every 2 hours from 9 to 5&quot;) and keeps the https link and the source site that set it.</p>

POST /api/v1/reminders/{id}/snooze

Set, list, snooze, stop and remove a person's own reminders on OpenVibe.Today, for that person (plan L48): a first-party service such as OpenVibe.Chat's Vibe names the person with X-OV-Subject, and ev

Capabilities
today.reminder.write
Visibility
first-party
Parameters
  • id (path, required)
Request body
application/json today.reminder-request@1
Response
application/json today.reminder-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>today.reminder.write</strong> (first-party): Set, list, snooze, stop and remove a person&#39;s own reminders on OpenVibe.Today, for that person (plan L48): a first-party service such as OpenVibe.Chat&#39;s Vibe names the person with X-OV-Subject, and every route answers only that person&#39;s reminders. A reminder is plain words parsed by Today (&quot;stretch every 2 hours from 9 to 5&quot;) and keeps the https link and the source site that set it.</p>

POST /api/v1/reminders/parse

Set, list, snooze, stop and remove a person's own reminders on OpenVibe.Today, for that person (plan L48): a first-party service such as OpenVibe.Chat's Vibe names the person with X-OV-Subject, and ev

Capabilities
today.reminder.write
Visibility
first-party
Request body
application/json today.reminder-request@1
Response
application/json today.reminder-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>today.reminder.write</strong> (first-party): Set, list, snooze, stop and remove a person&#39;s own reminders on OpenVibe.Today, for that person (plan L48): a first-party service such as OpenVibe.Chat&#39;s Vibe names the person with X-OV-Subject, and every route answers only that person&#39;s reminders. A reminder is plain words parsed by Today (&quot;stretch every 2 hours from 9 to 5&quot;) and keeps the https link and the source site that set it.</p>