v0.2.0-beta

OpenAPI 3.1.0

Perplexity Sonar Deep Research

Felo API Support

MIT

Server

https://openapi.felo.ai

Clientbibliotheken

Shell Curl

Perplexity API

Generate answers and research reports with web citations.

Perplexity API Operaties

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

Perplexity Sonar Deep Research

Genereert een onderzoeksrapport met meerdere webzoekopdrachten en geciteerde bronnen. model en messages zijn vereist; gebruik voor dit endpoint het model sonar-deep-research. Dit openbare contract dekt niet-gestreamde JSON-responses met stream false. Onderzoek kan meerdere minuten duren en gateway- of clienttime-outs overschrijden. Lees choices[].message.content, citations en search_results voor het rapport en de bijbehorende bronnen. usage is geen afboeking van Felo-tegoed.

Prijsreferentie

Metering: Gerapporteerde responskosten.
Referentieschatting per verzoek: USD 0.23932.
Referentieklantvermenigvuldiger: 1.0. Pas deze niet opnieuw toe op een afgerekend klantbedrag.

Alleen referentiemetadata, geen accountofferte, geen gegarandeerde prijs en geen bestedingslimiet. Resourcecredits zijn geen Felo-tegoed. De uiteindelijke kosten volgen de factureringsgegevens van Felo.

Body

verplicht

application/json

messages
Type: array object[]
verplicht

Een lijst met berichten waaruit het gesprek tot nu toe bestaat.
- content
  Type: string
  verplicht
  
  De inhoud van het bericht.
- role
  Type: string enum
  verplicht
  
  De rol van de auteur van het bericht.
  
  waarden
  system
  user
  assistant
model
Type: string enum
verplicht

Het te gebruiken Sonar-model.
waarden
- sonar
- sonar-pro
- sonar-reasoning-pro
- sonar-deep-research
frequency_penalty
Type: number
min.:
0
max.:
2

Bestraft nieuwe tokens op basis van hun bestaande frequentie in de tekst tot nu toe. Positieve waarden verkleinen de kans dat dezelfde regel letterlijk wordt herhaald.
max_tokens
Type: integer

Het maximale aantal tokens dat in de respons wordt gegenereerd.
presence_penalty
Type: number
min.:
-2
max.:
2

Bestraft nieuwe tokens op basis van of ze al in de tekst voorkomen. Positieve waarden vergroten de kans dat er over nieuwe onderwerpen wordt gesproken.
return_citations
Type: boolean

Of citaties en zoekresultaten in de respons worden geretourneerd.
search_context
Type: string enum

Bepaalt hoeveel zoekcontext wordt gebruikt. Beïnvloedt de kosten per verzoek.
waarden
- low
- medium
- high
search_domain_filter
Type: array string[]

De zoekopdracht beperken tot specifieke domeinen.
search_recency_filter
Type: string enum

Zoekresultaten filteren op recentheid.
waarden
- month
- week
- day
- hour
stream
Type: boolean

Of de respons via server-sent events wordt gestreamd.
temperature
Type: number
min.:
0
max.:
2

Samplingtemperatuur tussen 0 en 2. Lagere waarden maken de uitvoer gerichter en deterministischer.
top_k
Type: integer
min.:
0
max.:
2048

Het aantal tokens dat voor top-k-filtering wordt behouden.

top_p
Type: number
min.:
0
max.:
1

Parameter voor nucleus-sampling. Het model beschouwt tokens met een top_p-waarschijnlijkheidsmassa.

Responsen

200
Type: object · ResponseD5E2470Dd28B_ChatCompletionResponse

Succesvolle respons met AI-antwoord en bronvermeldingen
choices
Type: array object[]
finish_reason
Type: string enum
waarden
stop
length
index
Type: integer

Integer numbers.

message
Type: object
content
Type: string

Het door AI gegenereerde antwoord, met inline citatieverwijzingen zoals [1][2].

role
Type: string
citations
Type: array string[]

Lijst van bron-URL's waarnaar in het antwoord wordt verwezen.

created
Type: integer

Unix-tijdstempel waarop de completion is aangemaakt.

id
Type: string

Unieke identificatie van de completion.

model
Type: string

Het model dat voor de completion is gebruikt.

object
Type: string
search_results
Type: array object[]

Gedetailleerde zoekresultaten met titels, snippets en URL's.

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

Integer numbers.

prompt_tokens
Type: integer

Integer numbers.

search_context_size
Type: string
total_tokens
Type: integer

Integer numbers.
application/json
400

Het verzoek kon niet worden verwerkt. Controleer de verzoekparameters.
401

Een geldige Felo-API-sleutel is vereist.
402

Het verzoek kan niet doorgaan omdat niet aan een factureringsvoorwaarde is voldaan.
403

Het account mag deze bewerking niet uitvoeren.
429

Een verzoek- of bestedingslimiet is bereikt.
502

De dienst kon het verzoek niet voltooien.
503

De API of factureringsdienst is tijdelijk niet beschikbaar.
504

Er is een time-out opgetreden bij het verwerken van het verzoek.
default

Foutrespons; upstream-passthrough-responsen kunnen indelingen van de provider gebruiken

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

Schema tonen

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

Succesvolle respons met AI-antwoord en bronvermeldingen

Perplexity Sonar Deep Research

AuthenticatieRequired

Perplexity API

Perplexity Sonar Deep Research

Prijsreferentie