curl -X POST "https://app.runtm.com/api/cloud/sessions/550e8400-e29b-41d4-a716-446655440000/deploy/scaffold" \
-H "Authorization: Bearer runtm_xxx"
import requests
response = requests.post(
"https://app.runtm.com/api/cloud/sessions/550e8400-e29b-41d4-a716-446655440000/deploy/scaffold",
headers={"Authorization": "Bearer runtm_xxx"},
)
data = response.json()
print(f"Scaffolded: {data['scaffolded']}")
print(f"Created: {data['files_created']}")
print(f"Framework: {data['detected_framework']}")
const response = await fetch(
"https://app.runtm.com/api/cloud/sessions/550e8400-e29b-41d4-a716-446655440000/deploy/scaffold",
{
method: "POST",
headers: {
"Authorization": "Bearer runtm_xxx",
},
}
);
const data = await response.json();
console.log(`Scaffolded: ${data.scaffolded}`);
console.log(`Created: ${data.files_created.join(", ")}`);
{
"scaffolded": true,
"files_created": ["runtm.yaml", "Dockerfile", ".runtmignore", ".dockerignore"],
"files_skipped": [],
"detected_type": "node",
"detected_framework": "next",
"detected_port": 3000,
"recommended_tier": "starter",
"message": null
}
Deploy
Scaffold Deploy
Generate deployment config files for the session project
POST
/
api
/
sessions
/
{session_id}
/
deploy
/
scaffold
curl -X POST "https://app.runtm.com/api/cloud/sessions/550e8400-e29b-41d4-a716-446655440000/deploy/scaffold" \
-H "Authorization: Bearer runtm_xxx"
import requests
response = requests.post(
"https://app.runtm.com/api/cloud/sessions/550e8400-e29b-41d4-a716-446655440000/deploy/scaffold",
headers={"Authorization": "Bearer runtm_xxx"},
)
data = response.json()
print(f"Scaffolded: {data['scaffolded']}")
print(f"Created: {data['files_created']}")
print(f"Framework: {data['detected_framework']}")
const response = await fetch(
"https://app.runtm.com/api/cloud/sessions/550e8400-e29b-41d4-a716-446655440000/deploy/scaffold",
{
method: "POST",
headers: {
"Authorization": "Bearer runtm_xxx",
},
}
);
const data = await response.json();
console.log(`Scaffolded: ${data.scaffolded}`);
console.log(`Created: ${data.files_created.join(", ")}`);
{
"scaffolded": true,
"files_created": ["runtm.yaml", "Dockerfile", ".runtmignore", ".dockerignore"],
"files_skipped": [],
"detected_type": "node",
"detected_framework": "next",
"detected_port": 3000,
"recommended_tier": "starter",
"message": null
}
Deterministically generates deployment configuration files (
runtm.yaml, Dockerfile, .runtmignore, .dockerignore) for the session project. Only creates files that are missing - existing files are skipped.
Required scope: deployments:write
Path Parameters
string
required
The session ID (UUID).
Headers
string
required
Bearer token. Example:
Bearer runtm_xxxstring
Scope to an organization.
Response
boolean
Whether any files were created.
array
List of files that were generated (e.g.
["runtm.yaml", "Dockerfile"]).array
List of files that already existed and were not overwritten.
string
Detected project type (e.g.
node, python, static, docker, unknown).string | null
Detected framework (e.g.
next, flask, express, static).integer
Port the application is expected to listen on.
string
Recommended deployment tier.
string | null
Additional information when auto-scaffold is not available.
curl -X POST "https://app.runtm.com/api/cloud/sessions/550e8400-e29b-41d4-a716-446655440000/deploy/scaffold" \
-H "Authorization: Bearer runtm_xxx"
import requests
response = requests.post(
"https://app.runtm.com/api/cloud/sessions/550e8400-e29b-41d4-a716-446655440000/deploy/scaffold",
headers={"Authorization": "Bearer runtm_xxx"},
)
data = response.json()
print(f"Scaffolded: {data['scaffolded']}")
print(f"Created: {data['files_created']}")
print(f"Framework: {data['detected_framework']}")
const response = await fetch(
"https://app.runtm.com/api/cloud/sessions/550e8400-e29b-41d4-a716-446655440000/deploy/scaffold",
{
method: "POST",
headers: {
"Authorization": "Bearer runtm_xxx",
},
}
);
const data = await response.json();
console.log(`Scaffolded: ${data.scaffolded}`);
console.log(`Created: ${data.files_created.join(", ")}`);
{
"scaffolded": true,
"files_created": ["runtm.yaml", "Dockerfile", ".runtmignore", ".dockerignore"],
"files_skipped": [],
"detected_type": "node",
"detected_framework": "next",
"detected_port": 3000,
"recommended_tier": "starter",
"message": null
}