Run an on-demand mention search

Runs a one-time search for query across the workspace’s enabled sources over the last 1/7/30 days and AI-scores the results inline using the workspace’s company profile. Results belong to the search (they do NOT appear in the mentions feed); new results count against the monthly mention quota, while results the workspace already collected are flagged alreadyInWorkspace and are free.

Blocks up to waitMs (≤25s). Returns 200 with the full result envelope if it finishes in time, otherwise 202 with a searchId + pollUrl to poll GET /api/v2/search/{searchId}.

Responses carry remaining-quota headers (X-Octolens-Mentions-Remaining always; X-Octolens-Searches-Remaining on plans with a lifetime search cap) so clients can self-throttle before hitting the quota wall.

POST

api

Run an on-demand mention search

curl --request POST \
  --url https://app.octolens.com/api/v2/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "sources": [
    "<string>"
  ],
  "excludeSources": [
    "<string>"
  ],
  "keywordContext": "<string>",
  "additionalTerms": "<string>",
  "additionalTermsAndOr": false,
  "excludeWords": "<string>",
  "minRelevance": "medium",
  "includeNonRelevant": false,
  "maxResults": 100,
  "waitMs": 25000
}
'

import requests

url = "https://app.octolens.com/api/v2/search"

payload = {
    "query": "<string>",
    "sources": ["<string>"],
    "excludeSources": ["<string>"],
    "keywordContext": "<string>",
    "additionalTerms": "<string>",
    "additionalTermsAndOr": False,
    "excludeWords": "<string>",
    "minRelevance": "medium",
    "includeNonRelevant": False,
    "maxResults": 100,
    "waitMs": 25000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    sources: ['<string>'],
    excludeSources: ['<string>'],
    keywordContext: '<string>',
    additionalTerms: '<string>',
    additionalTermsAndOr: false,
    excludeWords: '<string>',
    minRelevance: 'medium',
    includeNonRelevant: false,
    maxResults: 100,
    waitMs: 25000
  })
};

fetch('https://app.octolens.com/api/v2/search', 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://app.octolens.com/api/v2/search",
  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>',
    'sources' => [
        '<string>'
    ],
    'excludeSources' => [
        '<string>'
    ],
    'keywordContext' => '<string>',
    'additionalTerms' => '<string>',
    'additionalTermsAndOr' => false,
    'excludeWords' => '<string>',
    'minRelevance' => 'medium',
    'includeNonRelevant' => false,
    'maxResults' => 100,
    'waitMs' => 25000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://app.octolens.com/api/v2/search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"sources\": [\n    \"<string>\"\n  ],\n  \"excludeSources\": [\n    \"<string>\"\n  ],\n  \"keywordContext\": \"<string>\",\n  \"additionalTerms\": \"<string>\",\n  \"additionalTermsAndOr\": false,\n  \"excludeWords\": \"<string>\",\n  \"minRelevance\": \"medium\",\n  \"includeNonRelevant\": false,\n  \"maxResults\": 100,\n  \"waitMs\": 25000\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://app.octolens.com/api/v2/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"sources\": [\n    \"<string>\"\n  ],\n  \"excludeSources\": [\n    \"<string>\"\n  ],\n  \"keywordContext\": \"<string>\",\n  \"additionalTerms\": \"<string>\",\n  \"additionalTermsAndOr\": false,\n  \"excludeWords\": \"<string>\",\n  \"minRelevance\": \"medium\",\n  \"includeNonRelevant\": false,\n  \"maxResults\": 100,\n  \"waitMs\": 25000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"sources\": [\n    \"<string>\"\n  ],\n  \"excludeSources\": [\n    \"<string>\"\n  ],\n  \"keywordContext\": \"<string>\",\n  \"additionalTerms\": \"<string>\",\n  \"additionalTermsAndOr\": false,\n  \"excludeWords\": \"<string>\",\n  \"minRelevance\": \"medium\",\n  \"includeNonRelevant\": false,\n  \"maxResults\": 100,\n  \"waitMs\": 25000\n}"

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

{
  "searchId": "<string>",
  "status": "completed",
  "query": "<string>",
  "timeWindow": "1d",
  "sources": [
    "<string>"
  ],
  "startedAt": "<string>",
  "completedAt": "<string>",
  "stats": {
    "rawMatches": 0,
    "afterDedup": 0,
    "afterRelevance": 0,
    "mentionsConsumed": 0,
    "perSource": {},
    "skippedSources": {}
  },
  "mentions": [
    {
      "id": 0,
      "sourceId": "reddit_t3_1abc234",
      "url": "https://reddit.com/r/example/comments/abc123/...",
      "title": "<string>",
      "body": "<string>",
      "source": "reddit",
      "timestamp": "2026-05-06 13:35:37.000",
      "author": "jane.doe",
      "authorName": "<string>",
      "authorAvatar": "<string>",
      "authorUrl": "<string>",
      "authorFollowers": 0,
      "relevance": "relevant",
      "relevanceComment": "<string>",
      "sentiment": "Neutral",
      "language": "english",
      "tags": [
        "competitor_mention",
        "pricing"
      ],
      "keywords": [
        {
          "id": 42,
          "keyword": "social listening"
        }
      ],
      "engaged": true,
      "relevanceScore": 123,
      "feedbackRelevant": 123,
      "imageUrl": "<string>",
      "keywordId": 123,
      "alreadyInWorkspace": true
    }
  ]
}

{
  "searchId": "<string>",
  "status": "running",
  "query": "<string>",
  "timeWindow": "1d",
  "sources": [
    "<string>"
  ],
  "pollUrl": "<string>",
  "partialStats": {
    "rawMatches": 0,
    "afterDedup": 0,
    "afterRelevance": 0,
    "mentionsConsumed": 0,
    "perSource": {},
    "skippedSources": {}
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

Authorizations

Authorization

string

header

required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>.

Body

application/json

On-demand mention search request.

query

string

required

The search phrase.

Required string length: 1 - 500

timeWindow

enum<string>

required

How far back to search: last 1, 7, or 30 days.

Available options:

1d,

7d,

30d

sources

string[]

Subset of workspace-enabled platforms to search. Defaults to all enabled sources.

Maximum array length: 64

Maximum string length: 64

excludeSources

string[]

Sources subtracted from the resolved source list.

Maximum array length: 64

Maximum string length: 64

keywordContext

string

Per-call relevance disambiguation. Overrides the workspace's relevance context for this call only.

Maximum string length: 2000

additionalTerms

string

Comma-separated terms required to co-occur with the query.

Maximum string length: 500

additionalTermsAndOr

boolean

default:false

false = AND (default), true = OR for additionalTerms.

excludeWords

string

Comma-separated exclusions.

Maximum string length: 500

minRelevance

enum<string>

default:medium

Display filter: hide relevant results below this AI-relevance bar from the response. Does not affect what is saved or billed. Ignored when includeNonRelevant is true.

Available options:

high,

medium,

low

includeNonRelevant

boolean

default:false

Display flag only. When true, mentions the AI judged NOT relevant are also returned (marked relevance: "not_relevant"). This does NOT change billing or persistence: every mention that reaches AI scoring is saved to the search and counts against the monthly quota regardless of this flag — it only controls what the response shows. Default false.

maxResults

integer

default:100

Result budget: drives how many candidates are fetched per source (min(maxResults, 100) each), AI-scored (which is what consumes mention quota), and returned. Default 100, cap 500.

Required range: 1 <= x <= 500

waitMs

integer

default:25000

How long the request blocks before falling back to async (202 + poll). Default and max 25000.

Required range: 0 <= x <= 25000

Response

200 response

Completed on-demand search.

searchId

string

required

status

string

required

Allowed value: "completed"

query

string

required

timeWindow

enum<string>

required

Available options:

1d,

7d,

30d

sources

string[]

required

startedAt

string

required

completedAt

string

required

stats

object

required

Per-stage funnel counts for a search.

Show child attributes

mentions

object[]

required

Show child attributes

Run an on-demand mention search

curl --request POST \
  --url https://app.octolens.com/api/v2/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "sources": [
    "<string>"
  ],
  "excludeSources": [
    "<string>"
  ],
  "keywordContext": "<string>",
  "additionalTerms": "<string>",
  "additionalTermsAndOr": false,
  "excludeWords": "<string>",
  "minRelevance": "medium",
  "includeNonRelevant": false,
  "maxResults": 100,
  "waitMs": 25000
}
'

import requests

url = "https://app.octolens.com/api/v2/search"

payload = {
    "query": "<string>",
    "sources": ["<string>"],
    "excludeSources": ["<string>"],
    "keywordContext": "<string>",
    "additionalTerms": "<string>",
    "additionalTermsAndOr": False,
    "excludeWords": "<string>",
    "minRelevance": "medium",
    "includeNonRelevant": False,
    "maxResults": 100,
    "waitMs": 25000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    sources: ['<string>'],
    excludeSources: ['<string>'],
    keywordContext: '<string>',
    additionalTerms: '<string>',
    additionalTermsAndOr: false,
    excludeWords: '<string>',
    minRelevance: 'medium',
    includeNonRelevant: false,
    maxResults: 100,
    waitMs: 25000
  })
};

fetch('https://app.octolens.com/api/v2/search', 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://app.octolens.com/api/v2/search",
  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>',
    'sources' => [
        '<string>'
    ],
    'excludeSources' => [
        '<string>'
    ],
    'keywordContext' => '<string>',
    'additionalTerms' => '<string>',
    'additionalTermsAndOr' => false,
    'excludeWords' => '<string>',
    'minRelevance' => 'medium',
    'includeNonRelevant' => false,
    'maxResults' => 100,
    'waitMs' => 25000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://app.octolens.com/api/v2/search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"sources\": [\n    \"<string>\"\n  ],\n  \"excludeSources\": [\n    \"<string>\"\n  ],\n  \"keywordContext\": \"<string>\",\n  \"additionalTerms\": \"<string>\",\n  \"additionalTermsAndOr\": false,\n  \"excludeWords\": \"<string>\",\n  \"minRelevance\": \"medium\",\n  \"includeNonRelevant\": false,\n  \"maxResults\": 100,\n  \"waitMs\": 25000\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://app.octolens.com/api/v2/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"sources\": [\n    \"<string>\"\n  ],\n  \"excludeSources\": [\n    \"<string>\"\n  ],\n  \"keywordContext\": \"<string>\",\n  \"additionalTerms\": \"<string>\",\n  \"additionalTermsAndOr\": false,\n  \"excludeWords\": \"<string>\",\n  \"minRelevance\": \"medium\",\n  \"includeNonRelevant\": false,\n  \"maxResults\": 100,\n  \"waitMs\": 25000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"sources\": [\n    \"<string>\"\n  ],\n  \"excludeSources\": [\n    \"<string>\"\n  ],\n  \"keywordContext\": \"<string>\",\n  \"additionalTerms\": \"<string>\",\n  \"additionalTermsAndOr\": false,\n  \"excludeWords\": \"<string>\",\n  \"minRelevance\": \"medium\",\n  \"includeNonRelevant\": false,\n  \"maxResults\": 100,\n  \"waitMs\": 25000\n}"

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

{
  "searchId": "<string>",
  "status": "completed",
  "query": "<string>",
  "timeWindow": "1d",
  "sources": [
    "<string>"
  ],
  "startedAt": "<string>",
  "completedAt": "<string>",
  "stats": {
    "rawMatches": 0,
    "afterDedup": 0,
    "afterRelevance": 0,
    "mentionsConsumed": 0,
    "perSource": {},
    "skippedSources": {}
  },
  "mentions": [
    {
      "id": 0,
      "sourceId": "reddit_t3_1abc234",
      "url": "https://reddit.com/r/example/comments/abc123/...",
      "title": "<string>",
      "body": "<string>",
      "source": "reddit",
      "timestamp": "2026-05-06 13:35:37.000",
      "author": "jane.doe",
      "authorName": "<string>",
      "authorAvatar": "<string>",
      "authorUrl": "<string>",
      "authorFollowers": 0,
      "relevance": "relevant",
      "relevanceComment": "<string>",
      "sentiment": "Neutral",
      "language": "english",
      "tags": [
        "competitor_mention",
        "pricing"
      ],
      "keywords": [
        {
          "id": 42,
          "keyword": "social listening"
        }
      ],
      "engaged": true,
      "relevanceScore": 123,
      "feedbackRelevant": 123,
      "imageUrl": "<string>",
      "keywordId": 123,
      "alreadyInWorkspace": true
    }
  ]
}

{
  "searchId": "<string>",
  "status": "running",
  "query": "<string>",
  "timeWindow": "1d",
  "sources": [
    "<string>"
  ],
  "pollUrl": "<string>",
  "partialStats": {
    "rawMatches": 0,
    "afterDedup": 0,
    "afterRelevance": 0,
    "mentionsConsumed": 0,
    "perSource": {},
    "skippedSources": {}
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}