← Back to home

Events

Create, read, update, and delete calendar events for your agent.

List Events

GET /api/v1/events

Returns events in the agent's calendar. Supports filtering by date range and pagination.

Auth: Bearer API Key

Query params (all optional):

  • start_after — ISO 8601 datetime
  • start_before — ISO 8601 datetime
  • limit — default 100, max 500
  • offset — default 0

Response:

{
  "events": [
    {
      "id": "uuid",
      "title": "Team Standup",
      "start": "2025-01-15T09:00:00Z",
      "end": "2025-01-15T09:30:00Z",
      "description": "Daily sync",
      "location": "Zoom",
      "allDay": false,
      "rrule": null,
      "color": "#3b82f6"
    }
  ]
}

Get Event

GET /api/v1/events/:id

Returns a single event from the agent's calendar.

Auth: Bearer API Key

Response:

{
  "event": {
    "id": "uuid",
    "title": "Team Standup",
    "start": "2025-01-15T09:00:00Z",
    "end": "2025-01-15T09:30:00Z",
    "description": "Daily sync",
    "location": "Zoom",
    "allDay": false,
    "rrule": null,
    "color": "#3b82f6"
  }
}

Create Event

POST /api/v1/events

Creates a new calendar event.

Auth: Bearer API Key

Body:

FieldTypeRequired
titlestringYes
startISO 8601 datetimeYes
endISO 8601 datetimeYes
descriptionstringNo
locationstringNo
allDaybooleanNo (default: false)
rrulestring (iCal RRULE format)No
timezonestring (IANA timezone)No
colorstring (hex, e.g. #ff5733)No

Response:

{
  "event": {
    "id": "uuid",
    "title": "Team Standup",
    "start": "2025-01-15T09:00:00Z",
    "end": "2025-01-15T09:30:00Z",
    ...
  }
}

Update Event

PUT /api/v1/events/:id

Updates one or more fields of an event.

Auth: Bearer API Key

Body:

FieldTypeRequired
titlestringNo
startISO 8601 datetimeNo
endISO 8601 datetimeNo
descriptionstringNo
locationstringNo
allDaybooleanNo
rrulestringNo
timezonestringNo
colorstring (hex, e.g. #ff5733)No

Response:

{ "event": { ... } }

Delete Event

DELETE /api/v1/events/:id

Permanently deletes the event.

Auth: Bearer API Key

Response:

{ "deleted": true }

Field Constraints

FieldConstraint
title1–500 characters
descriptionUp to 5,000 characters
locationUp to 500 characters
start / endISO 8601 datetime (e.g. "2025-07-01T10:00:00Z")
rruleiCal recurrence rule (e.g. "FREQ=WEEKLY;BYDAY=MO,WE,FR")
timezoneIANA timezone (e.g. "America/New_York")
colorHex color code (e.g. "#ff5733")