v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB

studio

Convert Chapter

Starts conversion of a specific chapter.

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

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.

Response

Successful Response

statusstring required

The status of the studio chapter conversion request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned.

Example response

{
  "status": "ok"
}