API Documentation

This page documents the available APIs for the Node.js service, detailing endpoints, parameters, and expected responses.

1. GET /list-models

Retrieves a list of available models.

URL:

GET /list-models

Response:

["Model 1", "Model 2", "Model 3"]

Generates speech audio based on the provided script.

URL:

GET /generate/speech?api_key=your_api_key&payload=script_payload

Parameters:

api_key (required): Your API key for authentication.
payload (required): The script payload containing speaker names and speech content.

Response:

Audio file in MPEG format (served as a response file).

Generates speech audio and streams the response via Server-Sent Events (SSE).

URL:

POST /generate/speech/stream?api_key=your_api_key

Headers:

Body:

{
    "payload": "script_payload"
}

Response:

Generates an image based on the provided prompt.

URL:

GET /generate/image?prompt=image_prompt&width=image_width&height=image_height&response_format=image (default)

Parameters:

prompt (required): Description of the image to generate.
width (optional): Width of the generated image (default is 1024).
height (optional): Height of the generated image (default is 1024).
response_format (optional): Format of the response, can be "image" or "url".

Response:

Generated image or URL to the image.

Generates an image based on a prompt passed in the body of the request.

URL:

POST /generate/image?response_format=url (default)

Headers:

Body:

{
    "prompt": "A large hamster"
}

Response:

{ "imageUrl": "https://example.com/generated_image.jpg" }

All generated media (audio and images) can be accessed via:

URL:

GET /media/filename

Ensure that your API key is provided when required.
Audio and image generation requires a valid script payload or image prompt respectively.
The system uses OpenAI for TTS, and appropriate API keys need to be set in the environment variables.