Check process

This endpoint is used to check the progress and current status of an asynchronous generation task — either character generation or page generation — for a specific story chapter.

You can poll this endpoint periodically until the task’s status becomes "completed".

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

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

• Query Parameter Required: task_type (specifies which process to check)

Headers

Header	Required	Description
X-API-Key	✅	Your API key for authentication.
Content-Type	✅	Must be application/json.

Request Specification

Path Parameters

Parameter	Type	Required	Description
story_id	string	✅	The UUID of the story being processed.
chapter_id	integer	✅	The numeric ID of the chapter.

Query Parameters

Parameter	Type	Required	Enum	Description
task_type	string	✅	'character_generation' or 'page_generation'	The type of generation process to check.

---

Response — 200 OK

Field	Type	Description
status	string	Top-level API status (e.g. "success").
data.progress	integer	Current progress percentage (0–100).
data.status	string	Current process state: queued, processing, completed, or failed.
data.message	string	A message describing the current step or final outcome.
data.task_id	string	The task UUID that identifies this generation process.
data.task_type	string	The type of task (character_generation or page_generation).
errors	array	A list of errors, if any.
error_description	string	Detailed error description, if applicable.
start_time / end_time	string	Timestamps of when the request was processed by the server.
host_of_client_call_request	string	The IP address of the client making the request.
total_time_by_second	number	Total request handling time (in seconds).

---

Response — 200 OK

Field	Type	Description
status	string	Top-level API status (e.g. "success").
data.progress	integer	Current progress percentage (0–100).
data.status	string	Current process state: queued, processing, completed, or failed.
data.message	string	A message describing the current step or final outcome.
data.task_id	string	The task UUID that identifies this generation process.
data.task_type	string	The type of task (character_generation or page_generation).
errors	array	A list of errors, if any.
error_description	string	Detailed error description, if applicable.
start_time / end_time	string	Timestamps of when the request was processed by the server.
host_of_client_call_request	string	The IP address of the client making the request.
total_time_by_second	number	Total request handling time (in seconds).

Example Responses

✅ Example — Character Generation Completed

{
  "data": {
    "progress": 100,
    "status": "completed",
    "message": "Character generation completed",
    "task_id": "921df3f6-eed7-4af7-a85d-13cc1d82a2d7",
    "task_type": "character_generation"
  },
  "errors": [],
  "error_description": "",
  "start_time": "2025-11-04 23:54:39.688755",
  "end_time": "2025-11-04 23:54:39.699372",
  "host_of_client_call_request": "116.110.41.93",
  "total_time_by_second": 0.010632,
  "status": "success"
}