​
Welcome

The Find AI Search API allows you to programmatically run searches on Find AI and integrate the results into your application. With the API, you have more control and can access additional data compared to the web interface.

​
Getting Started

To get started with the Find AI API, follow these steps:

  1. Go to the Find AI Dashboard and create a new workspace.
  2. Set up billing for your workspace. Billing is usage-based, and you’ll be charged per match found in your searches.
  3. Issue an API key for your workspace. Make sure to choose the appropriate environment (demo or live mode).

Demo mode is free to set up and try, but it returns dummy data. To access real data, you need to set up billing and use a live mode API key.

​
API Overview

The Find AI API uses REST and provides an OpenAPI specification for easy integration with your application. The API consists of two main endpoints:

  1. Search Creation: Create a new search by providing a query, scope (people or companies), result mode (exact or best), and maximum number of matches.
  2. Search Retrieval: Retrieve the results of a previously created search using the provided token.

The search process is asynchronous. When you create a search, you’ll receive a token that you can use to poll for the search results. Typically, the results are available within a few seconds.

​
Client Libraries

To simplify integration with your application, Find AI provides client libraries in various programming languages. You can find the client libraries on GitHub.

Currently, client libraries are available for:

If you need support for a different programming language, please reach out to us at help@usefind.ai.

Retrieve Search Results