Generate Characters
This endpoint initiates the character generation process for a specific story and chapter. It should be called after a story has been successfully initialized via the Init Task API.
Method & Path:
POST /v1/api/stories/{story_id}/chapters/{chapter_id}/charactersAuth Required: Yes (
X-API-Key)Body: None
Headers
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 necessary data is inferred from the story_id and chapter_id path parameters.
Request Specification
Path Parameters
story_id
string
✅
The unique UUID of the story.
chapter_id
integer
✅
The numeric ID of the chapter for which characters will be generated.
Response — 200 OK
When successful, the API returns a JSON object containing metadata about the generation task.
status
string
The overall status of the API call, typically "success".
data.message
string
A human-readable message about task creation (e.g. "Generate pages task is processing").
data.task_id
string
The unique ID of the character 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 showing when the server started and completed handling the request.
total_time_by_second
number
Total processing duration in seconds.
host_of_client_call_request
string
The IP address or host of the client making the request.
Example Response
Last updated