> ## Documentation Index > Fetch the complete documentation index at: https://exa.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get a Search > Gets a Search by id ## OpenAPI ````yaml get /v0/websets/{webset}/searches/{id} openapi: 3.1.0 info: title: Websets description: '' version: '0' contact: {} servers: - url: https://api.exa.ai/websets/ description: Production security: [] tags: [] paths: /v0/websets/{webset}/searches/{id}: get: tags: - Searches summary: Get a Search description: Gets a Search by id operationId: websets-searches-get parameters: - name: webset required: true in: path description: The id of the Webset schema: type: string - name: id required: true in: path description: The id of the Search schema: type: string responses: '200': description: Search retrieved content: application/json: schema: $ref: '#/components/schemas/WebsetSearch' headers: X-Request-Id: schema: type: string description: Unique identifier for the request. example: req_N6SsgoiaOQOPqsYKKiw5 required: true security: - api_key: [] x-codeSamples: - lang: javascript label: JavaScript source: >- // npm install exa-js import Exa from 'exa-js'; const exa = new Exa('YOUR_EXA_API_KEY'); const search = await exa.websets.searches.get('webset_id', 'search_id'); console.log(`Search: ${search.id} - ${search.status}`); - lang: python label: Python source: |- # pip install exa-py from exa_py import Exa exa = Exa('YOUR_EXA_API_KEY') search = exa.websets.searches.get('webset_id', 'search_id') print(f'Search: {search.id} - {search.status}') components: schemas: WebsetSearch: type: - object properties: id: type: - string description: The unique identifier for the search object: type: string const: webset_search default: webset_search status: type: - string enum: - created - pending - running - completed - canceled description: The status of the search title: WebsetSearchStatus websetId: type: - string description: The unique identifier for the Webset this search belongs to query: description: The query used to create the search. type: - string minLength: 1 maxLength: 5000 entity: oneOf: - $ref: '#/components/schemas/Entity' - type: 'null' description: >- The entity the search will return results for. When no entity is provided during creation, we will automatically select the best entity based on the query. criteria: type: - array items: type: - object properties: description: type: - string minLength: 1 maxLength: 1000 description: The description of the criterion successRate: type: - number minimum: 0 maximum: 100 description: >- Value between 0 and 100 representing the percentage of results that meet the criterion. required: - description - successRate description: >- The criteria the search will use to evaluate the results. If not provided, we will automatically generate them for you. count: type: - number minimum: 1 description: >- The number of results the search will attempt to find. The actual number of results may be less than this number depending on the search complexity. maxPeoplePerCompany: type: integer minimum: 1 description: >- The soft cap requested for matching people from the same current employer company, or null when no cap was requested. nullable: true behavior: $ref: '#/components/schemas/WebsetSearchBehavior' default: override type: - string description: >- The behavior of the search when it is added to a Webset. - `override`: the search will replace the existing Items found in the Webset and evaluate them against the new criteria. Any Items that don't match the new criteria will be discarded. - `append`: the search will add the new Items found to the existing Webset. Any Items that don't match the new criteria will be discarded. exclude: type: - array items: type: - object properties: source: type: - string enum: - import - webset id: type: - string required: - source - id description: >- Sources (existing imports or websets) used to omit certain results to be found during the search. scope: type: - array items: type: - object properties: source: type: - string enum: - import - webset id: type: - string relationship: type: - object properties: definition: type: - string description: >- What the relationship of the entities you hope to find is relative to the entities contained in the provided source. limit: type: - number minimum: 1 maximum: 10 required: - definition - limit required: - source - id description: >- The scope of the search. By default, there is no scope - thus searching the web. If provided during creation, the search will only be performed on the sources provided. progress: type: - object properties: found: type: - number description: The number of results found so far analyzed: type: - number description: The number of results analyzed so far completion: type: - number minimum: 0 maximum: 100 description: The completion percentage of the search timeLeft: type: - number - 'null' description: The estimated time remaining in seconds, null if unknown required: - found - analyzed - completion - timeLeft description: The progress of the search recall: type: - object - 'null' properties: expected: type: - object properties: total: type: - number description: The estimated total number of potential matches confidence: type: - string enum: - high - medium - low description: The confidence in the estimate bounds: type: - object properties: min: type: - number description: The minimum estimated total number of potential matches max: type: - number description: The maximum estimated total number of potential matches required: - min - max required: - total - confidence - bounds reasoning: type: - string description: The reasoning for the estimate required: - expected - reasoning description: >- Recall metrics for the search, null if not yet computed or requested. metadata: default: {} description: Set of key-value pairs you want to associate with this object. type: - object additionalProperties: type: - string maxLength: 1000 canceledAt: type: - string - 'null' format: date-time description: The date and time the search was canceled canceledReason: oneOf: - $ref: '#/components/schemas/WebsetSearchCanceledReason' - type: 'null' description: The reason the search was canceled createdAt: type: - string format: date-time description: The date and time the search was created updatedAt: type: - string format: date-time description: The date and time the search was updated required: - id - object - websetId - status - query - entity - criteria - count - maxPeoplePerCompany - exclude - scope - progress - recall - canceledAt - canceledReason - createdAt - updatedAt Entity: oneOf: - $ref: '#/components/schemas/CompanyEntity' type: - object - $ref: '#/components/schemas/PersonEntity' type: - object - $ref: '#/components/schemas/ArticleEntity' type: - object - $ref: '#/components/schemas/ResearchPaperEntity' type: - object - $ref: '#/components/schemas/CustomEntity' type: - object WebsetSearchBehavior: type: string enum: - override - append WebsetSearchCanceledReason: type: string enum: - webset_deleted - webset_canceled CompanyEntity: type: - object properties: type: type: string const: company default: company required: - type title: Company PersonEntity: type: - object properties: type: type: string const: person default: person required: - type title: Person ArticleEntity: type: - object properties: type: type: string const: article default: article required: - type title: Article ResearchPaperEntity: type: - object properties: type: type: string const: research_paper default: research_paper required: - type title: Research Paper CustomEntity: type: - object properties: type: type: string const: custom default: custom description: type: - string minLength: 2 maxLength: 200 required: - type - description title: Custom securitySchemes: api_key: type: apiKey in: header name: x-api-key description: Your Exa API key ````