v0.2.0-beta

OpenAPI 3.1.0

Perplexity Sonar Deep Research

Felo API Support

MIT

Server

https://openapi.felo.ai

Klientské knihovny

Shell Curl

Perplexity API

Generate answers and research reports with web citations.

Perplexity API Operace

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

Perplexity Sonar Deep Research

Vygeneruje výzkumnou zprávu s využitím více webových vyhledávání a citovaných zdrojů. model a messages jsou povinné; pro tento endpoint použijte model sonar-deep-research. Tento veřejný kontrakt pokrývá nestreamované odpovědi JSON s hodnotou stream false. Výzkum může trvat několik minut a překročit časové limity brány nebo klienta. Zprávu a její zdroje čtěte z choices[].message.content, citations a search_results. usage není poplatek za kredity Felo.

Cenová reference

Měření: vykázané náklady odpovědi.
Referenční odhad požadavku: USD 0.23932.
Referenční multiplikátor zákazníka: 1.0. Znovu jej neaplikujte na již zúčtovanou částku zákazníka.

Pouze referenční metadata, nikoli nabídka pro účet, garantovaná cena či limit utrácení. Kredity prostředků nejsou kredity Felo. Konečné účtování se řídí fakturačními záznamy Felo.

Tělo

povinné

application/json

messages
Typ: array object[]
povinné

Seznam zpráv tvořících dosavadní konverzaci.
- content
  Typ: string
  povinné
  
  Obsah zprávy.
- role
  Typ: string enum
  povinné
  
  Role autora zprávy.
  
  hodnoty
  system
  user
  assistant
model
Typ: string enum
povinné

Model Sonar, který se má použít.
hodnoty
- sonar
- sonar-pro
- sonar-reasoning-pro
- sonar-deep-research
frequency_penalty
Typ: number
min:
0
max:
2

Penalizuje nové tokeny na základě jejich dosavadní frekvence v textu. Kladné hodnoty snižují pravděpodobnost doslovného opakování stejného řádku.
max_tokens
Typ: integer

Maximální počet tokenů, které se mají v odpovědi vygenerovat.
presence_penalty
Typ: number
min:
-2
max:
2

Penalizuje nové tokeny na základě toho, zda se v textu již vyskytují. Kladné hodnoty zvyšují pravděpodobnost hovoru o nových tématech.
return_citations
Typ: boolean

Určuje, zda se v odpovědi mají vracet citace a výsledky vyhledávání.
search_context
Typ: string enum

Řídí, kolik kontextu vyhledávání se má použít. Ovlivňuje náklady na požadavek.
hodnoty
- low
- medium
- high
search_domain_filter
Typ: array string[]

Omezit vyhledávání na konkrétní domény.
search_recency_filter
Typ: string enum

Filtrujte výsledky vyhledávání podle aktuálnosti.
hodnoty
- month
- week
- day
- hour
stream
Typ: boolean

Určuje, zda se má odpověď streamovat pomocí událostí odesílaných serverem.
temperature
Typ: number
min:
0
max:
2

Teplota vzorkování mezi 0 a 2. Nižší hodnoty činí výstup soustředěnější a determinističtější.
top_k
Typ: integer
min:
0
max:
2048

Počet tokenů ponechaných pro filtrování top-k.

top_p
Typ: number
min:
0
max:
1

Parametr jádrového vzorkování. Model zohledňuje tokeny s hmotností pravděpodobnosti top_p.

Odpovědi

200
Typ: object · ResponseD5E2470Dd28B_ChatCompletionResponse

Úspěšná odpověď s AI odpovědí a citacemi
choices
Typ: array object[]
finish_reason
Typ: string enum
hodnoty
stop
length
index
Typ: integer

Integer numbers.

message
Typ: object
content
Typ: string

Odpověď vygenerovaná AI s vloženými odkazy na citace, např. [1][2].

role
Typ: string
citations
Typ: array string[]

Seznam zdrojových URL odkazovaných v odpovědi.

created
Typ: integer

Unixové časové razítko vytvoření dokončení.

id
Typ: string

Jedinečný identifikátor dokončení.

model
Typ: string

Model použitý pro dokončení.

object
Typ: string
search_results
Typ: array object[]

Podrobné výsledky vyhledávání s názvy, úryvky a URL.

date
Typ: string
snippet
Typ: string
source
Typ: string
title
Typ: string
url
Typ: string
usage
Typ: object
completion_tokens
Typ: integer

Integer numbers.

prompt_tokens
Typ: integer

Integer numbers.

search_context_size
Typ: string
total_tokens
Typ: integer

Integer numbers.
application/json
400

Požadavek se nepodařilo zpracovat. Zkontrolujte parametry požadavku.
401

Je vyžadován platný API klíč Felo.
402

V požadavku nelze pokračovat, protože není splněn požadavek na fakturaci.
403

Účet nemá oprávnění tuto operaci provést.
429

Byl dosažen limit požadavků nebo útraty.
502

Služba nemohla požadavek dokončit.
503

API nebo fakturační služba je dočasně nedostupná.
504

Při zpracování požadavku vypršel časový limit služby.
default

Chybová odpověď; odpovědi předávané přímo od upstream poskytovatele mohou používat formáty poskytovatele

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

Zobrazit schéma

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

Úspěšná odpověď s AI odpovědí a citacemi

Perplexity Sonar Deep Research

OvěřováníRequired

Perplexity API

Perplexity Sonar Deep Research

Cenová reference