Read project files
Read up to 20 project files.
composition.html is the resolved composition source, fetched from its hosted blob. A path that fails carries its own error. 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
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/fs/read" \ -H "Content-Type: application/json" \ -d '{}'{
"data": {
"files": [
{
"path": "string",
"content": "string",
"id": "string",
"note": "string",
"error": "string"
}
]
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}Restore a repository tree as a new project POST
The inverse of GET /projects/{id}/repo-tree: the files of a repository become a NEW project.
Write a project file POST
Write one file, routed to the service that already owns it: structure through apply_changes (recorded, undoable), composition.html through PUT /scenes/{id}/composition's gates, the scene source after