Start a run of the deployed workflow (answers its runId), or with `sandbox` run the caller's checkout in their sandbox (answers the finished run)
POST
/api/workspaces/{workspaceId}/workflows/{name}/run
const url = 'http://localhost:8080/api/workspaces/example/workflows/example/run';const options = { method: 'POST', headers: {cookie: 'auth_session=<auth_session>', 'Content-Type': 'application/json'}, body: '{"input":{"additionalProperty":"example"},"sandbox":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:8080/api/workspaces/example/workflows/example/run \ --header 'Content-Type: application/json' \ --cookie auth_session=<auth_session> \ --data '{ "input": { "additionalProperty": "example" }, "sandbox": true }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workspaceId
required
string
name
required
string
Request Body
Section titled “Request Body”Media typeapplication/json
object
input
object
key
additional properties
sandbox
boolean
Example generated
{ "input": { "additionalProperty": "example" }, "sandbox": true}Responses
Section titled “Responses”Successful response
Media typeapplication/json
object
success
Whether the request succeeded.
boolean
data
Endpoint-specific response payload.
message
string
error
string
Example
{ "message": "Operation completed", "error": "Error message"}Invalid request
Media typeapplication/json
object
success
boolean
error
string
Example
{ "error": "Error message"}Internal server error
Media typeapplication/json
object
success
boolean
error
string
Example
{ "error": "Error message"}