Create job execution
curl --request POST \
--url https://api.blaxel.ai/v0/jobs/{jobId}/executions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"allowQueue": true,
"env": "{\"MY_VAR\": \"custom_value\", \"BATCH_SIZE\": \"100\"}",
"executionId": "<string>",
"id": "<string>",
"jobId": "data-processing-job",
"memory": 2048,
"tasks": [
{}
],
"workspaceId": "<string>"
}
'import requests
url = "https://api.blaxel.ai/v0/jobs/{jobId}/executions"
payload = {
"allowQueue": True,
"env": "{\"MY_VAR\": \"custom_value\", \"BATCH_SIZE\": \"100\"}",
"executionId": "<string>",
"id": "<string>",
"jobId": "data-processing-job",
"memory": 2048,
"tasks": [{}],
"workspaceId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
allowQueue: true,
env: '{"MY_VAR": "custom_value", "BATCH_SIZE": "100"}',
executionId: '<string>',
id: '<string>',
jobId: 'data-processing-job',
memory: 2048,
tasks: [{}],
workspaceId: '<string>'
})
};
fetch('https://api.blaxel.ai/v0/jobs/{jobId}/executions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.blaxel.ai/v0/jobs/{jobId}/executions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'allowQueue' => true,
'env' => '{"MY_VAR": "custom_value", "BATCH_SIZE": "100"}',
'executionId' => '<string>',
'id' => '<string>',
'jobId' => 'data-processing-job',
'memory' => 2048,
'tasks' => [
[
]
],
'workspaceId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.blaxel.ai/v0/jobs/{jobId}/executions"
payload := strings.NewReader("{\n \"allowQueue\": true,\n \"env\": \"{\\\"MY_VAR\\\": \\\"custom_value\\\", \\\"BATCH_SIZE\\\": \\\"100\\\"}\",\n \"executionId\": \"<string>\",\n \"id\": \"<string>\",\n \"jobId\": \"data-processing-job\",\n \"memory\": 2048,\n \"tasks\": [\n {}\n ],\n \"workspaceId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.blaxel.ai/v0/jobs/{jobId}/executions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"allowQueue\": true,\n \"env\": \"{\\\"MY_VAR\\\": \\\"custom_value\\\", \\\"BATCH_SIZE\\\": \\\"100\\\"}\",\n \"executionId\": \"<string>\",\n \"id\": \"<string>\",\n \"jobId\": \"data-processing-job\",\n \"memory\": 2048,\n \"tasks\": [\n {}\n ],\n \"workspaceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blaxel.ai/v0/jobs/{jobId}/executions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"allowQueue\": true,\n \"env\": \"{\\\"MY_VAR\\\": \\\"custom_value\\\", \\\"BATCH_SIZE\\\": \\\"100\\\"}\",\n \"executionId\": \"<string>\",\n \"id\": \"<string>\",\n \"jobId\": \"data-processing-job\",\n \"memory\": 2048,\n \"tasks\": [\n {}\n ],\n \"workspaceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"executionId": "exec-abc123",
"id": "550e8400-e29b-41d4-a716-446655440000",
"jobId": "data-processing-job",
"tasks": [
{}
],
"workspaceId": "my-workspace"
}jobs
Create job execution
Triggers a new execution of the batch job. Each execution runs multiple tasks in parallel according to the job’s configured concurrency. Tasks can be parameterized via the request body.
POST
/
jobs
/
{jobId}
/
executions
Create job execution
curl --request POST \
--url https://api.blaxel.ai/v0/jobs/{jobId}/executions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"allowQueue": true,
"env": "{\"MY_VAR\": \"custom_value\", \"BATCH_SIZE\": \"100\"}",
"executionId": "<string>",
"id": "<string>",
"jobId": "data-processing-job",
"memory": 2048,
"tasks": [
{}
],
"workspaceId": "<string>"
}
'import requests
url = "https://api.blaxel.ai/v0/jobs/{jobId}/executions"
payload = {
"allowQueue": True,
"env": "{\"MY_VAR\": \"custom_value\", \"BATCH_SIZE\": \"100\"}",
"executionId": "<string>",
"id": "<string>",
"jobId": "data-processing-job",
"memory": 2048,
"tasks": [{}],
"workspaceId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
allowQueue: true,
env: '{"MY_VAR": "custom_value", "BATCH_SIZE": "100"}',
executionId: '<string>',
id: '<string>',
jobId: 'data-processing-job',
memory: 2048,
tasks: [{}],
workspaceId: '<string>'
})
};
fetch('https://api.blaxel.ai/v0/jobs/{jobId}/executions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.blaxel.ai/v0/jobs/{jobId}/executions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'allowQueue' => true,
'env' => '{"MY_VAR": "custom_value", "BATCH_SIZE": "100"}',
'executionId' => '<string>',
'id' => '<string>',
'jobId' => 'data-processing-job',
'memory' => 2048,
'tasks' => [
[
]
],
'workspaceId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.blaxel.ai/v0/jobs/{jobId}/executions"
payload := strings.NewReader("{\n \"allowQueue\": true,\n \"env\": \"{\\\"MY_VAR\\\": \\\"custom_value\\\", \\\"BATCH_SIZE\\\": \\\"100\\\"}\",\n \"executionId\": \"<string>\",\n \"id\": \"<string>\",\n \"jobId\": \"data-processing-job\",\n \"memory\": 2048,\n \"tasks\": [\n {}\n ],\n \"workspaceId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.blaxel.ai/v0/jobs/{jobId}/executions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"allowQueue\": true,\n \"env\": \"{\\\"MY_VAR\\\": \\\"custom_value\\\", \\\"BATCH_SIZE\\\": \\\"100\\\"}\",\n \"executionId\": \"<string>\",\n \"id\": \"<string>\",\n \"jobId\": \"data-processing-job\",\n \"memory\": 2048,\n \"tasks\": [\n {}\n ],\n \"workspaceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blaxel.ai/v0/jobs/{jobId}/executions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"allowQueue\": true,\n \"env\": \"{\\\"MY_VAR\\\": \\\"custom_value\\\", \\\"BATCH_SIZE\\\": \\\"100\\\"}\",\n \"executionId\": \"<string>\",\n \"id\": \"<string>\",\n \"jobId\": \"data-processing-job\",\n \"memory\": 2048,\n \"tasks\": [\n {}\n ],\n \"workspaceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"executionId": "exec-abc123",
"id": "550e8400-e29b-41d4-a716-446655440000",
"jobId": "data-processing-job",
"tasks": [
{}
],
"workspaceId": "my-workspace"
}Authorizations
OAuth2ApiKeyAuth
OAuth2 authentication with JWT tokens
Path Parameters
Name of the job
Body
application/json
Request to create a job execution
When false, capacity is checked synchronously and the request is rejected immediately with a 429 error if the execution cannot start right now, instead of being queued and retried in the background. No execution is created on rejection. Defaults to true (queue and retry).
Environment variable overrides (optional, will merge with job's environment variables)
Show child attributes
Show child attributes
Example:
"{\"MY_VAR\": \"custom_value\", \"BATCH_SIZE\": \"100\"}"
Execution ID (optional, will be generated if not provided)
Unique message ID
Job ID
Example:
"data-processing-job"
Memory override in megabytes (optional, must be lower than or equal to job's configured memory)
Example:
2048
Array of task parameters for parallel execution
Workspace ID
Response
successful operation
Response returned when a job execution is successfully created. Contains identifiers and the tasks that will be executed.
Unique identifier for the created execution. Use this ID to track execution status, retrieve logs, or cancel the execution.
Example:
"exec-abc123"
Unique identifier for this request, used for idempotency and tracking. Auto-generated if not provided in the request.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Name of the job that this execution belongs to
Example:
"data-processing-job"
Array of task configurations that will be executed in parallel according to the job's concurrency settings. Each task can have custom parameters.
Name of the workspace where the job execution was created
Example:
"my-workspace"
Was this page helpful?