{"info":{"_postman_id":"3f1b801e-21bf-4bd5-be04-75dae108ae24","name":"ContentLook API Overview","description":"

The ContentLook API provides secure, programmatic access to all the features available in the ContentLook platform. It is designed for developers who want to integrate AI-powered website assistants, custom content, traffic analysis, and SEO intelligence into their own applications or workflows.

With the API, you can:

Manage websites and sync their content for AI processing
\n
Create, retrieve, update, or delete AI Agents tailored to each website and language
\n
Add custom content that improves the AI Agent’s ability to answer accurately
\n
Manage predefined questions to guide end-user interactions
\n
Trigger deep website syncs with SEO, link, and traffic data
\n
Integrate with Google Analytics and Search Console to enrich insights
\n

All API requests require an API key passed via headers. Some endpoints also require an Agent key when querying or configuring individual agents.

The API follows standard REST principles, uses query parameters for input, and returns JSON responses.

⚠️ Important: For traffic and organic data features, you must connect your Google accounts and manually perform a resync from the ContentLook dashboard.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4140756","collectionId":"3f1b801e-21bf-4bd5-be04-75dae108ae24","publishedId":"2sB2j7e9id","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"26516a","highlight":"673ab7"},"publishDate":"2025-05-13T04:40:58.000Z"},"item":[{"name":"Websites","item":[{"name":"Content","item":[{"name":"/api/website/content/add","id":"d907388c-f5d8-4510-9f62-1cd5f224670a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://app.contentlook.ai/api/website/content/add?id={{WebsiteID}}&title=Title&content=HTML Content&type=webpage&language=en&url=https://demo.squirrly.co/custom1","description":"

Description

Adds custom content to a website in your ContentLook account. This content does not need to be publicly visible on the website. It will be used by the AI Agent to provide more accurate answers and recommend the specified URL.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

id (String, required)
\n
The unique ID of the website to which you want to add content.
\n
title (String, required)
The title of the content.
\n
content (String, required)
\n
The HTML content to be used for answering questions.
\n
type (String, required)
\n
Defines the type of content. Accepted values: \"webpage\", \"product\" or \"article\".
\n
language (String, required)
\n
The language code of the content.
\n
Supported language codes include examples like:
\n
- \"en\" (English)
  \n
- \"fr\" (French)
  \n
- \"es\" (Spanish)
  \n
- \"de\" (German)
  \n
- \"zh-CN\" (Chinese Simplified)
  \n
\n
url (String, required)
\n
The URL to be recommended when the AI Agent responds based on this content.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the content was successfully added.
\n
error (String, optional)
\n
Returned only if the request failed. For example, \"url_exists\" if the same URL is already added.
\n

Example

{\n  \"success\": true\n}\n\n

Fail Example

{\n  \"success\": false,\n  \"error\": \"url_exists\"\n}\n\n

The unique ID of the website to which you want to add content.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"},{"description":{"content":"

The title of the content.

\n","type":"text/plain"},"key":"title","value":"Title"},{"description":{"content":"

The HTML content to be used for answering questions.

\n","type":"text/plain"},"key":"content","value":"HTML Content"},{"description":{"content":"

Defines the type of content. Accepted values: \"webpage\", \"product\" or \"article\".

\n","type":"text/plain"},"key":"type","value":"webpage"},{"description":{"content":"

The language code of the content.

\n","type":"text/plain"},"key":"language","value":"en"},{"description":{"content":"

The URL to be recommended when the AI Agent responds based on this content.

\n","type":"text/plain"},"key":"url","value":"https://demo.squirrly.co/custom1"}],"variable":[]}},"response":[],"_postman_id":"d907388c-f5d8-4510-9f62-1cd5f224670a"},{"name":"/api/website/content/delete","id":"4adb2b55-724f-4830-979d-ba542919ecf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://app.contentlook.ai/api/website/content/delete?id={{WebsiteID}}&url=https://demo.squirrly.co/csdcsdcsdc/","description":"

Description

Deletes a custom content item previously added to a specific website in your ContentLook account. The content is identified by the exact URL provided.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

id (String, required)
\n
The unique ID of the website where the content is stored.
\n
url (String, required)
\n
The exact URL of the custom content to delete.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the content was successfully deleted.
\n

Example

{\n  \"success\": true\n}\n\n

The unique ID of the website to which you want to add content.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"},{"description":{"content":"

The exact URL of the custom content to delete.

\n","type":"text/plain"},"key":"url","value":"https://demo.squirrly.co/csdcsdcsdc/"}],"variable":[]}},"response":[],"_postman_id":"4adb2b55-724f-4830-979d-ba542919ecf6"}],"id":"12c74505-bdae-4856-8663-7b5310877695","event":[{"listen":"prerequest","script":{"id":"3295e13a-41dc-4433-99de-24e49ec3c6a8","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"d2d8412d-d061-405e-8252-45fb3f150494","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"12c74505-bdae-4856-8663-7b5310877695","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"3f1b801e-21bf-4bd5-be04-75dae108ae24","id":"3f1b801e-21bf-4bd5-be04-75dae108ae24","name":"ContentLook API Overview","type":"collection"}}},{"name":"Crawlers","item":[{"name":"/api/website/crawler","id":"cc62ea2f-61be-4fed-a1bb-37a151b8bd65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://app.contentlook.ai/api/website/crawler?id={{WebsiteID}}&max_pages=500&sitemaps_auto=1&sitemaps=https://example.com/sitemap.xml&include_urls=https://example.com/path&include_traffic=0&include_organic=0&include_seo=1&include_socials=0&include_links=0&include_authority=0&exclude_noindex=1&exclude_css=header,footer&exclude_urls","description":"

Description

Creates a crawler for a specific website based on the provided configuration. If no parameters are set, default settings will be used. For traffic and organic data, it’s mandatory to connect your Google Analytics and Google Search Console accounts first and perform a resync from the dashboard.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

id (String, required)
\n
The unique ID of the website to be synced.
\n
max_pages (Integer, optional, default: 200)
\n
Maximum number of pages to crawl.
\n
sitemaps_auto (Integer, optional, default: 1)
\n
Whether to automatically detect and use sitemap files.
1 = yes, 0 = no.
\n
sitemaps (String, optional)
\n
A list of sitemap URLs, separated by newline characters (\\n).
\n
include_urls (String, optional)
\n
A list of individual URLs to include in the crawl, separated by newline characters (\\n).
\n
include_traffic (Integer, optional, default: 0)
\n
Whether to include traffic data.
\n
Requires integration with Google Analytics.
\n
include_organic (Integer, optional, default: 0)
\n
Whether to include organic search data.
\n
Requires integration with Google Search Console.
\n
include_seo (Integer, optional, default: 0)
\n
Whether to include SEO tags and structure data.
\n
include_socials (Integer, optional, default: 0)
\n
Whether to analyze social tags (e.g., Open Graph, Twitter Cards).
\n
include_links (Integer, optional, default: 0)
\n
Whether to include internal and external links analysis.
\n
include_authority (Integer, optional, default: 0)
\n
Whether to retrieve domain/page authority metrics.
\n
exclude_noindex (Integer, optional, default: 1)
\n
Whether to exclude pages with noindex meta tag from crawl.
\n
exclude_css (String, optional, default: header,footer)
\n
A comma-separated list of CSS tags or class names to ignore in the crawl.
\n
exclude_urls (String):
The list of the paths that shouldn't be crawled and included in AI database
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the crawler was successfully created and the sync started.
\n

Example

{\n  \"success\": true\n}\n\n

The unique ID of the website to be synced.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"},{"description":{"content":"

Maximum number of pages to crawl.

\n","type":"text/plain"},"key":"max_pages","value":"500"},{"description":{"content":"

Whether to automatically detect and use sitemap files.

\n","type":"text/plain"},"key":"sitemaps_auto","value":"1"},{"description":{"content":"

A list of sitemap URLs, separated by newline characters (\\n).

\n","type":"text/plain"},"key":"sitemaps","value":"https://example.com/sitemap.xml"},{"description":{"content":"

A list of individual URLs to include in the crawl, separated by newline characters (\\n).

\n","type":"text/plain"},"key":"include_urls","value":"https://example.com/path"},{"description":{"content":"

Whether to include traffic data.\n Requires integration with Google Analytics.

\n","type":"text/plain"},"key":"include_traffic","value":"0"},{"description":{"content":"

Whether to include organic search data.\n Requires integration with Google Search Console.

\n","type":"text/plain"},"key":"include_organic","value":"0"},{"description":{"content":"

Whether to include SEO tags and structure data.

\n","type":"text/plain"},"key":"include_seo","value":"1"},{"description":{"content":"

Whether to analyze social tags (e.g., Open Graph, Twitter Cards).

\n","type":"text/plain"},"key":"include_socials","value":"0"},{"description":{"content":"

Whether to include internal and external links analysis.

\n","type":"text/plain"},"key":"include_links","value":"0"},{"description":{"content":"

Whether to retrieve domain/page authority metrics.

\n","type":"text/plain"},"key":"include_authority","value":"0"},{"description":{"content":"

Whether to exclude pages with noindex meta tag from crawl.

\n","type":"text/plain"},"key":"exclude_noindex","value":"1"},{"description":{"content":"

Comma-separated list of CSS tags or class names to ignore in the crawl.

\n","type":"text/plain"},"key":"exclude_css","value":"header,footer"},{"description":{"content":"

The list of the paths that shouldn't be crawled and included in AI database

\n","type":"text/plain"},"key":"exclude_urls","value":null}],"variable":[]}},"response":[],"_postman_id":"cc62ea2f-61be-4fed-a1bb-37a151b8bd65"},{"name":"/api/website/sync","id":"0b2d5533-03b9-42d1-9887-912aeb18ba99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://app.contentlook.ai/api/website/sync?id={{WebsiteID}}","description":"

Description

Starts the website synchronization based on the provided crawler configuration. If no crawler was configured before calling the sync, default crawler settings will be used.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

id (String, required)
\n
The unique ID of the website to be synced.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the sync started.
\n

Example

{\n  \"success\": true\n}\n\n

The unique ID of the website to be synced.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"}],"variable":[]}},"response":[],"_postman_id":"0b2d5533-03b9-42d1-9887-912aeb18ba99"},{"name":"/api/website/clear","id":"845f7293-0928-44ea-b838-7fbaa0995e2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://app.contentlook.ai/api/website/clear?id={{WebsiteID}}&type=webpage","description":"

Description

Deletes a content type for a specific website in your ContentLook account. The content is identified by the exact type provided.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

id (String, required)
\n
The unique ID of the website to be synced.
\n
type (String, required)
\n
Defines the type of content. Accepted values: \"webpage\", \"product\" or \"article\".
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the website was cleared by crawled pages and also the AI database is clear.
\n

Example

{\n  \"success\": true\n}\n\n

The unique ID of the website to be synced.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"},{"description":{"content":"

Defines the type of content. Accepted values: \"webpage\", \"product\" or \"article\".

\n","type":"text/plain"},"key":"type","value":"webpage"}],"variable":[]}},"response":[],"_postman_id":"845f7293-0928-44ea-b838-7fbaa0995e2b"},{"name":"/api/website/synced","id":"3dd620db-0654-44fa-9116-debf4b029f6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.contentlook.ai/api/website/synced?id={{WebsiteID}}&type=article","description":"

Description

Checks the sync status of a website and returns the list of URLs that were successfully crawled. Use this to verify if a sync has been completed and which pages are available for the AI Agent.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

id (String, required)
\n
The unique ID of the website you want to check.
\n
type (String, required)
\n
Defines the type of content. Accepted values: \"webpage\", \"product\" or \"article\".
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the request was processed successfully.
\n
synced (Boolean)
\n
Indicates whether the website has completed its sync process.
\n
urls (Object)
\n
A list of synced URLs as keys. The value for each URL indicates its type (e.g., \"webpage\", \"product\", \"article\").
\n

Example

{\n  \"success\": true,\n  \"synced\": true,\n  \"urls\": {\n    \"https://example.com/\": \"webpage\",\n    \"https://example.com\": \"webpage\"\n  }\n}\n\n

The unique ID of the website you want to check.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"},{"description":{"content":"

Defines the type of content. Accepted values: \"webpage\", \"product\" or \"article\".

\n","type":"text/plain"},"key":"type","value":"article"}],"variable":[]}},"response":[],"_postman_id":"3dd620db-0654-44fa-9116-debf4b029f6c"},{"name":"/api/website/log","id":"b097428d-830a-4602-8c43-6adfad80724b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.contentlook.ai/api/website/log?id={{WebsiteID}}&days=7&type=error","description":"

Description

Retrieve the crawler log for a specific website. This endpoint returns the list of URLs successfully crawled and/or any crawling errors that occurred.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

id (String, required)
\n
The unique ID of the website you want to check.
\n
days (Integer, required)
\n
The number of past days for which to pull the crawling log (e.g., 7).
\n
type (String, optional)
\n
Type of logs to retrieve: INFO for successful crawls, ERROR for failures.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the request was processed successfully.
\n
log (Array)
\n
A list of crawled URLs, including HTTP codes and log type.
\n

Each Log Contains:

type (String)
\n
INFO or ERROR indicating crawl status.
\n
http_code (String)
\n
The HTTP response code received (e.g., 200, 301, 404).
\n
url (String)
The URL that was crawled.
\n
error (String)
The error message if the response type is an error.
\n

Example

{\n  \"success\": true,\n  \"log\": [\n        {\n            \"type\": \"ERROR\",\n            \"http_code\": \"301\",\n            \"url\": \"https://domain.com\",\n            \"message\": \"Redirect to: https://domain.com/\"\n        },\n        {\n            \"type\": \"INFO\",\n            \"http_code\": \"200\",\n            \"url\": \"https://domain.com/\",\n            \"message\": null\n        }\n  ]\n}\n\n

The unique ID of the website you want to check.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"},{"description":{"content":"

The number of past days for which to pull the crawling log (e.g., 7).

\n","type":"text/plain"},"key":"days","value":"7"},{"description":{"content":"

Type of logs to retrieve: INFO for successful crawls, ERROR for failures.

\n","type":"text/plain"},"key":"type","value":"error"}],"variable":[]}},"response":[],"_postman_id":"b097428d-830a-4602-8c43-6adfad80724b"}],"id":"5c7efe1f-3086-4f96-891f-263933bce7bf","_postman_id":"5c7efe1f-3086-4f96-891f-263933bce7bf","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"3f1b801e-21bf-4bd5-be04-75dae108ae24","id":"3f1b801e-21bf-4bd5-be04-75dae108ae24","name":"ContentLook API Overview","type":"collection"}}},{"name":"/api/website/add","id":"611696f9-f920-4415-9b48-847ba76f77cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://app.contentlook.ai/api/website/add?url=https://example.com","description":"

Description

Adds a new website to your ContentLook account. The URL must include the full protocol (http:// or https://).

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

url (String, required)
\n
The full URL of the website to be added, including http:// or https://.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the website was added successfully.
\n
id (String, optional)
\n
Returned only when the website is successfully added.
\n
error (String, optional)
\n
Returned when the request fails. For example, \"domain_exists\" if the domain already exists.
\n

Example

{\n  \"success\": true,\n  \"id\": \"abc123xyz456\"\n}\n\n

Fail Example

{\n  \"success\": false,\n  \"error\": \"domain_exists\"\n}\n\n

The full URL of the website to be added, including http:// or https://

\n","type":"text/plain"},"key":"url","value":"https://example.com"}],"variable":[]}},"response":[],"_postman_id":"611696f9-f920-4415-9b48-847ba76f77cb"},{"name":"/api/website/list","id":"8f10c9eb-6b33-432f-a621-5d4ab9aba4f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.contentlook.ai/api/website/list","description":"

Description

Retrieves the list of websites associated with your ContentLook account. Each website includes a unique ID and its domain, which can be used in other API calls such as adding predefined questions.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the request was successful.
\n
websites (Array of objects)
\n
A list of websites, each containing:
\n
- id (String): Unique website identifier
  \n
- domain (String): The website’s domain
  \n
\n

Example

{\n  \"success\": true,\n  \"websites\": [\n    {\n      \"id\": \"abc123xyz789\",\n      \"domain\": \"https://example1.com\"\n    },\n    {\n      \"id\": \"def456uvw321\",\n      \"domain\": \"https://example2.com\"\n    },\n    {\n      \"id\": \"ghi789rst654\",\n      \"domain\": \"https://example3.com\"\n    }\n  ]\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"3f1b801e-21bf-4bd5-be04-75dae108ae24","id":"3f1b801e-21bf-4bd5-be04-75dae108ae24","name":"ContentLook API Overview","type":"collection"}},"urlObject":{"protocol":"https","path":["api","website","list"],"host":["app","contentlook","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f10c9eb-6b33-432f-a621-5d4ab9aba4f5"},{"name":"/api/website/delete","id":"e00e1e51-d5b3-4351-b3bc-6fc21c180ccb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://app.contentlook.ai/api/website/delete?id={{WebsiteID}}","description":"

Description

Deletes a website from your ContentLook account using its unique ID. This will also remove all agents and data associated with the website.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

id (String, required)
\n
The unique ID of the website to be deleted. You can retrieve this using the /website/list endpoint.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the website was successfully deleted.
\n

Example

{\n  \"success\": true\n}\n\n

The unique ID of the website to be deleted.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"}],"variable":[]}},"response":[],"_postman_id":"e00e1e51-d5b3-4351-b3bc-6fc21c180ccb"}],"id":"69d135bd-4620-4fc8-a5d9-0af3b4a640f3","_postman_id":"69d135bd-4620-4fc8-a5d9-0af3b4a640f3","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"3f1b801e-21bf-4bd5-be04-75dae108ae24","id":"3f1b801e-21bf-4bd5-be04-75dae108ae24","name":"ContentLook API Overview","type":"collection"}}},{"name":"Ai Agents","item":[{"name":"Widget","item":[{"name":"/api/agent/settings","event":[{"listen":"test","script":{"id":"81378d46-4e2d-4fab-921c-58f759d08428","exec":["var template = `","

",""," ","","`;","","function constructVisualizerPayload() {"," var res = pm.response.json();"," "," var visualizerData = {"," \"Button Title\": res.buttonTitle,"," \"Welcome Message\": res.welcomeMessage,"," \"Predefined Questions\": res.predefinedQuestions.length,"," \"Search Placeholder\": res.searchPlaceholder,"," \"Powered By Text\": res.poweredByText,"," \"Powered By Link\": res.poweredByLink,"," \"Button Color\": res.buttonColor,"," \"Button Margin Right\": res.buttonMarginRight,"," \"Button Margin Bottom\": res.buttonMarginBottom,"," \"Link Color\": res.linkColor,"," \"Text Color\": res.textColor"," };",""," return {response: visualizerData};","}","","pm.visualizer.set(template, constructVisualizerPayload());"],"type":"text/javascript","packages":{}}}],"id":"7c3afc83-9fb9-4e05-91f1-5732d95582a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.contentlook.ai/api/agent/settings","description":"

Get Agent Settings

Description

Retrieves the settings for a specific AI agent in the ContentLook platform.

Request Headers:

Agent-Key (String, required):
\n
The agent key available in the AI Agents section of your ContentLook account.
\n

Response:

Status Code: 200 OK
Content-Type: application/json

Response Fields:

buttonTitle (String):
\n
The label shown on the floating AI button.
\n
welcomeMessage (String):
\n
A welcome message displayed above the predefined questions.
\n
predefinedQuestions (Array of Strings):
\n
A list of up to 5 suggested questions that guide the user.
\n
searchPlaceholder (String):
\n
Placeholder text shown in the search input.
\n
poweredByText (String):
\n
The text used for branding or attribution.
\n
poweredByLink (String):
\n
A URL link associated with the powered-by text.
\n

Example:

{\n  \"buttonTitle\": \"Need Help?\",\n  \"welcomeMessage\": \"Hi there! How can I assist you today?\",\n  \"predefinedQuestions\": [\n    \"What are your latest product offers?\",\n    \"Can you show me the pricing plans?\",\n    \"Where can I find more info about your company?\",\n    \"What features do your tools include?\",\n    \"Do you offer a free trial?\"\n  ],\n  \"searchPlaceholder\": \"Ask about our products, features, or pricing...\",\n  \"poweredByText\": \"Powered by ContentLook AI\",\n  \"poweredByLink\": \"https://contentlook.ai\"\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Agent-Key"},{"key":"value","value":"{{AgentKey}}"}]},"isInherited":true,"source":{"_postman_id":"15ef5cef-cf9e-4377-8667-aa35d5a2fdbb","id":"15ef5cef-cf9e-4377-8667-aa35d5a2fdbb","name":"Widget","type":"folder"}},"urlObject":{"protocol":"https","path":["api","agent","settings"],"host":["app","contentlook","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c3afc83-9fb9-4e05-91f1-5732d95582a0"},{"name":"/api/agent/query","id":"6c32df63-3a42-496c-9494-6a03214a5ba8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://app.contentlook.ai/api/agent/query?question=question&session=session","description":"

Description

Sends a user question to the AI Agent and receives a response related to the associated website. The question is passed as a query parameter.

Request Headers:

Agent-Key (String, required):
\n
The agent key available in the AI Agents section of your ContentLook account.
\n

Query Parameters:

question (String, required, max: 1000):
\n
The user's question, written in any language, about the products, services, or content of the website connected to the AI Agent.
\n
session (String, max: 96)
A unique session identifier used to group user questions into the same conversational thread.
\n

Response:

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean):
\n
Indicates whether the query was processed successfully.
\n
May include:
\n
The AI Agent's reply in HTML format.
\n
- h2 for headlines
  \n
- ul/li for lists
  \n
- a tags for links
  \n
\n

Example:

{\n  \"success\": true,\n  \"response\": \"This is the HTML response\",\n}\n\n

The user's question, written in any language, about the products, services, or content of the website connected to the AI Agent.

\n","type":"text/plain"},"key":"question","value":"question"},{"description":{"content":"

A unique session identifier used to group user questions into the same conversational thread.

\n","type":"text/plain"},"key":"session","value":"session"}],"variable":[]}},"response":[],"_postman_id":"6c32df63-3a42-496c-9494-6a03214a5ba8"},{"name":"/api/agent/feedback","id":"9ae07ed0-0d20-4c4f-b6b6-856fa9c60229","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://app.contentlook.ai/api/agent/feedback?session=Session ID&question=User question&feedback={like|dislike}","description":"

Description

Sends a user feedback to a previous question.

Request Headers:

Agent-Key (String, required):
\n
The agent key available in the AI Agents section of your ContentLook account.
\n

Query Parameters:

question (String, required, max: 1000):
\n
The user's question, written in any language, about the products, services, or content of the website connected to the AI Agent.
\n
session (String, max: 96)
A unique session identifier used to group user questions into the same conversational thread.
\n
feedback (String, max:32) The feedback provided by the user, indicating whether they liked or disliked the AI Agent's response.
\n

Response:

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean):
\n
Indicates whether the query was processed successfully.
\n

Example:

{\n  \"success\": true,\n}\n\n

A unique session identifier used to group user questions into the same conversational thread.

\n","type":"text/plain"},"key":"session","value":"Session ID"},{"description":{"content":"

The user's question, written in any language, about the products, services, or content of the website connected to the AI Agent.

\n","type":"text/plain"},"key":"question","value":"User question"},{"description":{"content":"

The feedback received from the user (like|dislike)

\n","type":"text/plain"},"key":"feedback","value":"{like|dislike}"}],"variable":[]}},"response":[],"_postman_id":"9ae07ed0-0d20-4c4f-b6b6-856fa9c60229"}],"id":"15ef5cef-cf9e-4377-8667-aa35d5a2fdbb","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Agent-Key"},{"key":"value","value":"{{AgentKey}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"336c4488-1fef-43fe-843d-82989c825f08","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"9dfe324d-06d9-4514-9639-f95ec3b97b44","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"15ef5cef-cf9e-4377-8667-aa35d5a2fdbb","description":""},{"name":"Questions","item":[{"name":"/api/agent/question/add","id":"4a447467-af46-4525-8ae9-650aeaea9c70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://app.contentlook.ai/api/agent/question/add?id={{WebsiteID}}&question=Predefined Question","description":"

Description

This endpoint is used to add a new predefined question for a specific website. The website ID should be passed as a string in the query parameter. You can retrieve the website ID using the /website/list endpoint.

Request Headers

Api-Key (String, required)
Your API key from the ContentLook account.

Query Parameters

id (String, required)
\n
The ID of the website to which the question will be added.
\n
question (String, required)
\n
The predefined question to be added. Can be in any language.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
Indicates whether the question was successfully added.

Example

{\n  \"success\": true\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","name":"Ai Agents","type":"folder"}},"urlObject":{"protocol":"https","path":["api","agent","question","add"],"host":["app","contentlook","ai"],"query":[{"description":{"content":"

The ID of the website to which the question will be added.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"},{"description":{"content":"

The predefined question to be added. Can be in any language.

\n","type":"text/plain"},"key":"question","value":"Predefined Question"}],"variable":[]}},"response":[],"_postman_id":"4a447467-af46-4525-8ae9-650aeaea9c70"},{"name":"/api/agent/question/list","id":"a208f411-e49f-4418-9600-5ff70f60340e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.contentlook.ai/api/agent/question/list?id={{WebsiteID}}","description":"

Description

Retrieves the list of predefined questions associated with a specific website. The website ID must be passed as a query parameter. You can retrieve the website ID using the /website/list endpoint.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

id (String, required)
\n
The unique ID of the website for which you want to fetch predefined questions.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the request was successful.
\n
questions (Array of strings)
\n
A list of predefined questions added for the specified website.
\n

Example

{\n  \"success\": true,\n  \"questions\": [\n    \"What are your main services?\",\n    \"How can I contact support?\",\n    \"Do you offer any discounts?\",\n    \"What makes your product unique?\"\n  ]\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","name":"Ai Agents","type":"folder"}},"urlObject":{"protocol":"https","path":["api","agent","question","list"],"host":["app","contentlook","ai"],"query":[{"description":{"content":"

The unique ID of the website for which you want to fetch predefined questions.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"}],"variable":[]}},"response":[],"_postman_id":"a208f411-e49f-4418-9600-5ff70f60340e"},{"name":"/api/agent/question/log","id":"8c08b361-bd89-4ce6-8bf6-2f37dfb634cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.contentlook.ai/api/agent/question/log?id={{WebsiteID}}&days=7&type=error","description":"

Description

Retrieve the questions and answers log for a specific website. This endpoint returns a list of successfully answered questions and/or any questions that were not answered.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

id (String, required)
\n
The unique ID of the website you want to check.
\n
days (Integer, required)
\n
The number of past days for which to pull the questions log (e.g., 7).
\n
type (String, optional)
\n
Type of logs to retrieve: INFO for successful answers, ERROR for failures.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the request was processed successfully.
\n
log (Array)
\n
A list of questions, their responses, and their log type.
\n

Each Log Contains:

type (String)
\n
INFO for answered questions, ERROR for unanswered ones.
\n
question (String)
\n
The question asked by the visitor.
\n
response (String)
The AI Agent’s response or fallback message.
\n

Example

{\n  \"success\": true,\n  \"log\": [\n        {\n            \"type\": \"INFO\",\n            \"question\": \"Question\",\n            \"response\": \"Answer\"\n        },\n        {\n            \"type\": \"ERROR\",\n            \"question\": \"Question\",\n            \"response\": \"Fallback Answer\"\n        }\n  ]\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","name":"Ai Agents","type":"folder"}},"urlObject":{"protocol":"https","path":["api","agent","question","log"],"host":["app","contentlook","ai"],"query":[{"description":{"content":"

The unique ID of the website you want to check.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"},{"description":{"content":"

The number of past days for which to pull the questions log (e.g., 7)

\n","type":"text/plain"},"key":"days","value":"7"},{"description":{"content":"

Type of logs to retrieve: INFO for successful answers, ERROR for failures.

\n","type":"text/plain"},"key":"type","value":"error"}],"variable":[]}},"response":[],"_postman_id":"8c08b361-bd89-4ce6-8bf6-2f37dfb634cc"},{"name":"/api/agent/question/delete","id":"7dd0bd89-017b-477a-b363-3f44a008f234","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://app.contentlook.ai/api/agent/question/delete?id={{WebsiteID}}&question=Predefined Question","description":"

Description

Deletes a predefined question for a specific website. The question must exactly match an existing predefined question stored for that website. You can retrieve the website ID using the /website/list endpoint.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

id (String, required)
\n
The unique ID of the website for which the question should be deleted.
\n
question (String, required)
\n
The exact predefined question to delete.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the question was successfully deleted.
\n

Example

jsonCopyEdit{\n  \"success\": true\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","name":"Ai Agents","type":"folder"}},"urlObject":{"protocol":"https","path":["api","agent","question","delete"],"host":["app","contentlook","ai"],"query":[{"description":{"content":"

The unique ID of the website for which you want to fetch predefined questions.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"},{"description":{"content":"

The exact predefined question to delete.

\n","type":"text/plain"},"key":"question","value":"Predefined Question"}],"variable":[]}},"response":[],"_postman_id":"7dd0bd89-017b-477a-b363-3f44a008f234"}],"id":"0be027b3-b874-4894-95f6-63d5b9182367","_postman_id":"0be027b3-b874-4894-95f6-63d5b9182367","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","name":"Ai Agents","type":"folder"}}},{"name":"/api/agent/add","id":"f134a505-6708-4bc3-bb22-30a48215d962","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://app.contentlook.ai/api/agent/add?id={{WebsiteID}}&ai_focus=search&name=Ask AI&formality=auto&button_margin_bottom=30px&button_margin_right=20px&button_text&button_color=%23673ab7&button_icon&link_color=%23673ab7&text_color=%23141d20","description":"

Description

Creates a new AI Agent for a specific website. You must pass the required fields and optionally configure appearance and behavior. The website ID can be retrieved from the /website/list endpoint.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

id (String, required)
\n
The unique ID of the website.
\n
ai_focus (String, required)
\n
Defines the AI focus mode: \"search\" or \"analytics\". For website AI content search, use the \"search\" mode.
\n
name (String, required, max:15)
\n
The display name of the AI Agent.
\n
welcome (String, optional, max:1000)
\n
The welcome message shown above predefined questions.
\n
logo (String, optional,max:255)
\n
The URL of the logo to display in the Ai Agent modal box.
\n
formality (String, optional)
\n
Controls the tone of the AI: \"auto\", \"formal\", or \"informal\".
\n
message (String, optional:max:1000)
\n
Message to show when the agent cannot generate an answer.
\n
button_text (String, optional)
\n
The button text color and the predefined questions text color. Make sure is in contrast with the background color (hexadecimal).
\n
button_color (String, optional)
\n
The button background color and the predefined questions text color (hexadecimal).
\n
button_icon (String, optional)
\n
The URL of the icon to be displayed on the button. The icon should be a PNG file with a transparent background. The optimum size is 40xx40 pixels..
\n
link_color (String, optional)
\n
Link color in the agent responses (hexadecimal).
\n
text_color (String, optional)
\n
General text color inside the AI widget (hexadecimal).
\n
button_margin_bottom (String, optional)
\n
Distance in pixels from the button to the bottom of the screen.
\n
button_margin_right (String, optional)
\n
Distance in pixels from the button to the right edge of the screen.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the AI Agent was created successfully.
\n
key (String)
\n
The unique agent key used to load the widget. To load the widget on a website, use this URL:
https://storage.googleapis.com/contentlook/agent/widget.js?key={key}
\n

Example

{\n  \"success\": true,\n  \"key\": \"a1b2c3d4e5f6g7h8\"\n}\n\n

Fail Example

{\n  \"success\": false,\n  \"message\": \"Validation failed.\",\n  \"errors\": {\n    \"button_color\": [\n      \"The button color field must not be greater than 10 characters.\"\n    ],\n    \"button_margin_bottom\": [\n      \"The button margin bottom field must not be greater than 10 characters.\"\n    ],\n    \"button_margin_right\": [\n      \"The button margin right field must not be greater than 10 characters.\"\n    ]\n  }\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","name":"Ai Agents","type":"folder"}},"urlObject":{"protocol":"https","path":["api","agent","add"],"host":["app","contentlook","ai"],"query":[{"description":{"content":"

The unique ID of the website.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"},{"description":{"content":"

Defines the AI focus mode: \"search\" or \"analytics\". For website AI content search, use the \"search\" mode.

\n","type":"text/plain"},"key":"ai_focus","value":"search"},{"description":{"content":"

The button name of the AI Agent.

\n","type":"text/plain"},"key":"name","value":"Ask AI"},{"disabled":true,"description":{"content":"

The welcome message shown above predefined questions.

\n","type":"text/plain"},"key":"welcome","value":""},{"disabled":true,"description":{"content":"

The URL of the logo to display in the Ai Agent modal box.

\n","type":"text/plain"},"key":"logo","value":""},{"description":{"content":"

Controls the tone of the AI: \"auto\", \"formal\", or \"informal\".

\n","type":"text/plain"},"key":"formality","value":"auto"},{"disabled":true,"description":{"content":"

Message to show when the agent cannot generate an answer.

\n","type":"text/plain"},"key":"message","value":""},{"description":{"content":"

Distance in pixels from the button to the bottom of the screen.

\n","type":"text/plain"},"key":"button_margin_bottom","value":"30px"},{"description":{"content":"

Distance in pixels from the button to the right edge of the screen

\n","type":"text/plain"},"key":"button_margin_right","value":"20px"},{"description":{"content":"

The button text color and the predefined questions text color. Make sure is in contrast with the background color.

\n","type":"text/plain"},"key":"button_text","value":null},{"description":{"content":"

The button background color and the predefined questions text color.

\n","type":"text/plain"},"key":"button_color","value":"%23673ab7"},{"description":{"content":"

The URL of the icon to be displayed on the button. The icon should be a PNG file with a transparent background. The optimum size is 40xx40 pixels.

\n","type":"text/plain"},"key":"button_icon","value":null},{"description":{"content":"

Link color in the agent responses

\n","type":"text/plain"},"key":"link_color","value":"%23673ab7"},{"description":{"content":"

General text color inside the AI widget

\n","type":"text/plain"},"key":"text_color","value":"%23141d20"}],"variable":[]}},"response":[],"_postman_id":"f134a505-6708-4bc3-bb22-30a48215d962"},{"name":"/api/agent/get","id":"ffef030f-3af8-4b98-92e4-f06dcc824cc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.contentlook.ai/api/agent/get?key={{AgentKey}}","description":"

Description

Retrieves the configuration and display settings for a specific AI Agent using its unique key.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

key (String, required)
\n
The unique key of the AI Agent you want to retrieve.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the request was successful.
\n
agent (Object)
\n
Configuration details for the AI Agent:
\n
- ai_focus (String)
  \n
- name (String)
  \n
- welcome (String)
  \n
- logo (String or null)
  \n
- formality (String)
  \n
- message (String)
  \n
- link_color (String or null)
  \n
- text_color (String or null)
  \n
- button_color (String or null)
  \n
- button_margin_bottom (String or null)
  \n
- button_margin_right (String or null)
  \n
- key (String) — Agent Key
  \n
\n

Example

{\n  \"success\": true,\n  \"agent\": {\n    \"ai_focus\": \"search\",\n    \"name\": \"Cif Bot\",\n    \"welcome\": \"Hi there! I’m here to help you find anything you need from this website.\\r\\nJust ask a question, and I’ll search the site to get you the right information.\",\n    \"logo\": null,\n    \"formality\": \"auto\",\n    \"message\": \"Sorry, we couldn&#x27;t find an answer for that. For more information please contact us at <a class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; href=\\\"https://www.example.com/support\\\" target=\\\"_blank\\\">Support</a>\",\n    \"link_color\": null,\n    \"text_color\": null,\n    \"button_color\": null,\n    \"button_margin_bottom\": null,\n    \"button_margin_right\": null,\n    \"key\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n  }\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","name":"Ai Agents","type":"folder"}},"urlObject":{"protocol":"https","path":["api","agent","get"],"host":["app","contentlook","ai"],"query":[{"description":{"content":"

The unique key of the AI Agent you want to retrieve.

\n","type":"text/plain"},"key":"key","value":"{{AgentKey}}"}],"variable":[]}},"response":[],"_postman_id":"ffef030f-3af8-4b98-92e4-f06dcc824cc8"},{"name":"/api/agent/list","id":"28f02ea4-8abc-46c9-85f5-5ed2631d314e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.contentlook.ai/api/agent/list?id={{WebsiteID}}","description":"

Description

Retrieves all AI Agents created for a specific website. Use the website ID from the /website/list endpoint to get associated agents.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

id (String, optional)
\n
The unique ID of the website.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the request was successful.
\n
agents (Array of objects)
\n
A list of AI Agents for the website. Each agent contains:
\n
- domain (String)
  \n
- ai_focus (String)
  \n
- name (String)
  \n
- welcome (String)
  \n
- logo (String or null)
  \n
- formality (String)
  \n
- message (String)
  \n
- link_color (String or null)
  \n
- text_color (String or null)
  \n
- button_color (String or null)
  \n
- button_margin_bottom (String or null)
  \n
- button_margin_right (String or null)
  \n
- key (String)
  \n
\n

Example

{\n  \"success\": true,\n  \"agents\": [\n    {\n      \"domain\": \"https://example.com\",\n      \"ai_focus\": \"search\",\n      \"name\": \"Ask AI\",\n      \"welcome\": \"Hi! I’m here to help you find anything you need from this website.\\r\\nJust ask a question, and I’ll search the site to get you the right information.\",\n      \"logo\": null,\n      \"formality\": \"formal\",\n      \"message\": \"Sorry, we couldn't find an answer for that.\",\n      \"link_color\": null,\n      \"text_color\": null,\n      \"button_color\": null,\n      \"button_margin_bottom\": null,\n      \"button_margin_right\": null,\n      \"key\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    },\n    {\n      \"domain\": \"https://example1.com\",\n      \"ai_focus\": \"analytics\",\n      \"name\": \"Ask Analytics\",\n      \"welcome\": \"Hi there! I’m here to help you find anything you need from this website.\\r\\nJust ask a question, and I’ll search the site to get you the right information.\",\n      \"logo\": null,\n      \"formality\": \"auto\",\n      \"message\": \"Sorry, we couldn't find an answer for that.\",\n      \"link_color\": null,\n      \"text_color\": null,\n      \"button_color\": null,\n      \"button_margin_bottom\": null,\n      \"button_margin_right\": null,\n      \"key\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n    }\n  ]\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","name":"Ai Agents","type":"folder"}},"urlObject":{"protocol":"https","path":["api","agent","list"],"host":["app","contentlook","ai"],"query":[{"description":{"content":"

The ID of the website.

\n","type":"text/plain"},"key":"id","value":"{{WebsiteID}}"}],"variable":[]}},"response":[],"_postman_id":"28f02ea4-8abc-46c9-85f5-5ed2631d314e"},{"name":"/api/agent/delete","id":"769dcf5f-a227-406b-837e-1c36c9e7d7b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://app.contentlook.ai/api/agent/delete?key={{AgentKey}}","description":"

Description

Deletes a specific AI Agent identified by its unique agent key.

Request Headers

Api-Key (String, required)
\n
Your API key from the ContentLook account.
\n

Query Parameters

key (String, required)
\n
The unique key of the AI Agent to be deleted.
\n

Response

Status Code: 200 OK
Content-Type: application/json

Response Fields:

success (Boolean)
\n
Indicates whether the AI Agent was successfully deleted.
\n

Example

jsonCopyEdit{\n  \"success\": true\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","name":"Ai Agents","type":"folder"}},"urlObject":{"protocol":"https","path":["api","agent","delete"],"host":["app","contentlook","ai"],"query":[{"description":{"content":"

The unique key of the AI Agent to be deleted.

\n","type":"text/plain"},"key":"key","value":"{{AgentKey}}"}],"variable":[]}},"response":[],"_postman_id":"769dcf5f-a227-406b-837e-1c36c9e7d7b9"}],"id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"0d1a56c7-ecd3-487f-acc3-2893614752a2","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"bf4d54c2-3a9f-4ea2-a299-73e0eadef4fc","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"2d6d8e60-c97c-483c-b97d-f1d6f6de49c4","description":""}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Api-Key"},{"key":"value","value":"{{ApiKey}}"}]}},"event":[{"listen":"prerequest","script":{"id":"6883fb8a-ab66-4b69-87d5-685b0885c30c","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"7c3c4cab-598f-4d00-b157-9d33823ab4d8","type":"text/javascript","packages":{},"exec":[""]}}]}