Generate page

This endpoint starts the page generation process for a specific chapter in a story. It should only be called after character generation is completed (status = completed in the character generation sta

This endpoint starts the page generation process for a specific chapter in a story. It should only be called after character generation is completed (status = completed in the character generation status endpoint).

  • Method & Path: POST /v1/api/stories/{story_id}/chapters/{chapter_id}/pages

  • Auth Required: Yes (X-API-Key)

  • Body: None

Header
Required
Description

X-API-Key

Your API key for authentication.

Content-Type

Must be application/json.

Request Body

This endpoint does not require a request body. The page generation task is automatically linked to the specified story and chapter.

Request Specification

Path Parameters

Parameter
Type
Required
Description

story_id

string

The unique UUID of the story.

chapter_id

integer

The numeric ID of the chapter for which pages will be generated.

Response — 200 OK

When successful, the API returns a JSON object confirming that the page generation task has started.

Field
Type
Description

status

string

The overall API response status (usually "success").

data.message

string

A message indicating that the task is processing.

data.task_id

string

The unique ID of the page generation task (UUID).

data.chapter_id

string

The chapter ID for which the task was created.

errors

array

An array of errors (if any occurred).

error_description

string

A detailed description of the error, if applicable.

start_time / end_time

string

Timestamps marking when the request was handled by the server.

total_time_by_second

number

Total time in seconds that the request took to process.

host_of_client_call_request

string

The IP address or hostname of the client making the request.

Example Response

Last updated