API reference

Base URL https://api.lifebutler.io/v1 · OpenAPI 3.1 · Conventions

Workspaces #

The workspaces a key may use, and their members.

Endpoint
`GET /me`	Who am I
`GET /workspaces`	List workspaces
`GET /workspaces/{workspaceId}`	Get a workspace
`GET /workspaces/{workspaceId}/members`	List members

Appointments, including repeating ones.

Endpoint
`GET /workspaces/{workspaceId}/events`	List appointments in a time range
`POST /workspaces/{workspaceId}/events`	Create an appointment
`GET /workspaces/{workspaceId}/events/{eventId}`	Get an appointment
`PATCH /workspaces/{workspaceId}/events/{eventId}`	Change an appointment
`DELETE /workspaces/{workspaceId}/events/{eventId}`	Delete an appointment

To-dos with exact or fuzzy due dates, assignees and repetition.

Endpoint
`GET /workspaces/{workspaceId}/tasks`	List tasks
`POST /workspaces/{workspaceId}/tasks`	Create a task
`GET /workspaces/{workspaceId}/tasks/{taskId}`	Get a task
`PATCH /workspaces/{workspaceId}/tasks/{taskId}`	Change a task
`DELETE /workspaces/{workspaceId}/tasks/{taskId}`	Delete a task
`POST /workspaces/{workspaceId}/tasks/{taskId}/complete`	Complete a task
`POST /workspaces/{workspaceId}/tasks/{taskId}/reopen`	Reopen a task

Shopping and to-do lists and their items.

Endpoint
`GET /workspaces/{workspaceId}/lists`	List lists
`POST /workspaces/{workspaceId}/lists`	Create a list
`PATCH /workspaces/{workspaceId}/lists/{listId}`	Rename a list
`DELETE /workspaces/{workspaceId}/lists/{listId}`	Delete a list
`GET /workspaces/{workspaceId}/lists/{listId}/items`	List items
`POST /workspaces/{workspaceId}/lists/{listId}/items`	Add items
`PATCH /workspaces/{workspaceId}/lists/{listId}/items/{itemId}`	Change or tick off an item
`DELETE /workspaces/{workspaceId}/lists/{listId}/items/{itemId}`	Remove an item

Stored files with their AI analysis: search, upload, download.

Endpoint
`GET /workspaces/{workspaceId}/documents`	List and search documents
`POST /workspaces/{workspaceId}/documents`	Upload a document
`GET /workspaces/{workspaceId}/documents/{documentId}`	Get a document
`PATCH /workspaces/{workspaceId}/documents/{documentId}`	Change a document
`DELETE /workspaces/{workspaceId}/documents/{documentId}`	Delete a document
`GET /workspaces/{workspaceId}/documents/{documentId}/file`	Download the file
`POST /workspaces/{workspaceId}/documents/{documentId}/analyze`	Analyse a document with AI

Smart search by meaning and the AI butler.

Endpoint
`GET /workspaces/{workspaceId}/search`	Smart search
`POST /workspaces/{workspaceId}/butler`	Ask the butler