← Back to home

Events

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

List Events
Get all events for your agent's calendar, with optional filtering.
GET/api/v1/events

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

Auth:Bearer API Key

Response

// Query params (all optional):
//   start_after  - ISO 8601 datetime
//   start_before - ISO 8601 datetime
//   limit        - default 100, max 500
//   offset       - default 0

{
  "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
Retrieve a single event by ID.
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
Add a new event to the calendar.
POST/api/v1/events

Creates a new calendar event.

Auth:Bearer API Key

Request Body

{
  "title (required)": "string",
  "start (required)": "ISO 8601 datetime",
  "end (required)": "ISO 8601 datetime",
  "description": "string (optional)",
  "location": "string (optional)",
  "allDay": "boolean (optional, default false)",
  "rrule": "string (optional, iCal RRULE format)",
  "timezone": "string (optional, IANA timezone)",
  "color": "string (optional, hex e.g. #ff5733)"
}

Response

{
  "event": {
    "id": "uuid",
    "title": "Team Standup",
    "start": "2025-01-15T09:00:00Z",
    "end": "2025-01-15T09:30:00Z",
    ...
  }
}
Update Event
Modify an existing event (partial update).
PUT/api/v1/events/:id

Updates one or more fields of an event.

Auth:Bearer API Key

Request Body

{
  "title": "string (optional)",
  "start": "ISO 8601 datetime (optional)",
  "end": "ISO 8601 datetime (optional)",
  "description": "string (optional)",
  "location": "string (optional)",
  "allDay": "boolean (optional)",
  "rrule": "string (optional)",
  "timezone": "string (optional)",
  "color": "string (optional, hex e.g. #ff5733)"
}

Response

{ "event": { ... } }
Delete Event
Remove an event from the calendar.
DELETE/api/v1/events/:id

Permanently deletes the event.

Auth:Bearer API Key

Response

{ "deleted": true }

Field Constraints

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")