Skip to content
StoryOS Docs

Overview

StoryOS API 0.0.0

Section titled “StoryOS API 0.0.0”

The public StoryOS REST API. The web app is client #1 of this same API — everything the UI does, you can do.

Information

  • OpenAPI version: 3.0.0

Operations

Section titled “Operations”
GET
/
GET
/healthz
GET
/api/v1/me
GET
/api/v1/auth/providers
GET
/api/v1/workspaces
POST
/api/v1/workspaces
GET
/api/v1/workspaces/{ws}
PATCH
/api/v1/workspaces/{ws}
GET
/api/v1/workspaces/{ws}/spaces
POST
/api/v1/workspaces/{ws}/spaces
DELETE
/api/v1/workspaces/{ws}/spaces/{space}
PATCH
/api/v1/workspaces/{ws}/spaces/{space}
GET
/api/v1/workspaces/{ws}/members
DELETE
/api/v1/workspaces/{ws}/members/{member}
PATCH
/api/v1/workspaces/{ws}/members/{member}
GET
/api/v1/workspaces/{ws}/invites
POST
/api/v1/workspaces/{ws}/invites
DELETE
/api/v1/workspaces/{ws}/invites/{invite}
POST
/api/v1/invites/accept
GET
/api/v1/workspaces/{ws}/spaces/{space}/folders
POST
/api/v1/workspaces/{ws}/spaces/{space}/folders
DELETE
/api/v1/workspaces/{ws}/folders/{folder}
PATCH
/api/v1/workspaces/{ws}/folders/{folder}
GET
/api/v1/workspaces/{ws}/databases
POST
/api/v1/workspaces/{ws}/databases
GET
/api/v1/workspaces/{ws}/databases/{db}
DELETE
/api/v1/workspaces/{ws}/databases/{db}
PATCH
/api/v1/workspaces/{ws}/databases/{db}
POST
/api/v1/workspaces/{ws}/databases/{db}/fields
DELETE
/api/v1/workspaces/{ws}/databases/{db}/fields/{field}
PATCH
/api/v1/workspaces/{ws}/databases/{db}/fields/{field}
GET
/api/v1/workspaces/{ws}/databases/{db}/fields/{field}/usage
POST
/api/v1/workspaces/{ws}/databases/{db}/fields/{field}/change-type
POST
/api/v1/workspaces/{ws}/databases/{db}/fields/{field}/options
DELETE
/api/v1/workspaces/{ws}/databases/{db}/fields/{field}/options/{option}
PATCH
/api/v1/workspaces/{ws}/databases/{db}/fields/{field}/options/{option}
GET
/api/v1/workspaces/{ws}/databases/{db}/records
POST
/api/v1/workspaces/{ws}/databases/{db}/records
POST
/api/v1/workspaces/{ws}/databases/{db}/records/query
POST
/api/v1/workspaces/{ws}/databases/{db}/records/batch
PATCH
/api/v1/workspaces/{ws}/databases/{db}/records/batch
POST
/api/v1/workspaces/{ws}/databases/{db}/records/batch-delete
POST
/api/v1/workspaces/{ws}/databases/{db}/records/batch-restore
GET
/api/v1/workspaces/{ws}/databases/{db}/records/trash
GET
/api/v1/workspaces/{ws}/databases/{db}/records/by-number/{number}
GET
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}
DELETE
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}
PATCH
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}
POST
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/duplicate
POST
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/move
POST
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/restore
POST
/api/v1/workspaces/{ws}/relations
DELETE
/api/v1/workspaces/{ws}/relations/{rel}
GET
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/links/{field}
PUT
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/links/{field}
POST
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/links/{field}
DELETE
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/links/{field}
POST
/api/v1/workspaces/{ws}/databases/{db}/views
DELETE
/api/v1/workspaces/{ws}/databases/{db}/views/{view}
PATCH
/api/v1/workspaces/{ws}/databases/{db}/views/{view}
GET
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/document
PUT
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/document
GET
/api/v1/workspaces/{ws}/spaces/{space}/documents
POST
/api/v1/workspaces/{ws}/spaces/{space}/documents
GET
/api/v1/workspaces/{ws}/documents/{doc}
DELETE
/api/v1/workspaces/{ws}/documents/{doc}
PATCH
/api/v1/workspaces/{ws}/documents/{doc}
GET
/api/v1/me/tokens
POST
/api/v1/me/tokens
DELETE
/api/v1/me/tokens/{token}
GET
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/comments
POST
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/comments
DELETE
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/comments/{comment}
PATCH
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/comments/{comment}
GET
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/activity
GET
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/attachments
POST
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/attachments
GET
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/attachments/{att}/download
GET
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/attachments/{att}/thumbnail
DELETE
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/attachments/{att}
POST
/api/v1/workspaces/{ws}/files
GET
/api/v1/files/{id}
POST
/api/v1/users/me/avatar
DELETE
/api/v1/users/me/avatar
GET
/api/v1/users/{id}/avatar
GET
/api/v1/workspaces/{ws}/search
GET
/api/v1/workspaces/{ws}/my-work
GET
/api/v1/workspaces/{ws}/recent
GET
/api/v1/workspaces/{ws}/notifications
GET
/api/v1/workspaces/{ws}/notifications/unread-count
POST
/api/v1/workspaces/{ws}/notifications/{id}/read
POST
/api/v1/workspaces/{ws}/notifications/read-all
POST
/api/v1/workspaces/{ws}/databases/{db}/import
POST
/api/v1/workspaces/{ws}/databases/{db}/records/{rec}/buttons/{field}/press
GET
/api/v1/workspaces/{ws}/databases/{db}/automations
POST
/api/v1/workspaces/{ws}/databases/{db}/automations
DELETE
/api/v1/workspaces/{ws}/databases/{db}/automations/{id}
PATCH
/api/v1/workspaces/{ws}/databases/{db}/automations/{id}
GET
/api/v1/workspaces/{ws}/databases/{db}/automations/{id}/runs
POST
/api/v1/workspaces/{ws}/databases/{db}/automations/{id}/test
GET
/api/v1/workspaces/{ws}/integrations/github
POST
/api/v1/workspaces/{ws}/integrations/github
POST
/api/v1/workspaces/{ws}/integrations/github/sync
GET
/api/v1/workspaces/{ws}/integrations/linear
POST
/api/v1/workspaces/{ws}/integrations/linear
POST
/api/v1/workspaces/{ws}/integrations/linear/dry-run
POST
/api/v1/workspaces/{ws}/integrations/linear/sync
GET
/api/v1/workspaces/{ws}/integrations/slack
POST
/api/v1/workspaces/{ws}/integrations/slack
GET
/api/v1/templates
POST
/api/v1/workspaces/{ws}/templates/{slug}/apply
DELETE
/api/v1/workspaces/{ws}/templates/sample-data
GET
/api/v1/workspaces/{ws}/grants
POST
/api/v1/workspaces/{ws}/grants
DELETE
/api/v1/workspaces/{ws}/grants/{grant}
GET
/api/v1/workspaces/{ws}/favorites
POST
/api/v1/workspaces/{ws}/favorites
DELETE
/api/v1/workspaces/{ws}/favorites/{type}/{id}

Authentication

Section titled “Authentication”

bearer

Section titled “bearer”

Security scheme type: http

Bearer format: JWT