API Documentation

• documents
  • getReturns an array of documents
  • postAdds a document to a user's library
  • deldeletes the document with the given id from account storage
• color profile
  • postcreates a new Color Profile associated with a user
• user
• feedback
• coloring flask
  • getA call from the Laravel backend to the coloring flask to color a document

API docs by Redocly

Synesthesia Reading App API (1.0.0)

Download OpenAPI specification:Download

The Synesthesia Reading App API allows access to users' documents and color profiles across devices.

documents

Everything about your Documents

Returns an array of documents

Authorizations:

None

Responses

https://virtserver.swaggerhub.com/AFTOWNS99/Synesthesia-Reading-App/1.0.0/documents/

Response samples

• 200

Content type

application/json

[

• {

  • "docId": "id123",
  • "title": "The Silmarillion",
  • "text": "string"

  }

]

Adds a document to a user's library

Authorizations:

None

Request Body schema: application/json

docId	string
title	string
text	string

Responses

https://virtserver.swaggerhub.com/AFTOWNS99/Synesthesia-Reading-App/1.0.0/documents/

Request samples

• Payload

Content type

application/json

{

• "docId": "id123",
• "title": "The Silmarillion",
• "text": "string"

}

deletes the document with the given id from account storage

Authorizations:

None

path Parameters

docId required

string

Responses

https://virtserver.swaggerhub.com/AFTOWNS99/Synesthesia-Reading-App/1.0.0/documents/{docId}/

color profile

Information about a user color profile

creates a new Color Profile associated with a user

Authorizations:

None

path Parameters

userId required

any

Request Body schema: application/json

the color profile to be created

grapheme-color map	object (Grapheme_Color_Map) map of graphemes to RGB colors
exceptions-color map	object (Word_Color_Map) a map of words to RGB colors

Responses

https://virtserver.swaggerhub.com/AFTOWNS99/Synesthesia-Reading-App/1.0.0/color_profile/

Request samples

• Payload

Content type

application/json

{

• "grapheme-color map": { },
• "exceptions-color map": { }

}

user

Operations about user

feedback

Pertaining to user feedback

coloring flask

A call from the Laravel backend to the coloring flask to color a document

Authorizations:

None

Request Body schema: application/json

contains a color profile and document text

	object (Color_Profile) Contains a map of graphemes to their associated colors and a map of words that are exceptions to the coloring rules to their colors
text	string

Responses

https://virtserver.swaggerhub.com/AFTOWNS99/Synesthesia-Reading-App/1.0.0/http://127.0.0.1:5000/

Request samples

• Payload

Content type

application/json

{

• "color_profile": {

  • "grapheme-color map": { },
  • "exceptions-color map": { }

  },
• "text": "Nevertheless, the angelic being persevered."

}

Response samples

• 200

Content type

application/json

{

• "tokenized text": [

  • "The ",
  • "over",
  • "weight ",
  • "red ",
  • "fox ",
  • "jumped ",
  • "over ",
  • "the ",
  • "sleeping ",
  • "brown ",
  • "dog",
  • "."

  ],
• "word-color map": { }

}