Felo API PlatformFelo API Platform
Apollo のエンドポイント一覧
v0.2.0-beta
OpenAPI 3.1.0

人物情報の一括拡充

サーバー:https://openapi.felo.ai
クライアントライブラリ

Apollo

​

Person and company enrichment, people search, company job postings and news. Requires Felo administrative permission.

人物情報の一括拡充

​

リクエストボディの details 配列に記載された人物を情報拡充します。このエンドポイントに記載された detail フィールドと拡充の制御項目を使用し、このバッチリクエストから単一人物エンドポイントの入力契約を推測しないでください。Felo の管理者権限が必要です。

料金の参考情報

  • 計測方法:レスポンスユニット単位で計測。
  • 参考リクエスト見積もり:USD 1.7775。
  • ユニットコスト基準:USD 0.0。
  • リソースユニット:provider_credit。
  • 参照用の顧客乗数:1.0。確定済みの顧客金額には再適用しないでください。
  • コスト基準は、ゼロの場合も含め、最終的な顧客価格を確定するものではありません。

参考情報のメタデータであり、アカウントへの見積もり、保証された価格、支出上限ではありません。リソースクレジットは Felo クレジットではありません。最終的な請求は Felo の請求記録に従います。

クエリパラメーター
  • reveal_phone_number
    型: boolean
  • run_waterfall_email
    型: boolean
  • run_waterfall_phone
    型: boolean
  • webhook_url
    型: string
    最小長:  
    1
    最大長:  
    2048
    形式: https_url
リクエストボディ
必須
application/json
  • details
    型: array object[]
    必須

    この配列内のオブジェクトとして、情報拡充する各人物の情報を指定します。最大 10 人まで追加できます。

    情報拡充する 1 人分のデータです。手持ちの識別子を指定してください。多いほど一致する可能性が高くなります。

    • domain
      型: string

      人物の雇用主のドメイン(www を含めない)。例:apollo.io

    • email
      型: string

      人物のメールアドレス。

    • first_name
      型: string

      名。last_name と組み合わせて使用します。例:tim

    • hashed_email
      型: string

      メールアドレスの MD5 または SHA-256 ハッシュ。

    • id
      型: string

      Apollo の人物 ID(人物検索から取得したものなど)。

    • last_name
      型: string

      姓。first_name と組み合わせて使用します。例:zheng

    • linkedin_url
      型: string

      人物の LinkedIn プロフィール URL。

    • name
      型: string

      フルネーム(例:「tim zheng」)。first_name + last_name を置き換えます。

    • organization_name
      型: string

      人物の雇用主の名前。例:apollo

レスポンス
  • 200
    型: object

    成功レスポンス

    • credits_consumed
      型: integer

      レスポンスフィールド

    • error_code
      型: string

      レスポンスフィールド

    • error_message
      型: string

      レスポンスフィールド

    • matches
      型: array string[]

      レスポンス配列

    • missing_records
      型: integer

      レスポンスフィールド

    • status
      型: string

      レスポンスフィールド

    • total_requested_enrichments
      型: integer

      レスポンスフィールド

    • unique_enriched_records
      型: integer

      レスポンスフィールド

    • waterfall
      型: object

      レスポンスオブジェクト

    application/json
  • 400

    リクエストを処理できませんでした。リクエストパラメータを確認してください。

  • 401

    有効な Felo API キーが必要です。

  • 402

    請求要件が満たされていないため、リクエストを続行できません。

  • 403

    このアカウントにはこの操作を行う権限がありません。

  • 429

    リクエストまたは支出の上限に達しました。

  • 502

    サービスがリクエストを完了できませんでした。

  • 503

    API または請求サービスが一時的に利用できません。

  • 504

    リクエストの処理中にサービスがタイムアウトしました。

  • default

    エラーレスポンス。上流のパススルーレスポンスはプロバイダーの形式を使用する場合があります

    application/json
Request Example for post/v1/beta/apollo/people/bulk_match
curl https://openapi.felo.ai/v1/beta/apollo/people/bulk_match \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "details": [
    {
      "first_name": "",
      "last_name": "",
      "name": "",
      "email": "",
      "hashed_email": "",
      "organization_name": "",
      "domain": "",
      "id": "",
      "linkedin_url": ""
    }
  ]
}'
{
  "status": "string",
  "error_code": "string",
  "error_message": "string",
  "total_requested_enrichments": 1,
  "unique_enriched_records": 1,
  "missing_records": 1,
  "credits_consumed": 1,
  "matches": [
    "string"
  ],
  "waterfall": {}
}
Bulk People Enrichment

ヘルプが必要ですか?

  • API・請求・アカウントのご質問はサポートへ。
  • Discord で Felo の開発者と交流できます。
  • 更新履歴 をご覧ください。
  • ボリューム価格や購買についてのご相談は営業窓口へ。
  • LLM での構築をお考えですか?llms.txt をご覧ください。