Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
studio

Update Chapter

Updates a chapter.

post/v1/studio/projects/{project_id}/chapters/{chapter_id}

Path parameters

project_idstring required

The ID of the Studio project.

Example:21m00Tcm4TlvDq8ikWAM

The ID of the Studio project.

chapter_idstring required

The ID of the chapter.

Example:21m00Tcm4TlvDq8ikWAM

The ID of the chapter.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

namestring nullable

The name of the chapter, used for identification only.

Example request

{
  "name": "Chapter 1"
}

Response

Successful Response

Example response

{
  "chapter": {
    "can_be_downloaded": true,
    "chapter_id": "aw1NgEzBg83R7vgmiJt6",
    "content": {
      "blocks": []
    },
    "conversion_progress": 0.5,
    "last_conversion_date_unix": 1714204800,
    "name": "Chapter 1",
    "state": "default",
    "statistics": {
      "characters_converted": 200,
      "characters_unconverted": 100,
      "paragraphs_converted": 5,
      "paragraphs_unconverted": 3
    }
  }
}