> ## 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. # Cancel a running search > Cancels a currently running Search. You can cancel all searches at once by using the `websets/:webset/cancel` endpoint. ## OpenAPI ````yaml post /v0/websets/{webset}/searches/{id}/cancel openapi: 3.1.0 info: title: Exa Public API version: 2.0.0 servers: - url: https://api.exa.ai security: - apiKey: [] - bearer: [] tags: [] paths: /v0/websets/{webset}/searches/{id}/cancel: servers: - url: https://api.exa.ai/websets post: tags: - Searches summary: Cancel a running Search description: >- Cancels a currently running Search. You can cancel all searches at once by using the `websets/:webset/cancel` endpoint. operationId: websets-searches-cancel 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 canceled 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: - apiKey: [] - bearer: [] components: schemas: WebsetSearch: properties: id: description: The unique identifier for the search type: string object: const: webset_search default: webset_search type: string status: enum: - created - pending - running - completed - canceled description: The status of the search title: WebsetSearchStatus type: string websetId: description: The unique identifier for the Webset this search belongs to type: string query: minLength: 1 maxLength: 5000 description: The query used to create the search. type: string entity: $ref: '#/components/schemas/Entity' 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. nullable: true criteria: items: properties: description: minLength: 1 maxLength: 1000 description: The description of the criterion type: string successRate: minimum: 0 maximum: 100 description: >- Value between 0 and 100 representing the percentage of results that meet the criterion. type: number required: - description - successRate type: object description: >- The criteria the search will use to evaluate the results. If not provided, we will automatically generate them for you. type: array count: 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. type: number maxPeoplePerCompany: minimum: 1 type: integer 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 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: items: properties: source: enum: - import - webset type: string id: type: string required: - source - id type: object description: >- Sources (existing imports or websets) used to omit certain results to be found during the search. type: array scope: items: properties: source: enum: - import - webset type: string id: type: string relationship: properties: definition: description: >- What the relationship of the entities you hope to find is relative to the entities contained in the provided source. type: string limit: minimum: 1 maximum: 10 type: number required: - definition - limit type: object required: - source - id type: object 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. type: array progress: properties: found: description: The number of results found so far type: number analyzed: description: The number of results analyzed so far type: number completion: minimum: 0 maximum: 100 description: The completion percentage of the search type: number timeLeft: type: number description: The estimated time remaining in seconds, null if unknown nullable: true required: - found - analyzed - completion - timeLeft description: The progress of the search type: object recall: properties: expected: properties: total: description: The estimated total number of potential matches type: number confidence: enum: - high - medium - low description: The confidence in the estimate type: string bounds: properties: min: description: The minimum estimated total number of potential matches type: number max: description: The maximum estimated total number of potential matches type: number required: - min - max type: object required: - total - confidence - bounds type: object reasoning: description: The reasoning for the estimate type: string required: - expected - reasoning type: object description: >- Recall metrics for the search, null if not yet computed or requested. nullable: true metadata: default: {} description: Set of key-value pairs you want to associate with this object. propertyNames: type: string additionalProperties: type: string maxLength: 1000 type: object canceledAt: format: date-time type: string description: The date and time the search was canceled nullable: true canceledReason: $ref: '#/components/schemas/WebsetSearchCanceledReason' description: The reason the search was canceled nullable: true createdAt: format: date-time description: The date and time the search was created type: string updatedAt: format: date-time description: The date and time the search was updated type: string required: - id - object - status - websetId - query - entity - criteria - count - maxPeoplePerCompany - exclude - scope - progress - recall - canceledAt - canceledReason - createdAt - updatedAt type: object Entity: oneOf: - $ref: '#/components/schemas/CompanyEntity' - $ref: '#/components/schemas/PersonEntity' - $ref: '#/components/schemas/ArticleEntity' - $ref: '#/components/schemas/ResearchPaperEntity' - $ref: '#/components/schemas/CustomEntity' WebsetSearchBehavior: enum: - override - append type: string WebsetSearchCanceledReason: enum: - webset_deleted - webset_canceled - out_of_credits type: string CompanyEntity: properties: type: type: string const: company default: company required: - type title: Company type: object PersonEntity: properties: type: type: string const: person default: person required: - type title: Person type: object ArticleEntity: properties: type: type: string const: article default: article required: - type title: Article type: object ResearchPaperEntity: properties: type: type: string const: research_paper default: research_paper required: - type title: Research Paper type: object CustomEntity: properties: description: minLength: 2 maxLength: 200 type: string type: type: string const: custom default: custom required: - type - description title: Custom type: object securitySchemes: apiKey: type: apiKey name: x-api-key in: header description: >- Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer . bearer: type: http scheme: bearer description: >- Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer . ````