Skip to main content
POST
/
v1
/
advanced-research
/
completions
Execute Advanced Research Session
curl --request POST \
  --url https://api.swarms.world/v1/advanced-research/completions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "config": {
    "name": "Advanced Research",
    "description": "Advanced Research",
    "worker_model_name": "gpt-4.1",
    "director_agent_name": "Director-Agent",
    "director_model_name": "gpt-4.1",
    "director_max_tokens": 8000,
    "max_loops": 1,
    "director_max_loops": 1,
    "exa_search_num_results": 2,
    "exa_search_max_characters": 100
  },
  "task": "<string>",
  "img": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "outputs": "<unknown>",
  "timestamp": "<string>",
  "sources": 123,
  "characters_per_source": 123,
  "usage": {}
}

Headers

​
x-api-key
string
required

Body

application/json
​
config
AdvancedResearchConfig · object
required

The configuration for the advanced research

​
task
string | null
required

The task to be completed

​
img
string | null

The image to be used for the advanced research

Response

Successful Response

​
id
string | null
required

The id of the advanced research session

​
name
string | null
required

The name of the advanced research session

​
description
string | null
required

The description of the advanced research session

​
outputs
any | null
required

The outputs of the advanced research session

​
timestamp
string | null
required

The timestamp of the advanced research session

​
sources
integer | null
required

The number of sources used for the advanced research session

​
characters_per_source
integer | null
required

The number of characters per source used for the advanced research session

​
usage
Usage · object
required

The usage of the advanced research session