Perplexity API
Generate answers and research reports with web citations.
Perplexity Sonar Deep Research
複数のウェブ検索と引用元を使って調査レポートを生成します。model と messages は必須で、このエンドポイントではモデル sonar-deep-research を使用します。この公開契約は stream が false の非ストリーミング JSON レスポンスを対象とします。調査には数分かかることがあり、ゲートウェイやクライアントのタイムアウトを超える可能性があります。レポートとその出典は choices[].message.content、citations、search_results から読み取ります。usage は Felo クレジットの請求ではありません。
料金の参考情報
- 計測方法:報告されたレスポンスコスト。
- 参考リクエスト見積もり:USD 0.23932。
- 参照用の顧客乗数:1.0。確定済みの顧客金額には再適用しないでください。
参考情報のメタデータであり、アカウントへの見積もり、保証された価格、支出上限ではありません。リソースクレジットは Felo クレジットではありません。最終的な請求は Felo の請求記録に従います。
- 型: array object[]messages必須
これまでの会話を構成するメッセージのリスト。
- content型: string必須
メッセージの内容。
- role型: string 列挙値必須
メッセージ作成者のロール。
値- system
- user
- assistant
- 型: string 列挙値model必須
使用する Sonar モデル。
値- sonar
- sonar
-pro - sonar
-reasoning -pro - sonar
-deep -research
- 型: numberfrequency
_penalty 最小値:0最大値:2これまでのテキストにおける出現頻度に基づいて新しいトークンにペナルティを課します。正の値は、同じ行をそのまま繰り返す可能性を下げます。
- 型: integermax
_tokens レスポンスで生成するトークンの最大数。
- 型: numberpresence
_penalty 最小値:-2最大値:2これまでのテキストに出現しているかどうかに基づいて新しいトークンにペナルティを課します。正の値は、新しい話題について話す可能性を高めます。
- 型: booleanreturn
_citations レスポンスに引用と検索結果を含めるかどうか。
- 型: string 列挙値search
_context 使用する検索コンテキストの量を制御します。リクエストあたりのコストに影響します。
値- low
- medium
- high
- 型: array string[]search
_domain _filter 検索を特定のドメインに限定します。
- 型: string 列挙値search
_recency _filter 鮮度で検索結果をフィルターします。
値- month
- week
- day
- hour
- 型: booleanstream
サーバー送信イベントを使ってレスポンスをストリーミングするかどうか。
- 型: numbertemperature最小値:0最大値:2
0 から 2 の間のサンプリング温度。値が低いほど、出力はより焦点が絞られ決定論的になります。
- 型: integertop
_k 最小値:0最大値:2048top-k フィルタリングで保持するトークン数。
- 型: numbertop
_p 最小値:0最大値:1核サンプリングのパラメータ。モデルは top_p の確率質量に達するトークンのみを考慮します。
- 型: object · ResponseD5E2470Dd28B_ChatCompletionResponse200
AI 回答と引用を含む成功レスポンス
- 型: array object[]choices
- finish型: string 列挙値
_reason 値- stop
- length
- index型: integer
Integer numbers.
- message型: object
- content型: string
[1][2] のようなインライン引用参照を含む、AI が生成した回答。
- role型: string
- 型: array string[]citations
回答で参照されるソース URL のリスト。
- 型: integercreated
コンプリーションが作成されたときの Unix タイムスタンプ。
- 型: stringid
コンプリーションの一意の識別子。
- 型: stringmodel
コンプリーションに使用されたモデル。
- 型: stringobject
- 型: array object[]search
_results タイトル、スニペット、URL を含む詳細な検索結果。
- date型: string
- snippet型: string
- source型: string
- title型: string
- url型: string
- 型: objectusage
- completion型: integer
_tokens Integer numbers.
- prompt型: integer
_tokens Integer numbers.
- search型: string
_context _size - total型: integer
_tokens Integer numbers.
application/json - 400
リクエストを処理できませんでした。リクエストパラメータを確認してください。
- 401
有効な Felo API キーが必要です。
- 402
請求要件が満たされていないため、リクエストを続行できません。
- 403
このアカウントにはこの操作を行う権限がありません。
- 429
リクエストまたは支出の上限に達しました。
- 502
サービスがリクエストを完了できませんでした。
- 503
API または請求サービスが一時的に利用できません。
- 504
リクエストの処理中にサービスがタイムアウトしました。
- default
エラーレスポンス。上流のパススルーレスポンスはプロバイダーの形式を使用する場合があります
application/json
curl --request POST https://openapi.felo.ai/v1/beta/perplexity/sonar-deep-research \
--header "Authorization: Bearer ${FELO_API_KEY:?Set FELO_API_KEY}" \
--header 'Content-Type: application/json' \
--data '{"model": "sonar-deep-research", "messages": [{"role": "user", "content": "Research HTTP caching strategies for public APIs, with references to standards."}], "max_tokens": 4096, "stream": false}'
{
"id": "example-sonar-deep-research-completion",
"model": "sonar-deep-research",
"object": "chat.completion",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "Public API caching combines freshness controls and conditional requests. [1][2]"
},
"finish_reason": "stop"
}
],
"citations": [
"https://www.rfc-editor.org/rfc/rfc9111.html",
"https://www.rfc-editor.org/rfc/rfc9110.html"
],
"search_results": [
{
"title": "HTTP Caching",
"url": "https://www.rfc-editor.org/rfc/rfc9111.html"
},
{
"title": "HTTP Semantics",
"url": "https://www.rfc-editor.org/rfc/rfc9110.html"
}
],
"usage": {
"prompt_tokens": 40,
"completion_tokens": 80,
"total_tokens": 120
}
}