--- title: "Preview a webset" method: POST path: "/v0/websets/preview" tags: ["Websets Preview"] --- # Preview a webset `POST /v0/websets/preview` Preview how a search query will be decomposed before creating a webset. This endpoint performs the same query analysis that happens during webset creation, allowing you to see the detected entity type, generated search criteria, and available enrichment columns in advance. Use this to help users understand how their search will be interpreted before committing to a full webset creation. ## Path parameters - `search` boolean ## Request body - PreviewWebsetParameters - `search` object, required - `query` string, required — Natural language search query describing what you are looking for. Be specific and descriptive about your requirements, characteristics, and any constraints that help narrow down the results. - `entity` union - CompanyEntity - `type` 'company', required - PersonEntity - `type` 'person', required - ArticleEntity - `type` 'article', required - ResearchPaperEntity - `type` 'research_paper', required - CustomEntity - `type` 'custom', required - `description` string, required - `count` number — When query parameter search=true, the number of preview items to return. ## Response `200` Preview of the webset - PreviewWebsetResponse - `search` object, required - `entity` union, required — Detected entity from the query. - CompanyEntity - `type` 'company', required - PersonEntity - `type` 'person', required - ArticleEntity - `type` 'article', required - ResearchPaperEntity - `type` 'research_paper', required - CustomEntity - `type` 'custom', required - `description` string, required - `criteria` object[], required — Detected criteria from the query. - `description` string, required - `enrichments` object[], required — Detected enrichments from the query. - `description` string, required — Description of the enrichment. - `format` 'text' | 'date' | 'number' | 'options' | 'email' | 'phone' | 'url', required — Format of the enrichment. - `options` object[] — When format is options, the options detected from the query. - `label` string, required — Label of the option. - `items` WebsetItemPreview[], required — Preview items matching the search criteria. - `id` string, required — The unique identifier for the preview item - `properties` union, required — The properties of the preview item - WebsetItemPersonProperties - `type` 'person', required - `url` string, uri, required — The URL of the person profile - `description` string, required — Short description of the relevance of the person - `person` object, required - `name` string, required — The name of the person - `location` string, nullable, required — The location of the person - `position` string, nullable, required — The current work position of the person - `company` object, nullable, required - `name` string, required — The name of the company - `location` string, nullable, required — The location the person is working at the company - `pictureUrl` string, uri, nullable, required — The image URL of the person - `workHistory` object[], required — The work history of the person - `title` string, nullable, required — Job title or position - `location` string, nullable, required — Work location - `dates` object, nullable, required — Employment dates - … - `company` object, nullable, required - … - `educationHistory` object[], required — The education history of the person - `degree` string, nullable, required — Degree obtained - `dates` object, nullable, required — Education dates - … - `institution` object, nullable, required - … - WebsetItemCompanyProperties - `type` 'company', required - `url` string, uri, required — The URL of the company website - `description` string, required — Short description of the relevance of the company - `content` string, nullable, required — The text content of the company website - `company` object, required - `name` string, required — The name of the company - `location` string, nullable, required — The main location of the company - `employees` integer, nullable, required — The number of employees of the company - `industry` string, nullable, required — The industry of the company - `about` string, nullable, required — A short description of the company - `logoUrl` string, uri, nullable, required — The logo URL of the company - `foundedYear` number, nullable, required — The year the company was founded - `headquarters` object, nullable, required — The structured headquarters address of the company - `address` string, nullable, required — The street address of the headquarters - `city` string, nullable, required — The city of the headquarters - `state` string, nullable, required — The state or region of the headquarters - `postalCode` string, nullable, required — The postal code of the headquarters - `country` string, nullable, required — The country of the headquarters - `countryCode` string, nullable, required — The ISO country code of the headquarters - `financials` object, nullable, required — Financial information about the company - `revenueAnnual` number, nullable, required — The annual revenue of the company (USD) - `fundingTotal` number, nullable, required — The total funding raised by the company (USD) - `fundingLatestRound` object, nullable, required — The latest funding round - … - `webTraffic` object, nullable, required — Web traffic metrics for the company - `visitsMonthly` number, nullable, required — The estimated monthly website visits - `uniqueVisitors` number, nullable, required — The estimated monthly unique visitors - WebsetItemArticleProperties - `type` 'article', required - `url` string, uri, required — The URL of the article - `description` string, required — Short description of the relevance of the article - `content` string, nullable, required — The text content for the article - `article` object, required - `title` string, nullable, required — The title of the article - `author` string, nullable, required — The author(s) of the article - `publishedAt` string, nullable, required — The date and time the article was published - WebsetItemResearchPaperProperties - `type` 'research_paper', required - `url` string, uri, required — The URL of the research paper - `description` string, required — Short description of the relevance of the research paper - `content` string, nullable, required — The text content of the research paper - `researchPaper` object, required - `title` string, nullable, required — The title of the research paper - `author` string, nullable, required — The author(s) of the research paper - `publishedAt` string, nullable, required — The date and time the research paper was published - WebsetItemCustomProperties - `type` 'custom', required - `url` string, uri, required — The URL of the Item - `description` string, required — Short description of the Item - `content` string, nullable, required — The text content of the Item - `custom` object, required - `title` string, nullable, required — The title of the website - `author` string, nullable, required — The author(s) of the website - `publishedAt` string, nullable, required — The date and time the website was published - `createdAt` string, date-time, required — The date and time the preview was created ## Other responses - `422` — Unable to detect entity or criteria from query --- [API](https://skmtc.net/exa/apis/exa-public-api.md) · [All operations](https://skmtc.net/exa/apis/exa-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/exa/exa-public-api/revisions/5c7114e0ef43/schema)