Skip to content
/ Sayori Public

Latest commit

 

History

History
40 lines (25 loc) · 924 Bytes

WEBSERVER_API.md

File metadata and controls

40 lines (25 loc) · 924 Bytes

API Documentation

The Sayori webserver API only accepts three parameters: Mainly poem, font, and bg.

To make a poem at the API endpoint, simply make a GET request with query parameters.

Example query

curl -X GET  http://localhost:7270/?poem=Hello%20world&font=y1&bg=y2 --verbose

Accepted Parameters

poem - Required

Poem parameter is required and must be URL-encoded. Otherwise, the API will return a 400 error.

font - Optional

Font parameter must be the following in string format:

  • m1 - Monika
  • n1 - Natsuki
  • s1 - Sayori
  • y1 - Yuri
  • y2 - Yuri (Fast)
  • y3 - Yuri (Obsessed)

API will error with a 400 that is anything beyond this list.

bg - Optional

Background parameter must be the following in string format:

  • default - Default background
  • y2 - Yuri (Fast)
  • y3 - Yuri (Obsessed)

API will return a 400 that is anything beyond this list.