API referenceApplicationsGit deploys
Poll an AI build/start suggestion
Requires the vms:read permission.
Returns the assist's state, the running progress transcript (read-only, not persisted), and — once done — the suggested build/start commands.
AuthorizationBearer <token>
An access token from this zone's POST /oauth/token, or a session token from POST /api/v1/auth/login. Send it as Authorization: Bearer <token>.
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/git-deploys/assist/string"{ "build_command": "string", "engine": "string", "error": "string", "id": "string", "notes": "string", "packages": [ "string" ], "proposal": { "databases": [ { "attach_as": "string", "engine": "string" } ], "notes": "string", "packages": [ "string" ], "services": [ { "build": { "command": "string", "context": "string", "dockerfile": "string", "instance_type": "string", "kind": "string", "runtime": "string" }, "expose": "string", "image": "string", "name": "string", "path": "string", "run": { "command": "string", "health": { "interval_sec": 0, "path": "string", "port": 0, "timeout_sec": 0 }, "port": 0 }, "source": "string" } ], "vars": [ { "hint": "string", "key": "string", "required": true, "value": "string" } ] }, "start_command": "string", "state": "string", "transcript": [ { "command": "string", "content": "string", "exit_code": 0, "role": "string", "stderr": "string", "stdout": "string" } ]}