v0.2.0-beta

OpenAPI 3.1.0

Perplexity Sonar

Felo API Support

MIT

Server

https://openapi.felo.ai

Client-Bibliotheken

Shell Curl

Perplexity API

Generate answers and research reports with web citations.

Perplexity API Operationen

post/v1/beta/perplexity/sonar

Perplexity Sonar

Erzeugt eine prägnante Antwort mit Web-Quellenangaben. model und messages sind erforderlich; verwenden Sie für diesen Endpunkt das Modell sonar. Dieser öffentliche Vertrag deckt nicht gestreamte JSON-Antworten mit stream false ab. Lesen Sie die Antwort aus choices[].message.content und die Quellen aus citations und search_results. usage meldet den Ressourcenverbrauch, keine Felo-Credit-Gebühr.

Preisreferenz

Abrechnung: Gemeldete Antwortkosten.
Referenzschätzung pro Anfrage: USD 0.12783.
Referenz-Kundenmultiplikator: 1.0. Nicht erneut auf einen abgerechneten Kundenbetrag anwenden.

Nur Referenzmetadaten, kein Kontenangebot, kein garantierter Preis und keine Ausgabenobergrenze. Ressourcen-Credits sind keine Felo-Credits. Endgültige Abrechnungen richten sich nach den Felo-Abrechnungsbelegen.

Body

erforderlich

application/json

messages
Typ: array object[]
erforderlich

Eine Liste von Nachrichten, die das bisherige Gespräch bilden.
- content
  Typ: string
  erforderlich
  
  Der Inhalt der Nachricht.
- role
  Typ: string enum
  erforderlich
  
  Die Rolle des Nachrichtenautors.
  
  Werte
  system
  user
  assistant
model
Typ: string enum
erforderlich

Das zu verwendende Sonar-Modell.
Werte
- sonar
- sonar-pro
- sonar-reasoning-pro
- sonar-deep-research
frequency_penalty
Typ: number
min.:
0
max.:
2

Bestraft neue Tokens anhand ihrer bisherigen Häufigkeit im Text. Positive Werte verringern die Wahrscheinlichkeit, dieselbe Zeile wörtlich zu wiederholen.
max_tokens
Typ: integer

Die maximale Anzahl der in der Antwort zu erzeugenden Tokens.
presence_penalty
Typ: number
min.:
-2
max.:
2

Bestraft neue Tokens danach, ob sie bisher im Text vorkommen. Positive Werte erhöhen die Wahrscheinlichkeit, über neue Themen zu sprechen.
return_citations
Typ: boolean

Ob Zitate und Suchergebnisse in der Antwort zurückgegeben werden.
search_context
Typ: string enum

Steuert, wie viel Suchkontext verwendet wird. Wirkt sich auf die Kosten pro Anfrage aus.
Werte
- low
- medium
- high
search_domain_filter
Typ: array string[]

Die Suche auf bestimmte Domains beschränken.
search_recency_filter
Typ: string enum

Suchergebnisse nach Aktualität filtern.
Werte
- month
- week
- day
- hour
stream
Typ: boolean

Ob die Antwort über Server-Sent Events gestreamt wird.
temperature
Typ: number
min.:
0
max.:
2

Sampling-Temperatur zwischen 0 und 2. Niedrigere Werte machen die Ausgabe fokussierter und deterministischer.
top_k
Typ: integer
min.:
0
max.:
2048

Die Anzahl der Tokens, die für die Top-k-Filterung beibehalten werden.

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

Parameter für Nucleus-Sampling. Das Modell berücksichtigt Tokens mit der Wahrscheinlichkeitsmasse top_p.

Antworten

200
Typ: object · ResponseD5E2470Dd28B_ChatCompletionResponse

Erfolgreiche Antwort mit KI-Ergebnis und Quellenangaben
choices
Typ: array object[]
finish_reason
Typ: string enum
Werte
stop
length
index
Typ: integer

Integer numbers.

message
Typ: object
content
Typ: string

Die KI-generierte Antwort mit Inline-Zitatverweisen wie [1][2].

role
Typ: string
citations
Typ: array string[]

Liste der in der Antwort referenzierten Quell-URLs.

created
Typ: integer

Unix-Zeitstempel der Erstellung der Completion.

id
Typ: string

Eindeutige Kennung der Completion.

model
Typ: string

Das für die Completion verwendete Modell.

object
Typ: string
search_results
Typ: array object[]

Detaillierte Suchergebnisse mit Titeln, Snippets und URLs.

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

Die Anfrage konnte nicht verarbeitet werden. Prüfen Sie die Anfrageparameter.
401

Ein gültiger Felo-API-Schlüssel ist erforderlich.
402

Die Anfrage kann nicht fortgesetzt werden, da eine Abrechnungsvoraussetzung nicht erfüllt ist.
403

Das Konto ist für diesen Vorgang nicht berechtigt.
429

Ein Anfrage- oder Ausgabenlimit wurde erreicht.
502

Der Dienst konnte die Anfrage nicht abschließen.
503

Die API oder der Abrechnungsdienst ist vorübergehend nicht verfügbar.
504

Beim Verarbeiten der Anfrage ist eine Zeitüberschreitung aufgetreten.
default

Fehlerantwort; Upstream-Passthrough-Antworten können Anbieterformate verwenden

application/json

post/v1/beta/perplexity/sonar

curl --request POST https://openapi.felo.ai/v1/beta/perplexity/sonar \
  --header "Authorization: Bearer ${FELO_API_KEY:?Set FELO_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{"model": "sonar", "messages": [{"role": "user", "content": "What is HTTP caching? Cite the relevant documentation."}], "max_tokens": 512, "stream": false}'

Schema anzeigen

{
  "id": "example-sonar-completion",
  "model": "sonar",
  "object": "chat.completion",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "HTTP caching reuses stored responses when permitted by cache rules. [1]"
      },
      "finish_reason": "stop"
    }
  ],
  "citations": [
    "https://www.rfc-editor.org/rfc/rfc9111.html"
  ],
  "search_results": [
    {
      "title": "HTTP Caching",
      "url": "https://www.rfc-editor.org/rfc/rfc9111.html"
    }
  ],
  "usage": {
    "prompt_tokens": 20,
    "completion_tokens": 30,
    "total_tokens": 50
  }
}

Erfolgreiche Antwort mit KI-Ergebnis und Quellenangaben

Perplexity Sonar

AuthentifizierungRequired

Perplexity API

Perplexity Sonar

Preisreferenz