Agentic Platform
Documentation API reference Tools Skills

Tools

Chatgpt Websearch

chatgpt_websearch Web search

Call ChatGPT.com using web search tool to get real-time responses and information.

Use ChatGPT's web interface to search for information and get responses. This agent interacts with ChatGPT's web interface and retrieve answers to queries in real-time. This agent can help you: - Get answers to questions from ChatGPT's web interface - Access ChatGPT's knowledge and capabilities through web scraping - Get location-specific results by specifying a country code

Playground

Your organization, project and token stay in this browser's local storage and are sent straight to the API — this page never sees them.

POST
item
query required The search query to send to ChatGPT
config
country ISO 3166-1 alpha-2 country code for location-based results (e.g., 'US', 'FR')

Billing

Fixed cost per prompt requested, plus one AI assistant answer (snapshot) per prompt, billed when the prompt is submitted. Collecting the finished results adds nothing.

These usage SKUs can be charged on a call.

SKU Credits Description
Tool call 1 per request Charged once per successful item, on top of any usage below.
AI assistant answers (snapshot) 15 per 10 prompt An assistant answer read from a pre-collected dataset rather than asked fresh.

Schemas

item is what you send, config how the tool behaves, and the response is what you get back.

Item

object
Properties
query string required

The search query to send to ChatGPT

min length 1

Example
{
  "query": "string"
}

Configuration

object
Properties
country string

ISO 3166-1 alpha-2 country code for location-based results (e.g., 'US', 'FR')

Default: ""

Example
{
  "country": ""
}

Response

object

Unified output item for ChatGPT web search agents.

Properties
query string required

The search query that was executed

answer_text_markdown string required

The markdown response from ChatGPT

links array required

Inline citation links from the response

Items: Link

citations array required

Sources cited in the response

Items: Citation

shopping array required

Shopping results if any

Items: Shopping

shopping_visible boolean required

Whether shopping results are visible

web_search_triggered boolean required

Whether the answer shows evidence of a web search (citations, search sources, search queries, inline citation links, or shopping items)

search_sources array required

Search result sources with snippets

Items: SearchSource

model string | null

Name / version of the model used by ChatGPT (e.g., 'gpt-4o')

Default: null

search_queries array | null

Web search queries used during processing

Default: null

Example
{
  "query": "string",
  "answer_text_markdown": "string",
  "links": [
    {
      "url": "string",
      "text": "string",
      "position": 0
    }
  ],
  "citations": [
    {
      "url": "string",
      "title": null,
      "description": null,
      "icon": null,
      "domain": null,
      "cited": true
    }
  ],
  "shopping": [
    {
      "title": null,
      "image": null,
      "description": null,
      "link": null,
      "tag": null,
      "all_images": [],
      "rating": null,
      "purchasing_options": [],
      "reviews": null,
      "why_you_might_like_this": null,
      "what_people_are_saying": null,
      "merchants": null
    }
  ],
  "shopping_visible": true,
  "web_search_triggered": true,
  "search_sources": [
    {
      "url": "string",
      "title": null,
      "snippet": null,
      "rank": 0,
      "date_published": null
    }
  ],
  "model": null,
  "search_queries": null
}

Type Definitions

5 types

These are the available sub-object types that can be used in the properties above.

Citation object
#

A source cited in the response with metadata.

url string required
title string | null

Default: null

description string | null

Default: null

icon string | null

Default: null

domain string | null

Default: null

cited boolean required
SearchSource object
#

A search result source with snippet and ranking info.

url string required
title string | null

Default: null

snippet string | null

Default: null

rank integer required
date_published string | null

Default: null

Shopping object
#

A shopping result item.

title string | null

Default: null

image string | null

Default: null

description string | null

Default: null

link string | null

Default: null

tag string | null

Default: null

all_images array

Default: []

rating number | null

Default: null

purchasing_options array

Items: ShoppingPurchasingOption

Default: []

reviews integer | null

Default: null

why_you_might_like_this string | null

Default: null

what_people_are_saying string | null

Default: null

merchants string | null

Free-form merchant label as reported by the scraper (e.g. 'Dunelm + others'). Used to render a fallback merchant name when no direct seller URL is available.

Default: null

ShoppingPurchasingOption object
#

A purchasing option for a shopping item.

price number required
currency string required
website string required
buy_link string required

Endpoints

POST http://agents.botify.com/{organization}/{project}/chatgpt_websearch/process
POST http://agents.botify.com/{organization}/{project}/chatgpt_websearch/batch_process
POST http://agents.botify.com/{organization}/{project}/chatgpt_websearch/async_process
POST http://agents.botify.com/{organization}/{project}/chatgpt_websearch/async_batch_process

See running a long job in the background for the polling flow.

cURL

curl -X POST "http://agents.botify.com/{organization}/{project}/chatgpt_websearch/process" \
  -H "Authorization: Bearer $BOTIFY_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "item": {
    "query": "<query>"
  }
}'

Raw metadata