API referenceProjects
Create a share link
Mint a public share link.
Same gate as the editor Share button: the project must be fully resolved — no unresolved scenes, no chapter missing voice-over — before a link is minted. Pass { partial: true } to mint mid-build (still-resolving scenes play as placeholders); the response then carries ready and pending.
Authorization
bearerAuth AuthorizationBearer <token>
Typecut API key. Generate one in app.typecut.ai → Settings → API keys. Send as Authorization: Bearer tc_live_….
In: header
Path Parameters
id*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
partial?boolean
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/share" \ -H "Content-Type: application/json" \ -d '{}'{
"data": {
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"share_url": "http://example.com",
"share_token": "string",
"ready": true,
"pending": {
"scenes": 0,
"voiceover_chapters": 0
}
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}