Skip to main content
POST
/
v1
/
agents
/
batch
Agent Batch
curl --request POST \
  --url https://sdk.nimbleway.com/v1/agents/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "params": {
        "keyword": "iphone 15"
      }
    },
    {
      "params": {
        "keyword": "iphone 16"
      }
    },
    {
      "params": {
        "keyword": "iphone 17"
      }
    }
  ],
  "shared_inputs": {
    "agent": "amazon_serp"
  }
}
'
{
  "batch_id": "4b0a90bf-c951-42e4-95b3-a95a65ba69fc",
  "batch_size": 1,
  "tasks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "state": "pending",
      "output_url": "string",
      "created_at": "2024-01-15T10:30:00Z",
      "modified_at": "2024-01-15T10:35:00Z",
      "account_name": "string",
      "input": null,
      "batch_id": "4b0a90bf-c951-42e4-95b3-a95a65ba69fc",
      "status_code": 200,
      "api_type": "extract"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for executing a batch of agent requests

inputs
AgentBatchInputsPayload · object[]
required
shared_inputs
AgentPayload · object
required

Request body model for the /agent/run endpoint

Response

Agent Batch Created

Response when a batch of extract tasks is created successfully.

batch_id
string

Unique identifier for the batch.

batch_size
number

Number of tasks in the batch.

tasks
object[]

List of created tasks.