All URIs are relative to https://scrapebadger.com
| Method | HTTP request | Description |
|---|---|---|
| chatgpt_ask_chatgpt_a_question | GET /v1/chatgpt/ask | Ask ChatGPT a question |
| chatgpt_ask_chatgpt_a_question_post | POST /v1/chatgpt/ask | Ask ChatGPT a question (POST) |
| chatgpt_chatgpt_scraper_health_check | GET /v1/chatgpt/health | ChatGPT scraper health check |
| chatgpt_chatgpt_scraper_health_check_head | HEAD /v1/chatgpt/health | ChatGPT scraper health check |
| chatgpt_list_chatgpt_models | GET /v1/chatgpt/models | List ChatGPT models |
| chatgpt_measure_a_brand_s_visibility_in_a_chatgpt_answer | GET /v1/chatgpt/brand-visibility | Measure a brand's visibility in a ChatGPT answer |
| chatgpt_measure_a_brand_s_visibility_in_a_chatgpt_answer_post | POST /v1/chatgpt/brand-visibility | Measure a brand's visibility in a ChatGPT answer (POST) |
serde_json::Value chatgpt_ask_chatgpt_a_question(prompt, country, web_search, image_url) Ask ChatGPT a question
Send a prompt to ChatGPT and get the answer plus the web sources it cited.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| prompt | String | The prompt to send to ChatGPT (max 4096 characters). | [required] | |
| country | Option<String> | ISO-3166 alpha-2 egress country, e.g. 'US', 'GB', 'DE'. | ||
| web_search | Option<String> | auto (let ChatGPT decide) | force (ask it to browse) | off (answer from memory). web_search_triggered in the response always reports what actually happened. |
| image_url | Option<String> | Public http(s) URL of an image to attach to the prompt. ChatGPT reads it and answers about it. POST also accepts image_base64. Exactly one of the two. |
serde_json::Value
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
serde_json::Value chatgpt_ask_chatgpt_a_question_post() Ask ChatGPT a question (POST)
POST form of /ask, for prompts too long for a query string.
This endpoint does not need any parameter.
serde_json::Value
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
serde_json::Value chatgpt_chatgpt_scraper_health_check() ChatGPT scraper health check
Check health of the ChatGPT scraper service (accepts HEAD).
This endpoint does not need any parameter.
serde_json::Value
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
serde_json::Value chatgpt_chatgpt_scraper_health_check_head() ChatGPT scraper health check
Check health of the ChatGPT scraper service (accepts HEAD).
This endpoint does not need any parameter.
serde_json::Value
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
serde_json::Value chatgpt_list_chatgpt_models(country) List ChatGPT models
Models chatgpt.com currently serves to an anonymous visitor.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| country | Option<String> | ISO-3166 alpha-2 egress country. |
serde_json::Value
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
serde_json::Value chatgpt_measure_a_brand_s_visibility_in_a_chatgpt_answer(prompt, brand, domain, aliases, competitors, country, web_search) Measure a brand's visibility in a ChatGPT answer
Ask ChatGPT, then report whether the brand is mentioned, cited and how prominently.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| prompt | String | The prompt to ask ChatGPT. | [required] | |
| brand | String | Brand name to look for in the answer. | [required] | |
| domain | Option<String> | Brand domain, for citation matching. | ||
| aliases | Option<String> | Comma-separated alternative names. | ||
| competitors | Option<String> | Comma-separated competitor names. | ||
| country | Option<String> | ISO-3166 alpha-2 egress country. | ||
| web_search | Option<String> | auto | force | off |
serde_json::Value
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
serde_json::Value chatgpt_measure_a_brand_s_visibility_in_a_chatgpt_answer_post() Measure a brand's visibility in a ChatGPT answer (POST)
POST form, for longer prompts and larger competitor sets.
This endpoint does not need any parameter.
serde_json::Value
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]