Batched Grid Workflow

Execute Batched Grid Workflow

Changed on Oct 31, 2026

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

Request

Base URL
https://api.swarms.world
URL
https://api.swarms.world/v1/batched-grid-workflow/completions
Auth
none declared. Required headers: x-api-key

Headers

x-api-keystring required

Request body

namestring nullable

The name of the batched grid workflow.

descriptionstring nullable

The description of the batched grid workflow.

tasksstring[] nullable

The tasks to be completed by the batched grid workflow.

max_loopsinteger nullable

The maximum number of loops to be completed by the batched grid workflow. At most 50.

imgsstring[] nullable

Not supported. The grid runs every agent without images, so a non-empty list is rejected with 422.

Response

Successful Response

job_idstring required

The job ID of the batched grid workflow.

namestring nullable

The name of the batched grid workflow.

descriptionstring nullable

The description of the batched grid workflow.

statusstring required

"success" when every agent ran, "partial" when at least one failed. A run where every agent fails returns 502 and is not charged.

outputsunknown required

timestampstring required

The timestamp of the batched grid workflow.

Changes

Oct 31, 20263e13975ede3d Revision changes
- info
  added the optional property / to the response with the status
Oct 16, 2026500c79520e41 Revision changes
- breaking
  removed from the /// request property anyOf list
- breaking
  request property //// was restricted to a list of enum values
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  response property description list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property name list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  removed the required property / from the response with the status
- warning
  the //// request property's max was set to 2.00
- warning
  the / request property's max was set to 50.00
- warning
  the //// request property's min was set to 1.00
- warning
  the //// request property's min was set to 0.00
- warning
  the / request property's min was set to 1.00
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added subschema #3 to the /// request property anyOf list
- info
  added subschema #1 to the /// request property anyOf list
- info
  added subschema #2 to the /// request property anyOf list
- info
  the request property /// became optional
- info
  the request property default value 1 was added
- info
  the request property default value changed from true to false
- info
  the request property default value changed from 8192 to 16000
- info
  the request property default value changed from gpt-4.1 to claude-sonnet-5
- info
  the request property default value changed from 10 to 30
- info
  the request property default value changed from streamable_http to auto
- info
  the request property default value 0.5 was removed
- info
  added the new None enum value to the request property ////
- info
  added the new high enum value to the request property ////
- info
  added the new low enum value to the request property ////
- info
  added the new max enum value to the request property ////
- info
  added the new medium enum value to the request property ////
- info
  added the new minimal enum value to the request property ////
- info
  added the new none enum value to the request property ////
- info
  added the new ultra enum value to the request property ////
- info
  added the new xhigh enum value to the request property ////
- info
  request property /// list-of-types was widened by adding types string to media type application/json
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  the response's property default value 0.01 was added for the status
- info
  added the required property / to the response with the status

Operation history