Skip to content

Latest commit

 

History

History
37 lines (18 loc) · 830 Bytes

api.md

File metadata and controls

37 lines (18 loc) · 830 Bytes

API Documentation

The API of Harmony Speech Engine is built using FastAPI, which provides automatic interactive documentation.

API Endpoint

By default, the API is accessible at:

http://127.0.0.1:12080

If you decide to use a different port or you're hosting the API, please make sure to use the proper endpoint instead.

Interactive Documentation

Swagger UI

Swagger UI is available at, also Providing OpenAPI Spec for client generation:

http://127.0.0.1:12080/docs

ReDoc

ReDoc documentation is available at:

http://127.0.0.1:12080/redoc

Both Swagger UI and ReDoc provide interactive documentation for exploring and testing the API endpoints.

Helpful Resources

A recently generated OpenAPI definition file and scripts to generate our Golang and JavaScript clients can be found in docs/api