serge icon indicating copy to clipboard operation
serge copied to clipboard

How to use the api

Open MisterE123 opened this issue 2 years ago • 3 comments

Bug description

The documentation does not describe how to use the API.

I would expect instructions for setting up a python environment using windows or linux

Steps to reproduce

...

Environment Information

Windows 11, docker on WSL

Screenshots

No response

Relevant log output

No response

Confirmations

  • [X] I'm running the latest version of the main branch.
  • [X] I checked existing issues to see if this has already been described.

MisterE123 avatar Apr 12 '23 18:04 MisterE123

Serge just uses a REST api. There is nothing to document besides the API. Here are the API docs: http://localhost:8008/api/docs you can find the openapi definition under http://localhost:8008/api/openapi.json If you need help setting up a python environment, just google REST api python. This sort of information is readily available in other places.

DVSProductions avatar Apr 12 '23 18:04 DVSProductions

A link to the /api/docs on the README.md would have been pretty helpful, I know I was looking for the same information.

frozenfoxx avatar Apr 20 '23 05:04 frozenfoxx

@frozenfoxx I will update the readme, thanks!

gaby avatar Apr 20 '23 23:04 gaby