跳转到主要内容
POST
People Search with Elasticsearch

请求规范

  • 方法与路径: POST /apis/v1/people-data-labs/people-search-elastic
  • 可用状态: enabled
  • 请求 URL 模板: https://api.aisa.one/apis/v1/people-data-labs/people-search-elastic
  • Runtime 事实版本: d9aafd76ae02b9bcd98e168c52eb69aba6e12890a1eed8da421910f394e8200a
完整 OpenAPI 定义 有效请求与价格声明(包括认证和引用的 schema):

费用与请求规则

按用量计费;默认请求预估费用:$0.2803 USD(不是固定价格)。 声明的单位费率:每 provider_credit $0.000001 USD。 最终费用以账户适用价格及实际结算为准。 公开参考值不是你的账户报价或最终扣费。对于支持 X-AISA-Cost-Mode: quote 的接口,执行前请针对完整请求获取免费报价;执行后通过响应费用元数据和 Usage Logs 核对结算费用。1 USD 等于 1,000,000 个整数 micro-USD。
  • 默认请求参考估价(USD): 0.2803
  • 声明的单位费率(USD): 1e-06
  • 计费单位: provider_credit
  • 计费依据: response_units
  • 公开参考倍率: 1.0
  • 声明的最大计数或单位数: 10000000
  • 结算证据来源: response_body

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json
size
integer
必填

The number of matched person records to return. Must be an integer between 1 and 100, inclusive.

必填范围: 1 <= x <= 100
query
string
必填

Elasticsearch DSL query string (JSON object) for searching PDL person profiles. Provide just the DSL body (e.g., '{"bool": {...}}') without an outer 'query' wrapper.

Supported query types: term, terms, match, match_phrase, prefix, wildcard, range, exists, bool (must/should/filter/must_not).

ALL field names MUST use snake_case, NOT camelCase.

Valid queryable fields include:

  • Name: full_name, first_name, last_name, middle_name
  • Job: job_title, job_title_role, job_title_class, job_company_name, job_company_industry, job_company_size, job_company_website, job_company_location_*
  • Location (NOT 'location' alone): location_country, location_region, location_locality, location_metro, location_geo
  • Social: linkedin_url, linkedin_username, linkedin_id, facebook_url, facebook_username, twitter_url, twitter_username, github_url, github_username
  • Nested profiles: profiles.network, profiles.url, profiles.username, profiles.id
  • Other: industry, skills, interests, countries, sex, work_email, personal_emails

NOT queryable as fields (use 'dataset' parameter instead): email, phone. 'experience_level' is not valid — use 'job_title_levels'. 'job_company_domain' is not valid — use 'job_company_website'. 'minimum_should_match' is not supported by PDL's API.

Full field reference: https://docs.peopledatalabs.com/docs/fields-person

示例:

"{\"bool\": {\"must\": [{\"term\": {\"job_company_industry\": \"computer software\"}}]}}"

"{\"bool\": {\"must\": [{\"term\": {\"job_title_role\": \"engineer\"}}, {\"term\": {\"location_country\": \"united states\"}}]}}"

"{\"bool\": {\"should\": [{\"match\": {\"full_name\": \"john\"}}, {\"match\": {\"first_name\": \"john\"}}]}}"

dataset
enum<string>
必填

Specifies the dataset category to search against, filtering results to profiles that have the specified type of data available. Allowed values are: 'resume', 'email', 'phone', 'mobile_phone', 'street_address', 'consumer_social', 'developer', 'all'. Note: Use 'email' here to filter for profiles with email addresses available, rather than querying 'email' as a field in the query parameter.

可用选项:
resume
pretty
boolean
默认值:false

If true, formats the JSON response with human-readable indentation. Defaults to false.

示例:

true

false

titlecase
boolean
默认值:false

If true, titlecases the person records in the response. Defaults to false.

示例:

true

false

scroll_token
string
默认值:""

A token returned in a previous search response. Provide this token to retrieve the next page of results. Omit or pass an empty string for the first request.

示例:

""

"627445704a7f000001000000"

响应

Tool result data

query
string
必填
total
integer
必填
records
object[]
必填
scroll_token
string
必填
composio_execution_message
string