Get result

This endpoint retrieves all generated pages, including their image URLs, prompt metadata, and status, for a specific chapter. It should be called only after the page generation process is completed (status = completed).

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

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

  • Body: None

Headers

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. All data is determined based on the provided story_id and chapter_id path parameters.

Response — 200 OK

When successful, the response contains metadata about the chapter and an array of all generated comic pages, each with prompt data and signed image URLs.

Top-Level Fields

Field
Type
Description

status

string

Top-level API call status (e.g., "success").

data.chapter

object

Chapter information (ID, index, name).

data.pages

array

List of generated page objects.

errors

array

List of errors, if any.

error_description

string

Detailed error message, if applicable.

start_time / end_time

string

Server-side timestamps for request handling.

total_time_by_second

number

Time taken by the server to process the request.

host_of_client_call_request

string

IP or hostname of the client making the request.

data.chapter Object

Field
Type
Description

id

integer

The chapter ID.

index

integer

The chapter’s index within the story.

story_name

string

The title of the story.

data.pages[] Array Items

Field
Type
Description

page_id

integer

Unique ID of the generated page.

prompt

string

Textual or structured prompt used to generate the page content.

image

string

Signed URL of the generated image (expires automatically after a set time).

status

string

Status of the page generation (e.g., "COMPLETED").

index

integer

Page order within the chapter (starting from 0).


Example Response

Last updated