⌘K
submit api...

reflect

A newer version of this packageis available.
Viewing version
0.0.7
Latest version
0.1.0
Domain
reflect.app
OpenAPI file
HTML / JSON / YAML
This API is for the note-taking app Reflect. It supports appending data to your notes, returning a list of the links you've bookmarked, and a few other things. We don't have any official bindings, w...read more

Versions

0.1.0
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2

Authentication

OAuth2 Authentication

Reflect OAuth

Type
oauth2
Authorization URL:
https://reflect.app/oauth
Token URL:
https://reflect.app/api/oauth/token
Refresh URL:
Scopes:
read:graph
Read access to protected resources
write:graph
Write access to protected resources

Graphs

get
/graphs/{graphId}/books

Returns all books

Path parameters

  • Name
    graphId
    Type
    string
    Required
    Description

    Your graph identifier

Response

JSON
[
  {
    "id": "string",
    "asin": "string",
    "title": "string",
    "authors": [
      "string"
    ],
    "notes": [
      {
        "type": "string",
        "page": 0,
        "location": 0,
        "value": "string"
      }
    ]
  }
]

post
/graphs/{graphId}/books/sync

Sync new books and highlights

Path parameters

  • Name
    graphId
    Type
    string
    Required
    Description

    Your graph identifier

Body params

Name
books
Type
array[object]
Name
id
Type
string
Required
Name
asin
Type
string
Required
Description
Amazon Standard Identification Number
Name
title
Type
string
Required
Description
Book title
Name
authors
Type
array[string]
Description
Array of book author names
Name
notes
Type
array[object]
Description
Array of book notes
Name
type
Type
string
Required
Description
Type of note
Name
page
Type
integer
Description
Page number of note (if applicable)
Name
location
Type
integer
Description
Location of note (if applicable)
Name
value
Type
string
Description
Note contents

Response

JSON
{
  "success": true
}

get
/graphs/{graphId}/links

Returns all links

Path parameters

  • Name
    graphId
    Type
    string
    Required
    Description

    Your graph identifier

Response

JSON
[
  {
    "id": "string",
    "url": "string",
    "title": "string",
    "description": "string",
    "updated_at": "string",
    "highlights": [
      "string"
    ]
  }
]

post
/graphs/{graphId}/links

Create a new link

Path parameters

  • Name
    graphId
    Type
    string
    Required
    Description

    Your graph identifier

Body params

Name
id
Type
string
Name
url
Type
string
Required
Name
title
Type
string
Name
description
Type
string
Name
updated_at
Type
string
Name
highlights
Type
array[string]

Response

JSON
{
  "id": "string",
  "url": "string",
  "title": "string",
  "description": "string",
  "updated_at": "string",
  "highlights": [
    "string"
  ]
}

post
/graphs/{graphId}/notes

Create a new note

Path parameters

  • Name
    graphId
    Type
    string
    Required
    Description

    Your graph identifier

Body params

Name
subject
Type
string
Name
content_markdown
Type
string
Name
content_html
Type
string
Name
pinned
Type
boolean

Response

JSON
{
  "id": "string",
  "created_at": "string",
  "updated_at": "string"
}

put
/graphs/{graphId}/daily-notes

Appends to daily note

Path parameters

  • Name
    graphId
    Type
    string
    Required
    Description

    Your graph identifier

Body params

Name
date
Type
string
Description
Date of the daily note. ISO 8601 format. Defaults to today.
Name
text
Type
string
Required
Description
Text to append to the daily note
Name
transform_type
Type
string
Required
Description
Transform type to apply to the text. This will always be list-append for now.
Name
list_name
Type
string
Description
Name of the list to append to

Response

JSON
{
  "success": true
}

Users

get
/users/me

Returns current user

Response

JSON
{
  "uid": "string",
  "email": "string",
  "name": "string",
  "graph_ids": [
    "string"
  ]
}