v0.2.0-beta

OpenAPI 3.1.0

Perplexity Sonar Deep Research

Felo API Support

MIT

Сервер

https://openapi.felo.ai

Клієнтські бібліотеки

Shell Curl

Perplexity API

Generate answers and research reports with web citations.

Perplexity API Операції

post/v1/beta/perplexity/sonar-deep-research

Perplexity Sonar Deep Research

Створює дослідницький звіт із використанням кількох вебпошуків і цитованих джерел. model і messages обов'язкові; для цього ендпоінта використовуйте model sonar-deep-research. Цей публічний контракт охоплює нестрімінгові JSON-відповіді зі stream false. Дослідження може тривати кілька хвилин і перевищити тайм-аути шлюзу або клієнта. Читайте звіт і його джерела в choices[].message.content, citations і search_results. usage — не списання кредитів Felo.

Довідкові ціни

Тарифікація: вартість відповіді за даними постачальника.
Довідкова оцінка запиту: USD 0.23932.
Довідковий множник для клієнта: 1.0. Не застосовуйте його повторно до вже розрахованої суми клієнта.

Довідкові метадані, а не котирування для облікового запису, гарантована ціна чи ліміт витрат. Кредити ресурсів — це не кредити Felo. Остаточні списання здійснюються за записами білінгу Felo.

Тіло

обов'язкове

application/json

messages
Тип: array object[]
обов'язкове

Список повідомлень, що складають поточний діалог.
- content
  Тип: string
  обов'язкове
  
  Вміст повідомлення.
- role
  Тип: string перелік
  обов'язкове
  
  Роль автора повідомлення.
  
  значення
  system
  user
  assistant
model
Тип: string перелік
обов'язкове

Модель Sonar для використання.
значення
- sonar
- sonar-pro
- sonar-reasoning-pro
- sonar-deep-research
frequency_penalty
Тип: number
мін.:
0
макс.:
2

Штрафує нові токени на основі їхньої поточної частоти в тексті. Додатні значення знижують імовірність дослівного повторення того самого рядка.
max_tokens
Тип: integer

Максимальна кількість токенів для генерації у відповіді.
presence_penalty
Тип: number
мін.:
-2
макс.:
2

Штрафує нові токени залежно від того, чи траплялися вони в тексті. Додатні значення підвищують імовірність обговорення нових тем.
return_citations
Тип: boolean

Чи повертати цитати й результати пошуку у відповіді.
search_context
Тип: string перелік

Керує обсягом використовуваного пошукового контексту. Впливає на вартість запиту.
значення
- low
- medium
- high
search_domain_filter
Тип: array string[]

Обмежити пошук певними доменами.
search_recency_filter
Тип: string перелік

Фільтрувати результати пошуку за давністю.
значення
- month
- week
- day
- hour
stream
Тип: boolean

Чи стрімити відповідь за допомогою server-sent events.
temperature
Тип: number
мін.:
0
макс.:
2

Температура семплування від 0 до 2. Менші значення роблять вивід більш сфокусованим і детермінованим.
top_k
Тип: integer
мін.:
0
макс.:
2048

Кількість токенів, що зберігаються для top-k фільтрації.

top_p
Тип: number
мін.:
0
макс.:
1

Параметр нуклеусного семплування. Модель враховує токени з імовірнісною масою top_p.

Відповіді

200
Тип: object · ResponseD5E2470Dd28B_ChatCompletionResponse

Успішна відповідь із ШІ-відповіддю та цитуванням
choices
Тип: array object[]
finish_reason
Тип: string перелік
значення
stop
length
index
Тип: integer

Integer numbers.

message
Тип: object
content
Тип: string

Відповідь, згенерована ШІ, із вбудованими посиланнями на цитати виду [1][2].

role
Тип: string
citations
Тип: array string[]

Список URL джерел, на які посилаються у відповіді.

created
Тип: integer

Позначка часу Unix моменту створення відповіді.

id
Тип: string

Унікальний ідентифікатор відповіді.

model
Тип: string

Модель, використана для відповіді.

object
Тип: string
search_results
Тип: array object[]

Докладні результати пошуку із заголовками, фрагментами та URL.

date
Тип: string
snippet
Тип: string
source
Тип: string
title
Тип: string
url
Тип: string
usage
Тип: object
completion_tokens
Тип: integer

Integer numbers.

prompt_tokens
Тип: integer

Integer numbers.

search_context_size
Тип: string
total_tokens
Тип: integer

Integer numbers.
application/json
400

Не вдалося обробити запит. Перевірте параметри запиту.
401

Потрібен дійсний API-ключ Felo.
402

Запит неможливо виконати: умови білінгу не виконано.
403

Обліковий запис не має дозволу на цю операцію.
429

Досягнуто ліміту запитів або витрат.
502

Служба не змогла виконати запит.
503

API або служба білінгу тимчасово недоступні.
504

Час очікування обробки запиту вичерпано.
default

Відповідь із помилкою; наскрізні відповіді апстріму можуть використовувати формати постачальника

application/json

post/v1/beta/perplexity/sonar-deep-research

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
  }
}

Успішна відповідь із ШІ-відповіддю та цитуванням

Perplexity Sonar Deep Research

АвтентифікаціяRequired

Perplexity API

Perplexity Sonar Deep Research

Довідкові ціни