Create Run

curl --request POST \
  --url https://api.newscatcherapi.com/agent/runs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": "<string>",
  "companies": {
    "list_id": "<string>",
    "items": [
      {
        "domain": "<string>",
        "name": "<string>"
      }
    ],
    "save_as_list": false,
    "list_name": "<string>"
  },
  "lookback_days": 123,
  "include_market_activity": true,
  "read_web": true,
  "recheck_borderline": true,
  "mode": "fast",
  "keep_updated": {
    "schedule": {
      "every": "day",
      "at": "09:00",
      "tz": "UTC",
      "weekday": 3,
      "hours": 12
    },
    "name": "<string>"
  }
}
'

import requests

url = "https://api.newscatcherapi.com/agent/runs"

payload = {
    "query": "<string>",
    "companies": {
        "list_id": "<string>",
        "items": [
            {
                "domain": "<string>",
                "name": "<string>"
            }
        ],
        "save_as_list": False,
        "list_name": "<string>"
    },
    "lookback_days": 123,
    "include_market_activity": True,
    "read_web": True,
    "recheck_borderline": True,
    "mode": "fast",
    "keep_updated": {
        "schedule": {
            "every": "day",
            "at": "09:00",
            "tz": "UTC",
            "weekday": 3,
            "hours": 12
        },
        "name": "<string>"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    companies: {
      list_id: '<string>',
      items: [{domain: '<string>', name: '<string>'}],
      save_as_list: false,
      list_name: '<string>'
    },
    lookback_days: 123,
    include_market_activity: true,
    read_web: true,
    recheck_borderline: true,
    mode: 'fast',
    keep_updated: {
      schedule: {every: 'day', at: '09:00', tz: 'UTC', weekday: 3, hours: 12},
      name: '<string>'
    }
  })
};

fetch('https://api.newscatcherapi.com/agent/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.newscatcherapi.com/agent/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>',
    'companies' => [
        'list_id' => '<string>',
        'items' => [
                [
                                'domain' => '<string>',
                                'name' => '<string>'
                ]
        ],
        'save_as_list' => false,
        'list_name' => '<string>'
    ],
    'lookback_days' => 123,
    'include_market_activity' => true,
    'read_web' => true,
    'recheck_borderline' => true,
    'mode' => 'fast',
    'keep_updated' => [
        'schedule' => [
                'every' => 'day',
                'at' => '09:00',
                'tz' => 'UTC',
                'weekday' => 3,
                'hours' => 12
        ],
        'name' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.newscatcherapi.com/agent/runs"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"companies\": {\n    \"list_id\": \"<string>\",\n    \"items\": [\n      {\n        \"domain\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"save_as_list\": false,\n    \"list_name\": \"<string>\"\n  },\n  \"lookback_days\": 123,\n  \"include_market_activity\": true,\n  \"read_web\": true,\n  \"recheck_borderline\": true,\n  \"mode\": \"fast\",\n  \"keep_updated\": {\n    \"schedule\": {\n      \"every\": \"day\",\n      \"at\": \"09:00\",\n      \"tz\": \"UTC\",\n      \"weekday\": 3,\n      \"hours\": 12\n    },\n    \"name\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.newscatcherapi.com/agent/runs")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"companies\": {\n    \"list_id\": \"<string>\",\n    \"items\": [\n      {\n        \"domain\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"save_as_list\": false,\n    \"list_name\": \"<string>\"\n  },\n  \"lookback_days\": 123,\n  \"include_market_activity\": true,\n  \"read_web\": true,\n  \"recheck_borderline\": true,\n  \"mode\": \"fast\",\n  \"keep_updated\": {\n    \"schedule\": {\n      \"every\": \"day\",\n      \"at\": \"09:00\",\n      \"tz\": \"UTC\",\n      \"weekday\": 3,\n      \"hours\": 12\n    },\n    \"name\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.newscatcherapi.com/agent/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"companies\": {\n    \"list_id\": \"<string>\",\n    \"items\": [\n      {\n        \"domain\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"save_as_list\": false,\n    \"list_name\": \"<string>\"\n  },\n  \"lookback_days\": 123,\n  \"include_market_activity\": true,\n  \"read_web\": true,\n  \"recheck_borderline\": true,\n  \"mode\": \"fast\",\n  \"keep_updated\": {\n    \"schedule\": {\n      \"every\": \"day\",\n      \"at\": \"09:00\",\n      \"tz\": \"UTC\",\n      \"weekday\": 3,\n      \"hours\": 12\n    },\n    \"name\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "kind": "events",
  "run_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "keep_updated": {
    "status": "pending",
    "monitor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "error": "<string>",
    "schedule": {}
  }
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

POST

runs

Create Run

curl --request POST \
  --url https://api.newscatcherapi.com/agent/runs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": "<string>",
  "companies": {
    "list_id": "<string>",
    "items": [
      {
        "domain": "<string>",
        "name": "<string>"
      }
    ],
    "save_as_list": false,
    "list_name": "<string>"
  },
  "lookback_days": 123,
  "include_market_activity": true,
  "read_web": true,
  "recheck_borderline": true,
  "mode": "fast",
  "keep_updated": {
    "schedule": {
      "every": "day",
      "at": "09:00",
      "tz": "UTC",
      "weekday": 3,
      "hours": 12
    },
    "name": "<string>"
  }
}
'

import requests

url = "https://api.newscatcherapi.com/agent/runs"

payload = {
    "query": "<string>",
    "companies": {
        "list_id": "<string>",
        "items": [
            {
                "domain": "<string>",
                "name": "<string>"
            }
        ],
        "save_as_list": False,
        "list_name": "<string>"
    },
    "lookback_days": 123,
    "include_market_activity": True,
    "read_web": True,
    "recheck_borderline": True,
    "mode": "fast",
    "keep_updated": {
        "schedule": {
            "every": "day",
            "at": "09:00",
            "tz": "UTC",
            "weekday": 3,
            "hours": 12
        },
        "name": "<string>"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    companies: {
      list_id: '<string>',
      items: [{domain: '<string>', name: '<string>'}],
      save_as_list: false,
      list_name: '<string>'
    },
    lookback_days: 123,
    include_market_activity: true,
    read_web: true,
    recheck_borderline: true,
    mode: 'fast',
    keep_updated: {
      schedule: {every: 'day', at: '09:00', tz: 'UTC', weekday: 3, hours: 12},
      name: '<string>'
    }
  })
};

fetch('https://api.newscatcherapi.com/agent/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.newscatcherapi.com/agent/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>',
    'companies' => [
        'list_id' => '<string>',
        'items' => [
                [
                                'domain' => '<string>',
                                'name' => '<string>'
                ]
        ],
        'save_as_list' => false,
        'list_name' => '<string>'
    ],
    'lookback_days' => 123,
    'include_market_activity' => true,
    'read_web' => true,
    'recheck_borderline' => true,
    'mode' => 'fast',
    'keep_updated' => [
        'schedule' => [
                'every' => 'day',
                'at' => '09:00',
                'tz' => 'UTC',
                'weekday' => 3,
                'hours' => 12
        ],
        'name' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.newscatcherapi.com/agent/runs"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"companies\": {\n    \"list_id\": \"<string>\",\n    \"items\": [\n      {\n        \"domain\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"save_as_list\": false,\n    \"list_name\": \"<string>\"\n  },\n  \"lookback_days\": 123,\n  \"include_market_activity\": true,\n  \"read_web\": true,\n  \"recheck_borderline\": true,\n  \"mode\": \"fast\",\n  \"keep_updated\": {\n    \"schedule\": {\n      \"every\": \"day\",\n      \"at\": \"09:00\",\n      \"tz\": \"UTC\",\n      \"weekday\": 3,\n      \"hours\": 12\n    },\n    \"name\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.newscatcherapi.com/agent/runs")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"companies\": {\n    \"list_id\": \"<string>\",\n    \"items\": [\n      {\n        \"domain\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"save_as_list\": false,\n    \"list_name\": \"<string>\"\n  },\n  \"lookback_days\": 123,\n  \"include_market_activity\": true,\n  \"read_web\": true,\n  \"recheck_borderline\": true,\n  \"mode\": \"fast\",\n  \"keep_updated\": {\n    \"schedule\": {\n      \"every\": \"day\",\n      \"at\": \"09:00\",\n      \"tz\": \"UTC\",\n      \"weekday\": 3,\n      \"hours\": 12\n    },\n    \"name\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.newscatcherapi.com/agent/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"companies\": {\n    \"list_id\": \"<string>\",\n    \"items\": [\n      {\n        \"domain\": \"<string>\",\n        \"name\": \"<string>\"\n      }\n    ],\n    \"save_as_list\": false,\n    \"list_name\": \"<string>\"\n  },\n  \"lookback_days\": 123,\n  \"include_market_activity\": true,\n  \"read_web\": true,\n  \"recheck_borderline\": true,\n  \"mode\": \"fast\",\n  \"keep_updated\": {\n    \"schedule\": {\n      \"every\": \"day\",\n      \"at\": \"09:00\",\n      \"tz\": \"UTC\",\n      \"weekday\": 3,\n      \"hours\": 12\n    },\n    \"name\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "kind": "events",
  "run_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "keep_updated": {
    "status": "pending",
    "monitor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "error": "<string>",
    "schedule": {}
  }
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

Authorizations

x-api-key

string

header

required

Body

application/json

POST /runs: one entry point. Without companies it finds events from the query (Fast, Standard or Max); with companies it finds each company's news stories (Standard; the query, if any, keeps the stories about it).

query

string | null

What to find, e.g. 'Bank M&A deals announced in the US since Sep 15'. Required without companies. With companies it is optional: only stories about it are kept, e.g. 'funding and acquisitions' (blank: every story about the companies).

companies

CompaniesIn · object | null

Find news about these companies instead of events from the question.

Show child attributes

lookback_days

integer | null

With companies: how many days back from today (1-365, default 30). Event runs read their time window from the query.

include_market_activity

boolean | null

With companies: keep market_activity stories (stock moves, analyst ratings; default true).

read_web

boolean | null

With companies: also read their own newsroom and the web (default true).

recheck_borderline

boolean | null

With companies: a stronger model rechecks borderline web pages for little-covered companies (default true).

mode

enum<string>

default:fast

fast: one agent, about 1-3 minutes. standard: deep research (planned slices, every web page read, each row verified, a cited briefing), about 10-30 minutes. max: deep research with stronger models, higher recall and cost. With companies: standard only (the default there). "default", Standard's name before 0.10.0, is still accepted.

Available options:

fast,

standard,

max

max_rows

enum<integer> | null

Without companies: rows to return at most, in every mode: 50 (default), 100, 150 or 200, up to your plan's cap (100 today; more is refused with too_many_rows). A run is charged per 50 rows delivered past the first 50.

Available options:

50,

100,

150,

200

keep_updated

KeepUpdatedIn · object | null

Keep it updated: once the run succeeds, the agent makes a monitor of it (a companies run -> a company monitor, following its company list if any; an events run -> a dataset monitor). The run is the monitor's first run; the monitor then delivers only what is new. Its state is the run's keep_updated.

Show child attributes

Response

Successful Response

A queued run.

run_id

string<uuid>

required

status

string

required

kind

string

default:events

run_ids

string<uuid>[] | null

batch_id

string<uuid> | null

list_id

string<uuid> | null

keep_updated

KeepUpdatedOut · object | null

A run started with keep_updated: its monitor, once made.

Show child attributes

News API

Agent

Create Run

Authorizations

Body

Response