Skip to main content
POST
/
v1
/
agent
/
async
Agent Async
curl --request POST \
  --url https://sdk.nimbleway.com/v1/agent/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent": "google_search",
  "params": {
    "query": "What happened last night in the NBA?",
    "storage_url": "s3://mu-s3-bucket.com/",
    "storage_type": "s3",
    "callback_url": "https://my-callback-url.com/"
  }
}
'
{
  "status": "success",
  "task": {
    "id": "8e8cfde8-345b-42b8-b3e2-0c61eb11e00f",
    "state": "pending",
    "created_at": "2026-01-24T12:36:24.685Z",
    "modified_at": "2026-01-24T12:36:24.685Z",
    "input": {}
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Request body model for the /agent endpoint

​
agent
string
required

The agent's name to execute

Example:

"google_search"

​
params
object
required

The agent's input parameters, for example query, prodcut_id, etc. Depands on the agent used.

Example:
{
  "query": "What happened last night in the NBA?"
}
​
localization
boolean

Controls if localization sould be enabled (default false). Some agent support localization based on zip_code or store_id on the site it self. Relevant only when agent is supporting localization

​
storage_type
enum<string>

Storage type for async results. Use s3 for Amazon S3 and gs for Google Cloud Platform.

Available options:
s3,
gs
Example:

"s3"

​
storage_url
string

Repository URL where output will be saved. Format: s3://Your.Bucket.Name/your/object/name/prefix/ - Output will be saved as TASK_ID.json

Example:

"s3://Your.Repository.Path/"

​
callback_url
string<uri>

A URL to callback once the data is delivered. The API will send a POST request with task details (without the requested data) when the task completes.

Example:

"https://your.callback.url/path"

​
storage_compress
boolean

When set to true, the response saved to storage_url will be compressed using GZIP format. If false or not set, response will be saved uncompressed.

Example:

false

​
storage_object_name
string

Custom name for the stored object instead of the default task ID

Example:

"my task"

Response

Async Task Created

​
status
string
required
Example:

"success"

​
task
object
required