Execute Batched Grid Workflow
curl --request POST \
--url https://api.swarms.world/v1/batched-grid-workflow/completions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"agent_completions": [
{
"agent_name": "<string>",
"description": "<string>",
"system_prompt": "<string>",
"marketplace_prompt_id": "<string>",
"model_name": "claude-sonnet-5",
"fallback_models": [
"<string>"
],
"fallback_model_name": "<string>",
"auto_generate_prompt": false,
"max_tokens": 16000,
"temperature": 1,
"role": "worker",
"max_loops": 1,
"tools_list_dictionary": [
{}
],
"selected_tools": "<string>",
"mcp_url": "<string>",
"streaming_on": false,
"llm_args": {},
"top_p": 123,
"dynamic_temperature_enabled": false,
"mcp_config": {
"type": "mcp",
"url": "http://localhost:8000/mcp",
"name": "<string>",
"tool_configurations": {},
"authorization_token": "<string>",
"api_key": "<string>",
"api_key_header": "Authorization",
"api_key_prefix": "Bearer",
"oauth": {
"grant_type": "authorization_code",
"client_id": "<string>",
"client_secret": "<string>",
"scopes": [
"<string>"
],
"redirect_uri": "http://127.0.0.1:8765/callback",
"client_name": "Swarms Agent",
"client_uri": "<string>",
"authorization_url": "<string>",
"token_url": "<string>",
"access_token": "<string>",
"refresh_token": "<string>",
"token_storage_path": "<string>",
"use_token_cache": true,
"open_browser": true,
"callback_timeout": 300
},
"transport": "auto",
"headers": {},
"timeout": 30,
"sse_read_timeout": 300,
"tool_timeout": 120,
"command": "<string>",
"args": [
"<string>"
],
"env": {}
},
"mcp_configs": [
{
"type": "mcp",
"url": "http://localhost:8000/mcp",
"name": "<string>",
"tool_configurations": {},
"authorization_token": "<string>",
"api_key": "<string>",
"api_key_header": "Authorization",
"api_key_prefix": "Bearer",
"oauth": {
"grant_type": "authorization_code",
"client_id": "<string>",
"client_secret": "<string>",
"scopes": [
"<string>"
],
"redirect_uri": "http://127.0.0.1:8765/callback",
"client_name": "Swarms Agent",
"client_uri": "<string>",
"authorization_url": "<string>",
"token_url": "<string>",
"access_token": "<string>",
"refresh_token": "<string>",
"token_storage_path": "<string>",
"use_token_cache": true,
"open_browser": true,
"callback_timeout": 300
},
"transport": "auto",
"headers": {},
"timeout": 30,
"sse_read_timeout": 300,
"tool_timeout": 120,
"command": "<string>",
"args": [
"<string>"
],
"env": {}
}
],
"mcp_urls": [
"<string>"
],
"tool_call_summary": true,
"thinking_tokens": 123,
"reasoning_enabled": false,
"publish_to_marketplace": false,
"use_cases": [
{}
],
"tags": [
"<string>"
],
"capabilities": [
"<string>"
],
"category": "<string>",
"is_free": true,
"price_usd": 123,
"handoffs": [
"<unknown>"
]
}
],
"tasks": [
"<string>"
],
"max_loops": 1,
"imgs": [
"<string>"
]
}
'import requests
url = "https://api.swarms.world/v1/batched-grid-workflow/completions"
payload = {
"name": "<string>",
"description": "<string>",
"agent_completions": [
{
"agent_name": "<string>",
"description": "<string>",
"system_prompt": "<string>",
"marketplace_prompt_id": "<string>",
"model_name": "claude-sonnet-5",
"fallback_models": ["<string>"],
"fallback_model_name": "<string>",
"auto_generate_prompt": False,
"max_tokens": 16000,
"temperature": 1,
"role": "worker",
"max_loops": 1,
"tools_list_dictionary": [{}],
"selected_tools": "<string>",
"mcp_url": "<string>",
"streaming_on": False,
"llm_args": {},
"top_p": 123,
"dynamic_temperature_enabled": False,
"mcp_config": {
"type": "mcp",
"url": "http://localhost:8000/mcp",
"name": "<string>",
"tool_configurations": {},
"authorization_token": "<string>",
"api_key": "<string>",
"api_key_header": "Authorization",
"api_key_prefix": "Bearer",
"oauth": {
"grant_type": "authorization_code",
"client_id": "<string>",
"client_secret": "<string>",
"scopes": ["<string>"],
"redirect_uri": "http://127.0.0.1:8765/callback",
"client_name": "Swarms Agent",
"client_uri": "<string>",
"authorization_url": "<string>",
"token_url": "<string>",
"access_token": "<string>",
"refresh_token": "<string>",
"token_storage_path": "<string>",
"use_token_cache": True,
"open_browser": True,
"callback_timeout": 300
},
"transport": "auto",
"headers": {},
"timeout": 30,
"sse_read_timeout": 300,
"tool_timeout": 120,
"command": "<string>",
"args": ["<string>"],
"env": {}
},
"mcp_configs": [
{
"type": "mcp",
"url": "http://localhost:8000/mcp",
"name": "<string>",
"tool_configurations": {},
"authorization_token": "<string>",
"api_key": "<string>",
"api_key_header": "Authorization",
"api_key_prefix": "Bearer",
"oauth": {
"grant_type": "authorization_code",
"client_id": "<string>",
"client_secret": "<string>",
"scopes": ["<string>"],
"redirect_uri": "http://127.0.0.1:8765/callback",
"client_name": "Swarms Agent",
"client_uri": "<string>",
"authorization_url": "<string>",
"token_url": "<string>",
"access_token": "<string>",
"refresh_token": "<string>",
"token_storage_path": "<string>",
"use_token_cache": True,
"open_browser": True,
"callback_timeout": 300
},
"transport": "auto",
"headers": {},
"timeout": 30,
"sse_read_timeout": 300,
"tool_timeout": 120,
"command": "<string>",
"args": ["<string>"],
"env": {}
}
],
"mcp_urls": ["<string>"],
"tool_call_summary": True,
"thinking_tokens": 123,
"reasoning_enabled": False,
"publish_to_marketplace": False,
"use_cases": [{}],
"tags": ["<string>"],
"capabilities": ["<string>"],
"category": "<string>",
"is_free": True,
"price_usd": 123,
"handoffs": ["<unknown>"]
}
],
"tasks": ["<string>"],
"max_loops": 1,
"imgs": ["<string>"]
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
agent_completions: [
{
agent_name: '<string>',
description: '<string>',
system_prompt: '<string>',
marketplace_prompt_id: '<string>',
model_name: 'claude-sonnet-5',
fallback_models: ['<string>'],
fallback_model_name: '<string>',
auto_generate_prompt: false,
max_tokens: 16000,
temperature: 1,
role: 'worker',
max_loops: 1,
tools_list_dictionary: [{}],
selected_tools: '<string>',
mcp_url: '<string>',
streaming_on: false,
llm_args: {},
top_p: 123,
dynamic_temperature_enabled: false,
mcp_config: {
type: 'mcp',
url: 'http://localhost:8000/mcp',
name: '<string>',
tool_configurations: {},
authorization_token: '<string>',
api_key: '<string>',
api_key_header: 'Authorization',
api_key_prefix: 'Bearer',
oauth: {
grant_type: 'authorization_code',
client_id: '<string>',
client_secret: '<string>',
scopes: ['<string>'],
redirect_uri: 'http://127.0.0.1:8765/callback',
client_name: 'Swarms Agent',
client_uri: '<string>',
authorization_url: '<string>',
token_url: '<string>',
access_token: '<string>',
refresh_token: '<string>',
token_storage_path: '<string>',
use_token_cache: true,
open_browser: true,
callback_timeout: 300
},
transport: 'auto',
headers: {},
timeout: 30,
sse_read_timeout: 300,
tool_timeout: 120,
command: '<string>',
args: ['<string>'],
env: {}
},
mcp_configs: [
{
type: 'mcp',
url: 'http://localhost:8000/mcp',
name: '<string>',
tool_configurations: {},
authorization_token: '<string>',
api_key: '<string>',
api_key_header: 'Authorization',
api_key_prefix: 'Bearer',
oauth: {
grant_type: 'authorization_code',
client_id: '<string>',
client_secret: '<string>',
scopes: ['<string>'],
redirect_uri: 'http://127.0.0.1:8765/callback',
client_name: 'Swarms Agent',
client_uri: '<string>',
authorization_url: '<string>',
token_url: '<string>',
access_token: '<string>',
refresh_token: '<string>',
token_storage_path: '<string>',
use_token_cache: true,
open_browser: true,
callback_timeout: 300
},
transport: 'auto',
headers: {},
timeout: 30,
sse_read_timeout: 300,
tool_timeout: 120,
command: '<string>',
args: ['<string>'],
env: {}
}
],
mcp_urls: ['<string>'],
tool_call_summary: true,
thinking_tokens: 123,
reasoning_enabled: false,
publish_to_marketplace: false,
use_cases: [{}],
tags: ['<string>'],
capabilities: ['<string>'],
category: '<string>',
is_free: true,
price_usd: 123,
handoffs: ['<unknown>']
}
],
tasks: ['<string>'],
max_loops: 1,
imgs: ['<string>']
})
};
fetch('https://api.swarms.world/v1/batched-grid-workflow/completions', 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.swarms.world/v1/batched-grid-workflow/completions",
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([
'name' => '<string>',
'description' => '<string>',
'agent_completions' => [
[
'agent_name' => '<string>',
'description' => '<string>',
'system_prompt' => '<string>',
'marketplace_prompt_id' => '<string>',
'model_name' => 'claude-sonnet-5',
'fallback_models' => [
'<string>'
],
'fallback_model_name' => '<string>',
'auto_generate_prompt' => false,
'max_tokens' => 16000,
'temperature' => 1,
'role' => 'worker',
'max_loops' => 1,
'tools_list_dictionary' => [
[
]
],
'selected_tools' => '<string>',
'mcp_url' => '<string>',
'streaming_on' => false,
'llm_args' => [
],
'top_p' => 123,
'dynamic_temperature_enabled' => false,
'mcp_config' => [
'type' => 'mcp',
'url' => 'http://localhost:8000/mcp',
'name' => '<string>',
'tool_configurations' => [
],
'authorization_token' => '<string>',
'api_key' => '<string>',
'api_key_header' => 'Authorization',
'api_key_prefix' => 'Bearer',
'oauth' => [
'grant_type' => 'authorization_code',
'client_id' => '<string>',
'client_secret' => '<string>',
'scopes' => [
'<string>'
],
'redirect_uri' => 'http://127.0.0.1:8765/callback',
'client_name' => 'Swarms Agent',
'client_uri' => '<string>',
'authorization_url' => '<string>',
'token_url' => '<string>',
'access_token' => '<string>',
'refresh_token' => '<string>',
'token_storage_path' => '<string>',
'use_token_cache' => true,
'open_browser' => true,
'callback_timeout' => 300
],
'transport' => 'auto',
'headers' => [
],
'timeout' => 30,
'sse_read_timeout' => 300,
'tool_timeout' => 120,
'command' => '<string>',
'args' => [
'<string>'
],
'env' => [
]
],
'mcp_configs' => [
[
'type' => 'mcp',
'url' => 'http://localhost:8000/mcp',
'name' => '<string>',
'tool_configurations' => [
],
'authorization_token' => '<string>',
'api_key' => '<string>',
'api_key_header' => 'Authorization',
'api_key_prefix' => 'Bearer',
'oauth' => [
'grant_type' => 'authorization_code',
'client_id' => '<string>',
'client_secret' => '<string>',
'scopes' => [
'<string>'
],
'redirect_uri' => 'http://127.0.0.1:8765/callback',
'client_name' => 'Swarms Agent',
'client_uri' => '<string>',
'authorization_url' => '<string>',
'token_url' => '<string>',
'access_token' => '<string>',
'refresh_token' => '<string>',
'token_storage_path' => '<string>',
'use_token_cache' => true,
'open_browser' => true,
'callback_timeout' => 300
],
'transport' => 'auto',
'headers' => [
],
'timeout' => 30,
'sse_read_timeout' => 300,
'tool_timeout' => 120,
'command' => '<string>',
'args' => [
'<string>'
],
'env' => [
]
]
],
'mcp_urls' => [
'<string>'
],
'tool_call_summary' => true,
'thinking_tokens' => 123,
'reasoning_enabled' => false,
'publish_to_marketplace' => false,
'use_cases' => [
[
]
],
'tags' => [
'<string>'
],
'capabilities' => [
'<string>'
],
'category' => '<string>',
'is_free' => true,
'price_usd' => 123,
'handoffs' => [
'<unknown>'
]
]
],
'tasks' => [
'<string>'
],
'max_loops' => 1,
'imgs' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$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.swarms.world/v1/batched-grid-workflow/completions"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_completions\": [\n {\n \"agent_name\": \"<string>\",\n \"description\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"marketplace_prompt_id\": \"<string>\",\n \"model_name\": \"claude-sonnet-5\",\n \"fallback_models\": [\n \"<string>\"\n ],\n \"fallback_model_name\": \"<string>\",\n \"auto_generate_prompt\": false,\n \"max_tokens\": 16000,\n \"temperature\": 1,\n \"role\": \"worker\",\n \"max_loops\": 1,\n \"tools_list_dictionary\": [\n {}\n ],\n \"selected_tools\": \"<string>\",\n \"mcp_url\": \"<string>\",\n \"streaming_on\": false,\n \"llm_args\": {},\n \"top_p\": 123,\n \"dynamic_temperature_enabled\": false,\n \"mcp_config\": {\n \"type\": \"mcp\",\n \"url\": \"http://localhost:8000/mcp\",\n \"name\": \"<string>\",\n \"tool_configurations\": {},\n \"authorization_token\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_header\": \"Authorization\",\n \"api_key_prefix\": \"Bearer\",\n \"oauth\": {\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"redirect_uri\": \"http://127.0.0.1:8765/callback\",\n \"client_name\": \"Swarms Agent\",\n \"client_uri\": \"<string>\",\n \"authorization_url\": \"<string>\",\n \"token_url\": \"<string>\",\n \"access_token\": \"<string>\",\n \"refresh_token\": \"<string>\",\n \"token_storage_path\": \"<string>\",\n \"use_token_cache\": true,\n \"open_browser\": true,\n \"callback_timeout\": 300\n },\n \"transport\": \"auto\",\n \"headers\": {},\n \"timeout\": 30,\n \"sse_read_timeout\": 300,\n \"tool_timeout\": 120,\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {}\n },\n \"mcp_configs\": [\n {\n \"type\": \"mcp\",\n \"url\": \"http://localhost:8000/mcp\",\n \"name\": \"<string>\",\n \"tool_configurations\": {},\n \"authorization_token\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_header\": \"Authorization\",\n \"api_key_prefix\": \"Bearer\",\n \"oauth\": {\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"redirect_uri\": \"http://127.0.0.1:8765/callback\",\n \"client_name\": \"Swarms Agent\",\n \"client_uri\": \"<string>\",\n \"authorization_url\": \"<string>\",\n \"token_url\": \"<string>\",\n \"access_token\": \"<string>\",\n \"refresh_token\": \"<string>\",\n \"token_storage_path\": \"<string>\",\n \"use_token_cache\": true,\n \"open_browser\": true,\n \"callback_timeout\": 300\n },\n \"transport\": \"auto\",\n \"headers\": {},\n \"timeout\": 30,\n \"sse_read_timeout\": 300,\n \"tool_timeout\": 120,\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {}\n }\n ],\n \"mcp_urls\": [\n \"<string>\"\n ],\n \"tool_call_summary\": true,\n \"thinking_tokens\": 123,\n \"reasoning_enabled\": false,\n \"publish_to_marketplace\": false,\n \"use_cases\": [\n {}\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"capabilities\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"is_free\": true,\n \"price_usd\": 123,\n \"handoffs\": [\n \"<unknown>\"\n ]\n }\n ],\n \"tasks\": [\n \"<string>\"\n ],\n \"max_loops\": 1,\n \"imgs\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
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.swarms.world/v1/batched-grid-workflow/completions")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_completions\": [\n {\n \"agent_name\": \"<string>\",\n \"description\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"marketplace_prompt_id\": \"<string>\",\n \"model_name\": \"claude-sonnet-5\",\n \"fallback_models\": [\n \"<string>\"\n ],\n \"fallback_model_name\": \"<string>\",\n \"auto_generate_prompt\": false,\n \"max_tokens\": 16000,\n \"temperature\": 1,\n \"role\": \"worker\",\n \"max_loops\": 1,\n \"tools_list_dictionary\": [\n {}\n ],\n \"selected_tools\": \"<string>\",\n \"mcp_url\": \"<string>\",\n \"streaming_on\": false,\n \"llm_args\": {},\n \"top_p\": 123,\n \"dynamic_temperature_enabled\": false,\n \"mcp_config\": {\n \"type\": \"mcp\",\n \"url\": \"http://localhost:8000/mcp\",\n \"name\": \"<string>\",\n \"tool_configurations\": {},\n \"authorization_token\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_header\": \"Authorization\",\n \"api_key_prefix\": \"Bearer\",\n \"oauth\": {\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"redirect_uri\": \"http://127.0.0.1:8765/callback\",\n \"client_name\": \"Swarms Agent\",\n \"client_uri\": \"<string>\",\n \"authorization_url\": \"<string>\",\n \"token_url\": \"<string>\",\n \"access_token\": \"<string>\",\n \"refresh_token\": \"<string>\",\n \"token_storage_path\": \"<string>\",\n \"use_token_cache\": true,\n \"open_browser\": true,\n \"callback_timeout\": 300\n },\n \"transport\": \"auto\",\n \"headers\": {},\n \"timeout\": 30,\n \"sse_read_timeout\": 300,\n \"tool_timeout\": 120,\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {}\n },\n \"mcp_configs\": [\n {\n \"type\": \"mcp\",\n \"url\": \"http://localhost:8000/mcp\",\n \"name\": \"<string>\",\n \"tool_configurations\": {},\n \"authorization_token\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_header\": \"Authorization\",\n \"api_key_prefix\": \"Bearer\",\n \"oauth\": {\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"redirect_uri\": \"http://127.0.0.1:8765/callback\",\n \"client_name\": \"Swarms Agent\",\n \"client_uri\": \"<string>\",\n \"authorization_url\": \"<string>\",\n \"token_url\": \"<string>\",\n \"access_token\": \"<string>\",\n \"refresh_token\": \"<string>\",\n \"token_storage_path\": \"<string>\",\n \"use_token_cache\": true,\n \"open_browser\": true,\n \"callback_timeout\": 300\n },\n \"transport\": \"auto\",\n \"headers\": {},\n \"timeout\": 30,\n \"sse_read_timeout\": 300,\n \"tool_timeout\": 120,\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {}\n }\n ],\n \"mcp_urls\": [\n \"<string>\"\n ],\n \"tool_call_summary\": true,\n \"thinking_tokens\": 123,\n \"reasoning_enabled\": false,\n \"publish_to_marketplace\": false,\n \"use_cases\": [\n {}\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"capabilities\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"is_free\": true,\n \"price_usd\": 123,\n \"handoffs\": [\n \"<unknown>\"\n ]\n }\n ],\n \"tasks\": [\n \"<string>\"\n ],\n \"max_loops\": 1,\n \"imgs\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.swarms.world/v1/batched-grid-workflow/completions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_completions\": [\n {\n \"agent_name\": \"<string>\",\n \"description\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"marketplace_prompt_id\": \"<string>\",\n \"model_name\": \"claude-sonnet-5\",\n \"fallback_models\": [\n \"<string>\"\n ],\n \"fallback_model_name\": \"<string>\",\n \"auto_generate_prompt\": false,\n \"max_tokens\": 16000,\n \"temperature\": 1,\n \"role\": \"worker\",\n \"max_loops\": 1,\n \"tools_list_dictionary\": [\n {}\n ],\n \"selected_tools\": \"<string>\",\n \"mcp_url\": \"<string>\",\n \"streaming_on\": false,\n \"llm_args\": {},\n \"top_p\": 123,\n \"dynamic_temperature_enabled\": false,\n \"mcp_config\": {\n \"type\": \"mcp\",\n \"url\": \"http://localhost:8000/mcp\",\n \"name\": \"<string>\",\n \"tool_configurations\": {},\n \"authorization_token\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_header\": \"Authorization\",\n \"api_key_prefix\": \"Bearer\",\n \"oauth\": {\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"redirect_uri\": \"http://127.0.0.1:8765/callback\",\n \"client_name\": \"Swarms Agent\",\n \"client_uri\": \"<string>\",\n \"authorization_url\": \"<string>\",\n \"token_url\": \"<string>\",\n \"access_token\": \"<string>\",\n \"refresh_token\": \"<string>\",\n \"token_storage_path\": \"<string>\",\n \"use_token_cache\": true,\n \"open_browser\": true,\n \"callback_timeout\": 300\n },\n \"transport\": \"auto\",\n \"headers\": {},\n \"timeout\": 30,\n \"sse_read_timeout\": 300,\n \"tool_timeout\": 120,\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {}\n },\n \"mcp_configs\": [\n {\n \"type\": \"mcp\",\n \"url\": \"http://localhost:8000/mcp\",\n \"name\": \"<string>\",\n \"tool_configurations\": {},\n \"authorization_token\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_header\": \"Authorization\",\n \"api_key_prefix\": \"Bearer\",\n \"oauth\": {\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"redirect_uri\": \"http://127.0.0.1:8765/callback\",\n \"client_name\": \"Swarms Agent\",\n \"client_uri\": \"<string>\",\n \"authorization_url\": \"<string>\",\n \"token_url\": \"<string>\",\n \"access_token\": \"<string>\",\n \"refresh_token\": \"<string>\",\n \"token_storage_path\": \"<string>\",\n \"use_token_cache\": true,\n \"open_browser\": true,\n \"callback_timeout\": 300\n },\n \"transport\": \"auto\",\n \"headers\": {},\n \"timeout\": 30,\n \"sse_read_timeout\": 300,\n \"tool_timeout\": 120,\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {}\n }\n ],\n \"mcp_urls\": [\n \"<string>\"\n ],\n \"tool_call_summary\": true,\n \"thinking_tokens\": 123,\n \"reasoning_enabled\": false,\n \"publish_to_marketplace\": false,\n \"use_cases\": [\n {}\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"capabilities\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"is_free\": true,\n \"price_usd\": 123,\n \"handoffs\": [\n \"<unknown>\"\n ]\n }\n ],\n \"tasks\": [\n \"<string>\"\n ],\n \"max_loops\": 1,\n \"imgs\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"job_id": "<string>",
"status": "<string>",
"outputs": "<unknown>",
"usage": {
"input_tokens": 123,
"output_tokens": 123,
"total_tokens": 123,
"total_cost": 123,
"cost_per_agent": 0.01
},
"timestamp": "<string>",
"name": "<string>",
"description": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Batched Grid Workflow
Execute Batched Grid Workflow
Execute a batched grid workflow enabling parallel execution of multiple agents across multiple tasks in a single request. This is a premium-only feature.
POST
/
v1
/
batched-grid-workflow
/
completions
Execute Batched Grid Workflow
curl --request POST \
--url https://api.swarms.world/v1/batched-grid-workflow/completions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"agent_completions": [
{
"agent_name": "<string>",
"description": "<string>",
"system_prompt": "<string>",
"marketplace_prompt_id": "<string>",
"model_name": "claude-sonnet-5",
"fallback_models": [
"<string>"
],
"fallback_model_name": "<string>",
"auto_generate_prompt": false,
"max_tokens": 16000,
"temperature": 1,
"role": "worker",
"max_loops": 1,
"tools_list_dictionary": [
{}
],
"selected_tools": "<string>",
"mcp_url": "<string>",
"streaming_on": false,
"llm_args": {},
"top_p": 123,
"dynamic_temperature_enabled": false,
"mcp_config": {
"type": "mcp",
"url": "http://localhost:8000/mcp",
"name": "<string>",
"tool_configurations": {},
"authorization_token": "<string>",
"api_key": "<string>",
"api_key_header": "Authorization",
"api_key_prefix": "Bearer",
"oauth": {
"grant_type": "authorization_code",
"client_id": "<string>",
"client_secret": "<string>",
"scopes": [
"<string>"
],
"redirect_uri": "http://127.0.0.1:8765/callback",
"client_name": "Swarms Agent",
"client_uri": "<string>",
"authorization_url": "<string>",
"token_url": "<string>",
"access_token": "<string>",
"refresh_token": "<string>",
"token_storage_path": "<string>",
"use_token_cache": true,
"open_browser": true,
"callback_timeout": 300
},
"transport": "auto",
"headers": {},
"timeout": 30,
"sse_read_timeout": 300,
"tool_timeout": 120,
"command": "<string>",
"args": [
"<string>"
],
"env": {}
},
"mcp_configs": [
{
"type": "mcp",
"url": "http://localhost:8000/mcp",
"name": "<string>",
"tool_configurations": {},
"authorization_token": "<string>",
"api_key": "<string>",
"api_key_header": "Authorization",
"api_key_prefix": "Bearer",
"oauth": {
"grant_type": "authorization_code",
"client_id": "<string>",
"client_secret": "<string>",
"scopes": [
"<string>"
],
"redirect_uri": "http://127.0.0.1:8765/callback",
"client_name": "Swarms Agent",
"client_uri": "<string>",
"authorization_url": "<string>",
"token_url": "<string>",
"access_token": "<string>",
"refresh_token": "<string>",
"token_storage_path": "<string>",
"use_token_cache": true,
"open_browser": true,
"callback_timeout": 300
},
"transport": "auto",
"headers": {},
"timeout": 30,
"sse_read_timeout": 300,
"tool_timeout": 120,
"command": "<string>",
"args": [
"<string>"
],
"env": {}
}
],
"mcp_urls": [
"<string>"
],
"tool_call_summary": true,
"thinking_tokens": 123,
"reasoning_enabled": false,
"publish_to_marketplace": false,
"use_cases": [
{}
],
"tags": [
"<string>"
],
"capabilities": [
"<string>"
],
"category": "<string>",
"is_free": true,
"price_usd": 123,
"handoffs": [
"<unknown>"
]
}
],
"tasks": [
"<string>"
],
"max_loops": 1,
"imgs": [
"<string>"
]
}
'import requests
url = "https://api.swarms.world/v1/batched-grid-workflow/completions"
payload = {
"name": "<string>",
"description": "<string>",
"agent_completions": [
{
"agent_name": "<string>",
"description": "<string>",
"system_prompt": "<string>",
"marketplace_prompt_id": "<string>",
"model_name": "claude-sonnet-5",
"fallback_models": ["<string>"],
"fallback_model_name": "<string>",
"auto_generate_prompt": False,
"max_tokens": 16000,
"temperature": 1,
"role": "worker",
"max_loops": 1,
"tools_list_dictionary": [{}],
"selected_tools": "<string>",
"mcp_url": "<string>",
"streaming_on": False,
"llm_args": {},
"top_p": 123,
"dynamic_temperature_enabled": False,
"mcp_config": {
"type": "mcp",
"url": "http://localhost:8000/mcp",
"name": "<string>",
"tool_configurations": {},
"authorization_token": "<string>",
"api_key": "<string>",
"api_key_header": "Authorization",
"api_key_prefix": "Bearer",
"oauth": {
"grant_type": "authorization_code",
"client_id": "<string>",
"client_secret": "<string>",
"scopes": ["<string>"],
"redirect_uri": "http://127.0.0.1:8765/callback",
"client_name": "Swarms Agent",
"client_uri": "<string>",
"authorization_url": "<string>",
"token_url": "<string>",
"access_token": "<string>",
"refresh_token": "<string>",
"token_storage_path": "<string>",
"use_token_cache": True,
"open_browser": True,
"callback_timeout": 300
},
"transport": "auto",
"headers": {},
"timeout": 30,
"sse_read_timeout": 300,
"tool_timeout": 120,
"command": "<string>",
"args": ["<string>"],
"env": {}
},
"mcp_configs": [
{
"type": "mcp",
"url": "http://localhost:8000/mcp",
"name": "<string>",
"tool_configurations": {},
"authorization_token": "<string>",
"api_key": "<string>",
"api_key_header": "Authorization",
"api_key_prefix": "Bearer",
"oauth": {
"grant_type": "authorization_code",
"client_id": "<string>",
"client_secret": "<string>",
"scopes": ["<string>"],
"redirect_uri": "http://127.0.0.1:8765/callback",
"client_name": "Swarms Agent",
"client_uri": "<string>",
"authorization_url": "<string>",
"token_url": "<string>",
"access_token": "<string>",
"refresh_token": "<string>",
"token_storage_path": "<string>",
"use_token_cache": True,
"open_browser": True,
"callback_timeout": 300
},
"transport": "auto",
"headers": {},
"timeout": 30,
"sse_read_timeout": 300,
"tool_timeout": 120,
"command": "<string>",
"args": ["<string>"],
"env": {}
}
],
"mcp_urls": ["<string>"],
"tool_call_summary": True,
"thinking_tokens": 123,
"reasoning_enabled": False,
"publish_to_marketplace": False,
"use_cases": [{}],
"tags": ["<string>"],
"capabilities": ["<string>"],
"category": "<string>",
"is_free": True,
"price_usd": 123,
"handoffs": ["<unknown>"]
}
],
"tasks": ["<string>"],
"max_loops": 1,
"imgs": ["<string>"]
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
agent_completions: [
{
agent_name: '<string>',
description: '<string>',
system_prompt: '<string>',
marketplace_prompt_id: '<string>',
model_name: 'claude-sonnet-5',
fallback_models: ['<string>'],
fallback_model_name: '<string>',
auto_generate_prompt: false,
max_tokens: 16000,
temperature: 1,
role: 'worker',
max_loops: 1,
tools_list_dictionary: [{}],
selected_tools: '<string>',
mcp_url: '<string>',
streaming_on: false,
llm_args: {},
top_p: 123,
dynamic_temperature_enabled: false,
mcp_config: {
type: 'mcp',
url: 'http://localhost:8000/mcp',
name: '<string>',
tool_configurations: {},
authorization_token: '<string>',
api_key: '<string>',
api_key_header: 'Authorization',
api_key_prefix: 'Bearer',
oauth: {
grant_type: 'authorization_code',
client_id: '<string>',
client_secret: '<string>',
scopes: ['<string>'],
redirect_uri: 'http://127.0.0.1:8765/callback',
client_name: 'Swarms Agent',
client_uri: '<string>',
authorization_url: '<string>',
token_url: '<string>',
access_token: '<string>',
refresh_token: '<string>',
token_storage_path: '<string>',
use_token_cache: true,
open_browser: true,
callback_timeout: 300
},
transport: 'auto',
headers: {},
timeout: 30,
sse_read_timeout: 300,
tool_timeout: 120,
command: '<string>',
args: ['<string>'],
env: {}
},
mcp_configs: [
{
type: 'mcp',
url: 'http://localhost:8000/mcp',
name: '<string>',
tool_configurations: {},
authorization_token: '<string>',
api_key: '<string>',
api_key_header: 'Authorization',
api_key_prefix: 'Bearer',
oauth: {
grant_type: 'authorization_code',
client_id: '<string>',
client_secret: '<string>',
scopes: ['<string>'],
redirect_uri: 'http://127.0.0.1:8765/callback',
client_name: 'Swarms Agent',
client_uri: '<string>',
authorization_url: '<string>',
token_url: '<string>',
access_token: '<string>',
refresh_token: '<string>',
token_storage_path: '<string>',
use_token_cache: true,
open_browser: true,
callback_timeout: 300
},
transport: 'auto',
headers: {},
timeout: 30,
sse_read_timeout: 300,
tool_timeout: 120,
command: '<string>',
args: ['<string>'],
env: {}
}
],
mcp_urls: ['<string>'],
tool_call_summary: true,
thinking_tokens: 123,
reasoning_enabled: false,
publish_to_marketplace: false,
use_cases: [{}],
tags: ['<string>'],
capabilities: ['<string>'],
category: '<string>',
is_free: true,
price_usd: 123,
handoffs: ['<unknown>']
}
],
tasks: ['<string>'],
max_loops: 1,
imgs: ['<string>']
})
};
fetch('https://api.swarms.world/v1/batched-grid-workflow/completions', 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.swarms.world/v1/batched-grid-workflow/completions",
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([
'name' => '<string>',
'description' => '<string>',
'agent_completions' => [
[
'agent_name' => '<string>',
'description' => '<string>',
'system_prompt' => '<string>',
'marketplace_prompt_id' => '<string>',
'model_name' => 'claude-sonnet-5',
'fallback_models' => [
'<string>'
],
'fallback_model_name' => '<string>',
'auto_generate_prompt' => false,
'max_tokens' => 16000,
'temperature' => 1,
'role' => 'worker',
'max_loops' => 1,
'tools_list_dictionary' => [
[
]
],
'selected_tools' => '<string>',
'mcp_url' => '<string>',
'streaming_on' => false,
'llm_args' => [
],
'top_p' => 123,
'dynamic_temperature_enabled' => false,
'mcp_config' => [
'type' => 'mcp',
'url' => 'http://localhost:8000/mcp',
'name' => '<string>',
'tool_configurations' => [
],
'authorization_token' => '<string>',
'api_key' => '<string>',
'api_key_header' => 'Authorization',
'api_key_prefix' => 'Bearer',
'oauth' => [
'grant_type' => 'authorization_code',
'client_id' => '<string>',
'client_secret' => '<string>',
'scopes' => [
'<string>'
],
'redirect_uri' => 'http://127.0.0.1:8765/callback',
'client_name' => 'Swarms Agent',
'client_uri' => '<string>',
'authorization_url' => '<string>',
'token_url' => '<string>',
'access_token' => '<string>',
'refresh_token' => '<string>',
'token_storage_path' => '<string>',
'use_token_cache' => true,
'open_browser' => true,
'callback_timeout' => 300
],
'transport' => 'auto',
'headers' => [
],
'timeout' => 30,
'sse_read_timeout' => 300,
'tool_timeout' => 120,
'command' => '<string>',
'args' => [
'<string>'
],
'env' => [
]
],
'mcp_configs' => [
[
'type' => 'mcp',
'url' => 'http://localhost:8000/mcp',
'name' => '<string>',
'tool_configurations' => [
],
'authorization_token' => '<string>',
'api_key' => '<string>',
'api_key_header' => 'Authorization',
'api_key_prefix' => 'Bearer',
'oauth' => [
'grant_type' => 'authorization_code',
'client_id' => '<string>',
'client_secret' => '<string>',
'scopes' => [
'<string>'
],
'redirect_uri' => 'http://127.0.0.1:8765/callback',
'client_name' => 'Swarms Agent',
'client_uri' => '<string>',
'authorization_url' => '<string>',
'token_url' => '<string>',
'access_token' => '<string>',
'refresh_token' => '<string>',
'token_storage_path' => '<string>',
'use_token_cache' => true,
'open_browser' => true,
'callback_timeout' => 300
],
'transport' => 'auto',
'headers' => [
],
'timeout' => 30,
'sse_read_timeout' => 300,
'tool_timeout' => 120,
'command' => '<string>',
'args' => [
'<string>'
],
'env' => [
]
]
],
'mcp_urls' => [
'<string>'
],
'tool_call_summary' => true,
'thinking_tokens' => 123,
'reasoning_enabled' => false,
'publish_to_marketplace' => false,
'use_cases' => [
[
]
],
'tags' => [
'<string>'
],
'capabilities' => [
'<string>'
],
'category' => '<string>',
'is_free' => true,
'price_usd' => 123,
'handoffs' => [
'<unknown>'
]
]
],
'tasks' => [
'<string>'
],
'max_loops' => 1,
'imgs' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$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.swarms.world/v1/batched-grid-workflow/completions"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_completions\": [\n {\n \"agent_name\": \"<string>\",\n \"description\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"marketplace_prompt_id\": \"<string>\",\n \"model_name\": \"claude-sonnet-5\",\n \"fallback_models\": [\n \"<string>\"\n ],\n \"fallback_model_name\": \"<string>\",\n \"auto_generate_prompt\": false,\n \"max_tokens\": 16000,\n \"temperature\": 1,\n \"role\": \"worker\",\n \"max_loops\": 1,\n \"tools_list_dictionary\": [\n {}\n ],\n \"selected_tools\": \"<string>\",\n \"mcp_url\": \"<string>\",\n \"streaming_on\": false,\n \"llm_args\": {},\n \"top_p\": 123,\n \"dynamic_temperature_enabled\": false,\n \"mcp_config\": {\n \"type\": \"mcp\",\n \"url\": \"http://localhost:8000/mcp\",\n \"name\": \"<string>\",\n \"tool_configurations\": {},\n \"authorization_token\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_header\": \"Authorization\",\n \"api_key_prefix\": \"Bearer\",\n \"oauth\": {\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"redirect_uri\": \"http://127.0.0.1:8765/callback\",\n \"client_name\": \"Swarms Agent\",\n \"client_uri\": \"<string>\",\n \"authorization_url\": \"<string>\",\n \"token_url\": \"<string>\",\n \"access_token\": \"<string>\",\n \"refresh_token\": \"<string>\",\n \"token_storage_path\": \"<string>\",\n \"use_token_cache\": true,\n \"open_browser\": true,\n \"callback_timeout\": 300\n },\n \"transport\": \"auto\",\n \"headers\": {},\n \"timeout\": 30,\n \"sse_read_timeout\": 300,\n \"tool_timeout\": 120,\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {}\n },\n \"mcp_configs\": [\n {\n \"type\": \"mcp\",\n \"url\": \"http://localhost:8000/mcp\",\n \"name\": \"<string>\",\n \"tool_configurations\": {},\n \"authorization_token\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_header\": \"Authorization\",\n \"api_key_prefix\": \"Bearer\",\n \"oauth\": {\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"redirect_uri\": \"http://127.0.0.1:8765/callback\",\n \"client_name\": \"Swarms Agent\",\n \"client_uri\": \"<string>\",\n \"authorization_url\": \"<string>\",\n \"token_url\": \"<string>\",\n \"access_token\": \"<string>\",\n \"refresh_token\": \"<string>\",\n \"token_storage_path\": \"<string>\",\n \"use_token_cache\": true,\n \"open_browser\": true,\n \"callback_timeout\": 300\n },\n \"transport\": \"auto\",\n \"headers\": {},\n \"timeout\": 30,\n \"sse_read_timeout\": 300,\n \"tool_timeout\": 120,\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {}\n }\n ],\n \"mcp_urls\": [\n \"<string>\"\n ],\n \"tool_call_summary\": true,\n \"thinking_tokens\": 123,\n \"reasoning_enabled\": false,\n \"publish_to_marketplace\": false,\n \"use_cases\": [\n {}\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"capabilities\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"is_free\": true,\n \"price_usd\": 123,\n \"handoffs\": [\n \"<unknown>\"\n ]\n }\n ],\n \"tasks\": [\n \"<string>\"\n ],\n \"max_loops\": 1,\n \"imgs\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
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.swarms.world/v1/batched-grid-workflow/completions")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_completions\": [\n {\n \"agent_name\": \"<string>\",\n \"description\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"marketplace_prompt_id\": \"<string>\",\n \"model_name\": \"claude-sonnet-5\",\n \"fallback_models\": [\n \"<string>\"\n ],\n \"fallback_model_name\": \"<string>\",\n \"auto_generate_prompt\": false,\n \"max_tokens\": 16000,\n \"temperature\": 1,\n \"role\": \"worker\",\n \"max_loops\": 1,\n \"tools_list_dictionary\": [\n {}\n ],\n \"selected_tools\": \"<string>\",\n \"mcp_url\": \"<string>\",\n \"streaming_on\": false,\n \"llm_args\": {},\n \"top_p\": 123,\n \"dynamic_temperature_enabled\": false,\n \"mcp_config\": {\n \"type\": \"mcp\",\n \"url\": \"http://localhost:8000/mcp\",\n \"name\": \"<string>\",\n \"tool_configurations\": {},\n \"authorization_token\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_header\": \"Authorization\",\n \"api_key_prefix\": \"Bearer\",\n \"oauth\": {\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"redirect_uri\": \"http://127.0.0.1:8765/callback\",\n \"client_name\": \"Swarms Agent\",\n \"client_uri\": \"<string>\",\n \"authorization_url\": \"<string>\",\n \"token_url\": \"<string>\",\n \"access_token\": \"<string>\",\n \"refresh_token\": \"<string>\",\n \"token_storage_path\": \"<string>\",\n \"use_token_cache\": true,\n \"open_browser\": true,\n \"callback_timeout\": 300\n },\n \"transport\": \"auto\",\n \"headers\": {},\n \"timeout\": 30,\n \"sse_read_timeout\": 300,\n \"tool_timeout\": 120,\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {}\n },\n \"mcp_configs\": [\n {\n \"type\": \"mcp\",\n \"url\": \"http://localhost:8000/mcp\",\n \"name\": \"<string>\",\n \"tool_configurations\": {},\n \"authorization_token\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_header\": \"Authorization\",\n \"api_key_prefix\": \"Bearer\",\n \"oauth\": {\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"redirect_uri\": \"http://127.0.0.1:8765/callback\",\n \"client_name\": \"Swarms Agent\",\n \"client_uri\": \"<string>\",\n \"authorization_url\": \"<string>\",\n \"token_url\": \"<string>\",\n \"access_token\": \"<string>\",\n \"refresh_token\": \"<string>\",\n \"token_storage_path\": \"<string>\",\n \"use_token_cache\": true,\n \"open_browser\": true,\n \"callback_timeout\": 300\n },\n \"transport\": \"auto\",\n \"headers\": {},\n \"timeout\": 30,\n \"sse_read_timeout\": 300,\n \"tool_timeout\": 120,\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {}\n }\n ],\n \"mcp_urls\": [\n \"<string>\"\n ],\n \"tool_call_summary\": true,\n \"thinking_tokens\": 123,\n \"reasoning_enabled\": false,\n \"publish_to_marketplace\": false,\n \"use_cases\": [\n {}\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"capabilities\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"is_free\": true,\n \"price_usd\": 123,\n \"handoffs\": [\n \"<unknown>\"\n ]\n }\n ],\n \"tasks\": [\n \"<string>\"\n ],\n \"max_loops\": 1,\n \"imgs\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.swarms.world/v1/batched-grid-workflow/completions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_completions\": [\n {\n \"agent_name\": \"<string>\",\n \"description\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"marketplace_prompt_id\": \"<string>\",\n \"model_name\": \"claude-sonnet-5\",\n \"fallback_models\": [\n \"<string>\"\n ],\n \"fallback_model_name\": \"<string>\",\n \"auto_generate_prompt\": false,\n \"max_tokens\": 16000,\n \"temperature\": 1,\n \"role\": \"worker\",\n \"max_loops\": 1,\n \"tools_list_dictionary\": [\n {}\n ],\n \"selected_tools\": \"<string>\",\n \"mcp_url\": \"<string>\",\n \"streaming_on\": false,\n \"llm_args\": {},\n \"top_p\": 123,\n \"dynamic_temperature_enabled\": false,\n \"mcp_config\": {\n \"type\": \"mcp\",\n \"url\": \"http://localhost:8000/mcp\",\n \"name\": \"<string>\",\n \"tool_configurations\": {},\n \"authorization_token\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_header\": \"Authorization\",\n \"api_key_prefix\": \"Bearer\",\n \"oauth\": {\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"redirect_uri\": \"http://127.0.0.1:8765/callback\",\n \"client_name\": \"Swarms Agent\",\n \"client_uri\": \"<string>\",\n \"authorization_url\": \"<string>\",\n \"token_url\": \"<string>\",\n \"access_token\": \"<string>\",\n \"refresh_token\": \"<string>\",\n \"token_storage_path\": \"<string>\",\n \"use_token_cache\": true,\n \"open_browser\": true,\n \"callback_timeout\": 300\n },\n \"transport\": \"auto\",\n \"headers\": {},\n \"timeout\": 30,\n \"sse_read_timeout\": 300,\n \"tool_timeout\": 120,\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {}\n },\n \"mcp_configs\": [\n {\n \"type\": \"mcp\",\n \"url\": \"http://localhost:8000/mcp\",\n \"name\": \"<string>\",\n \"tool_configurations\": {},\n \"authorization_token\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_header\": \"Authorization\",\n \"api_key_prefix\": \"Bearer\",\n \"oauth\": {\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"redirect_uri\": \"http://127.0.0.1:8765/callback\",\n \"client_name\": \"Swarms Agent\",\n \"client_uri\": \"<string>\",\n \"authorization_url\": \"<string>\",\n \"token_url\": \"<string>\",\n \"access_token\": \"<string>\",\n \"refresh_token\": \"<string>\",\n \"token_storage_path\": \"<string>\",\n \"use_token_cache\": true,\n \"open_browser\": true,\n \"callback_timeout\": 300\n },\n \"transport\": \"auto\",\n \"headers\": {},\n \"timeout\": 30,\n \"sse_read_timeout\": 300,\n \"tool_timeout\": 120,\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {}\n }\n ],\n \"mcp_urls\": [\n \"<string>\"\n ],\n \"tool_call_summary\": true,\n \"thinking_tokens\": 123,\n \"reasoning_enabled\": false,\n \"publish_to_marketplace\": false,\n \"use_cases\": [\n {}\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"capabilities\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"is_free\": true,\n \"price_usd\": 123,\n \"handoffs\": [\n \"<unknown>\"\n ]\n }\n ],\n \"tasks\": [\n \"<string>\"\n ],\n \"max_loops\": 1,\n \"imgs\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"job_id": "<string>",
"status": "<string>",
"outputs": "<unknown>",
"usage": {
"input_tokens": 123,
"output_tokens": 123,
"total_tokens": 123,
"total_cost": 123,
"cost_per_agent": 0.01
},
"timestamp": "<string>",
"name": "<string>",
"description": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Body
application/json
The name of the batched grid workflow.
The description of the batched grid workflow.
The agent completions to be completed by the batched grid workflow.
Maximum array length:
50Show child attributes
Show child attributes
The tasks to be completed by the batched grid workflow.
Maximum array length:
50The maximum number of loops to be completed by the batched grid workflow. At most 50.
Required range:
1 <= x <= 50Not supported. The grid runs every agent without images, so a non-empty list is rejected with 422.
Response
Successful Response
The job ID of the batched grid workflow.
The status of the batched grid workflow.
The outputs of the batched grid workflow.
The usage of the batched grid workflow.
Show child attributes
Show child attributes
The timestamp of the batched grid workflow.
The name of the batched grid workflow.
The description of the batched grid workflow.
Was this page helpful?