資料 API / Perplexity / Sonar Deep Research
Perplexity Sonar Deep Research
Generate a research report using multiple web searches and cited sources. model and messages are required; use model sonar-deep-research for this endpoint. This public contract covers non-streaming JSON responses with stream false. Research can take several minutes and may exceed gateway or client timeouts. Read choices[].message.content, citations and search_results for the report and its sources. usage is not a Felo credit charge.
參數
沒有路徑、查詢或請求標頭參數。
請求主體
modelstring必填允許值: sonar · sonar-pro · sonar-reasoning-pro · sonar-deep-research
The Sonar model to use.
messagesobject[]必填A list of messages comprising the conversation so far.
rolestring必填允許值: system · user · assistant
The role of the message author.
contentstring必填The content of the message.
max_tokensinteger選填The maximum number of tokens to generate in the response.
temperaturenumber選填Sampling temperature between 0 and 2. Lower values make output more focused and deterministic.
top_pnumber選填Nucleus sampling parameter. The model considers tokens with top_p probability mass.
top_kinteger選填The number of tokens to keep for top-k filtering.
streamboolean選填允許值: false
Only non-streaming JSON responses are covered by this public contract. Set false.
search_contextstring選填允許值: low · medium · high
Controls how much search context to use. Affects per-request cost.
frequency_penaltynumber選填Penalizes new tokens based on their existing frequency in the text so far. Positive values decrease the likelihood of repeating the same line verbatim.
presence_penaltynumber選填Penalizes new tokens based on whether they appear in the text so far. Positive values increase the likelihood of talking about new topics.
return_citationsboolean選填Whether to return citations and search results in the response.
search_recency_filterstring選填允許值: month · week · day · hour
Filter search results by recency.
search_domain_filterstring[]選填Limit search to specific domains.
請求範例
curl -X POST "https://openapi.felo.ai/v1/beta/perplexity/sonar-deep-research" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "<string>",
"messages": [
{}
],
"max_tokens": 0,
"temperature": 0,
"top_p": 0,
"top_k": 0,
"stream": false,
"search_context": "<string>"
}'回應
回應範例
{
"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
}
}回應欄位
idstring選填Unique identifier for the completion.
modelstring選填The model used for the completion.
objectstring選填createdinteger選填Unix timestamp of when the completion was created.
choicesobject[]選填indexinteger選填messageobject選填rolestring選填contentstring選填The AI-generated answer, with inline citation references like [1][2].
finish_reasonstring選填允許值: stop · length
citationsstring[]選填List of source URLs referenced in the answer.
search_resultsobject[]選填Detailed search results with titles, snippets, and URLs.
titlestring選填urlstring選填snippetstring選填datestring選填sourcestring選填usageobject選填prompt_tokensinteger選填completion_tokensinteger選填total_tokensinteger選填search_context_sizestring選填