List the project as files
The project as a tree of plain files with ids, sizes and states.
The tree: project.json · chapters/<NN>-<slug>/chapter.json · chapters/<NN>-<slug>/<NNN>-<slug>/{scene.json, narration.md, composition.html}. Any directory segment may be the entity id, or its number alone. Free.
Authorization
bearerAuth Typecut API key. Generate one in app.typecut.ai → Settings → API keys. Send as Authorization: Bearer tc_live_….
In: header
Path Parameters
uuidQuery Parameters
Only this chapter or scene directory.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/fs"{
"data": {
"project_id": "string",
"structure_version": 0,
"entries": [
{
"path": "string",
"type": "dir",
"id": "string",
"size": 0,
"state": "string",
"note": "string"
}
]
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}Write the project bible PUT
Write the bible whole, compare-and-set: base_version is the version you read (0 for a derived bible, which this first write stores).
The project as the files of a git repository GET
The project as a deterministic tree of text files (project.json, audio/*.json, bible.json, assets.lock.json, chapters/NN-slug/…) that a git client can commit: every source field once, generated things