Felo API PlatformFelo API Platform

Data 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Необязательный