References API

Bookmarks and shortcuts for quick access to resources.

Endpoints

List References

GET /api/ref

Get all references for the authenticated user.

Authentication: Required

Response:

{
  "data": [
    {
      "refId": "ref_123",
      "type": "file",
      "description": "Important Doc",
      "createdAt": 1735000000,
      "expiresAt": null,
      "count": 0
    }
  ]
}

Create Reference

POST /api/ref

Create a new reference/bookmark.

Authentication: Required

Request:

{
  "type": "file",
  "description": "Project Docs",
  "expiresAt": 1735086400,
  "count": 1
}

Get Reference

GET /api/ref/{ref_id}

Get a specific reference by ID. The path parameter uses snake_case.

Authentication: Required

Example:

const ref = await api.ref.id('ref_123').get()

Delete Reference

DELETE /api/ref/{ref_id}

Delete a reference. The path parameter uses snake_case.

Authentication: Required

Example:

await api.ref.id('ref_123').delete()

Usage

// Create bookmark
const ref = await api.ref.post({
  type: 'file',
  description: 'Team Meeting Notes',
  count: 1
})

// List bookmarks
const refs = await api.ref.get()

// Delete bookmark
await api.ref.id(ref.refId).delete()