POST
/
ai
/
search
curl --request POST \
  --url https://api.village.do/v1/ai/search \
  --header 'Content-Type: application/json' \
  --header 'secret-key: <api-key>' \
  --header 'user-identifier: <user-identifier>' \
  --data '{
  "query": "Fintech CFOs in London",
  "type": "people",
  "currentFilters": {
    "people": {},
    "companies": {}
  },
  "page": 1,
  "limit": 25
}'
{
  "filtersGenerated": {
    "people": {
      "city": "London",
      "position": "CFO,Chief Financial Officer,Finance Director",
      "companyIndustry": "Financial Services,Fintech",
      "connectionDegree": "Show 1st & 2nd degree"
    }
  },
  "results": {
    "people": {
      "data": [
        {
          "id": "vill_123abc",
          "full_name": "Jane Smith",
          "linkedin_url": "https://linkedin.com/in/jane-smith",
          "location": "London, United Kingdom",
          "warmth_score": 82,
          "relevant_work": {
            "position": "CFO",
            "company": {
              "name": "Fintech Startup Ltd",
              "linkedin_url": "https://linkedin.com/company/fintech-startup"
            }
          }
        }
      ],
      "pagination": {
        "page": 1,
        "pageSize": 25,
        "hasNextPage": true
      }
    }
  }
}

Authorizations

secret-key
string
header
required

Headers

user-identifier
string
required

Specify the user making the request. This identifier should match the one you used when integrating the user with Village.

Body

application/json

Response

200
application/json

Successfully processed AI search query

The response is of type object.