v0.2.0-beta

OpenAPI 3.1.0

Perplexity Sonar

Felo API Support

MIT

Máy chủ

https://openapi.felo.ai

Thư viện client

Shell Curl

Perplexity API

Generate answers and research reports with web citations.

Perplexity API Thao tác

post/v1/beta/perplexity/sonar

Perplexity Sonar

Tạo câu trả lời ngắn gọn kèm trích dẫn web. Cần có model và messages; dùng model sonar cho endpoint này. Hợp đồng công khai này bao gồm phản hồi JSON không streaming với stream false. Đọc câu trả lời từ choices[].message.content và nguồn từ citations và search_results. usage báo cáo mức tiêu thụ tài nguyên, không phải khoản phí tín dụng Felo.

Tham chiếu giá

Đo lường: Chi phí phản hồi được báo cáo.
Ước tính tham chiếu cho mỗi yêu cầu: USD 0.12783.
Hệ số khách hàng tham chiếu: 1.0. Không áp dụng lại cho số tiền khách hàng đã quyết toán.

Chỉ là siêu dữ liệu tham chiếu, không phải báo giá cho tài khoản, mức giá được bảo đảm hay hạn mức chi tiêu. Tín dụng tài nguyên không phải tín dụng Felo. Khoản phí cuối cùng tuân theo bản ghi thanh toán của Felo.

Phần thân

bắt buộc

application/json

messages
Kiểu: array object[]
bắt buộc

Danh sách các message tạo nên cuộc hội thoại đến thời điểm hiện tại.
- content
  Kiểu: string
  bắt buộc
  
  Nội dung của message.
- role
  Kiểu: string enum
  bắt buộc
  
  Vai trò của tác giả message.
  
  giá trị
  system
  user
  assistant
model
Kiểu: string enum
bắt buộc

Mô hình Sonar cần dùng.
giá trị
- sonar
- sonar-pro
- sonar-reasoning-pro
- sonar-deep-research
frequency_penalty
Kiểu: number
tối thiểu:
0
tối đa:
2

Phạt các token mới dựa trên tần suất hiện có của chúng trong văn bản đến thời điểm hiện tại. Giá trị dương làm giảm khả năng lặp lại nguyên văn cùng một dòng.
max_tokens
Kiểu: integer

Số token tối đa cần tạo trong phản hồi.
presence_penalty
Kiểu: number
tối thiểu:
-2
tối đa:
2

Phạt các token mới dựa trên việc chúng có xuất hiện trong văn bản đến thời điểm hiện tại hay không. Giá trị dương làm tăng khả năng nói về các chủ đề mới.
return_citations
Kiểu: boolean

Có trả về trích dẫn và kết quả tìm kiếm trong phản hồi hay không.
search_context
Kiểu: string enum

Kiểm soát lượng ngữ cảnh tìm kiếm được dùng. Ảnh hưởng đến chi phí mỗi yêu cầu.
giá trị
- low
- medium
- high
search_domain_filter
Kiểu: array string[]

Giới hạn tìm kiếm trong các tên miền cụ thể.
search_recency_filter
Kiểu: string enum

Lọc kết quả tìm kiếm theo độ mới.
giá trị
- month
- week
- day
- hour
stream
Kiểu: boolean

Có phát trực tiếp phản hồi bằng server-sent events hay không.
temperature
Kiểu: number
tối thiểu:
0
tối đa:
2

Nhiệt độ lấy mẫu từ 0 đến 2. Giá trị thấp hơn làm đầu ra tập trung và mang tính xác định hơn.
top_k
Kiểu: integer
tối thiểu:
0
tối đa:
2048

Số token cần giữ cho lọc top-k.

top_p
Kiểu: number
tối thiểu:
0
tối đa:
1

Tham số lấy mẫu nucleus. Mô hình xem xét các token có tổng xác suất top_p.

Phản hồi

200
Kiểu: object · ResponseD5E2470Dd28B_ChatCompletionResponse

Phản hồi thành công kèm câu trả lời AI và trích dẫn
choices
Kiểu: array object[]
finish_reason
Kiểu: string enum
giá trị
stop
length
index
Kiểu: integer

Integer numbers.

message
Kiểu: object
content
Kiểu: string

Câu trả lời do AI tạo, kèm các tham chiếu trích dẫn nội tuyến như [1][2].

role
Kiểu: string
citations
Kiểu: array string[]

Danh sách URL nguồn được tham chiếu trong câu trả lời.

created
Kiểu: integer

Dấu thời gian Unix khi completion được tạo.

id
Kiểu: string

Mã định danh duy nhất cho completion.

model
Kiểu: string

Mô hình được dùng cho completion.

object
Kiểu: string
search_results
Kiểu: array object[]

Kết quả tìm kiếm chi tiết với tiêu đề, đoạn trích và URL.

date
Kiểu: string
snippet
Kiểu: string
source
Kiểu: string
title
Kiểu: string
url
Kiểu: string
usage
Kiểu: object
completion_tokens
Kiểu: integer

Integer numbers.

prompt_tokens
Kiểu: integer

Integer numbers.

search_context_size
Kiểu: string
total_tokens
Kiểu: integer

Integer numbers.
application/json
400

Không thể xử lý yêu cầu. Hãy kiểm tra các tham số yêu cầu.
401

Cần có khóa API Felo hợp lệ.
402

Không thể tiếp tục yêu cầu vì chưa đáp ứng yêu cầu thanh toán.
403

Tài khoản không được phép thực hiện thao tác này.
429

Đã đạt giới hạn yêu cầu hoặc giới hạn chi tiêu.
502

Dịch vụ không thể hoàn tất yêu cầu.
503

API hoặc dịch vụ thanh toán tạm thời không khả dụng.
504

Dịch vụ đã hết thời gian chờ khi xử lý yêu cầu.
default

Phản hồi lỗi; phản hồi chuyển tiếp từ thượng nguồn có thể dùng định dạng của nhà cung cấp

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

Hiện schema

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

Phản hồi thành công kèm câu trả lời AI và trích dẫn

Perplexity Sonar

Xác thựcRequired

Perplexity API

Perplexity Sonar

Tham chiếu giá