SWswarms
Auto Agent Builder

Generate Agent Configurations From a Task

Changed on

Generate a roster of agent configurations for a task. A single builder agent designs the team and returns ready-to-post AgentSpec entries — the generated agents are not executed by this endpoint.

post/v1/auto-agent-builder/completions

Request

  • Base URL
    https://api.swarms.world
  • URL
    https://api.swarms.world/v1/auto-agent-builder/completions
  • Auth
    none declared. Required headers: x-api-key

Headers

x-api-keystring required

Request body

taskstring required

The task the generated team should be able to handle. This is the only required field.

namestring nullable

The name of this auto agent builder run.

descriptionstring nullable

The description of this auto agent builder run.

model_namestring nullable

The model backing the builder agent itself — not the models given to the generated agents; the builder chooses those per agent. Defaults to the framework's builder default.

max_agentsinteger nullable

Upper bound on roster size. This is a ceiling, not a target — the builder prefers the smallest roster that covers the task.

num_agentsinteger nullable

Exact number of agents to generate. When set, this overrides max_agents and the builder's prefer-fewer guidance.

system_promptstring nullable

Custom instructions for the builder agent. Defaults to the framework's builder system prompt.

agent_kwargsobject nullable

Extra keyword arguments carried on every generated agent, e.g. max_loops or streaming_on. Keys that collide with the fields the builder generates (agent_name, description, system_prompt, model_name) are ignored.

Response

Successful Response

job_idstring required

The job ID of the auto agent builder run.

namestring required

The name of the auto agent builder run.

descriptionstring required

The description of the auto agent builder run.

statusstring required

The status of the auto agent builder run.

timestampstring required

The timestamp of the auto agent builder run.

Changes

  • 3e13975ede3dRevision changes
    • info

      added the optional property / to the response with the status

  • ee4273b4b6aeRevision changes
    • info

      the response's property default value changed from streamable_http to auto for the status

    • info

      the response's property default value changed from streamable_http to auto for the status

    • info

      the response's property default value changed from streamable_http to auto for the status

    • info

      the response's property default value changed from streamable_http to auto for the status