Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Perplexity Sonar

Felo API Support
MIT
Сервер:https://openapi.felo.ai
Клиентские библиотеки
Shell Curl

Perplexity API

​

Generate answers and research reports with web citations.

Perplexity API Операции

Perplexity Sonar

​

Generate a concise answer with web citations. model and messages are required; use model sonar for this endpoint. This public contract covers non-streaming JSON responses with stream false. Read the answer from choices[].message.content and sources from citations and search_results. usage reports resource consumption, not a Felo credit charge.

Тело·ChatCompletionRequest
обязательно
application/json
  • messages
    Тип: array object[]
    обязательно

    A list of messages comprising the conversation so far.

    • content
      Тип: string
      обязательно

      The content of the message.

    • role
      Тип: string enum
      обязательно

      The role of the message author.

      значения
      • system
      • user
      • assistant
  • model
    Тип: string enum
    обязательно

    The Sonar model to use.

    значения
    • sonar
    • sonar-pro
    • sonar-reasoning-pro
    • sonar-deep-research
  • frequency_penalty
    Тип: number
    мин.:  
    0
    макс.:  
    2

    Penalizes new tokens based on their existing frequency in the text so far. Positive values decrease the likelihood of repeating the same line verbatim.

  • max_tokens
    Тип: integer

    The maximum number of tokens to generate in the response.

  • presence_penalty
    Тип: number
    мин.:  
    -2
    макс.:  
    2

    Penalizes new tokens based on whether they appear in the text so far. Positive values increase the likelihood of talking about new topics.

  • return_citations
    Тип: boolean

    Whether to return citations and search results in the response.

  • search_context
    Тип: string enum

    Controls how much search context to use. Affects per-request cost.

    значения
    • low
    • medium
    • high
  • search_domain_filter
    Тип: array string[]

    Limit search to specific domains.

  • search_recency_filter
    Тип: string enum

    Filter search results by recency.

    значения
    • month
    • week
    • day
    • hour
  • stream
    Тип: boolean enum
    константа:  
    false

    Only non-streaming JSON responses are covered by this public contract. Set false.

    значения
    • false
  • temperature
    Тип: number
    мин.:  
    0
    макс.:  
    2

    Sampling temperature between 0 and 2. Lower values make output more focused and deterministic.

  • top_k
    Тип: integer
    мин.:  
    0
    макс.:  
    2048

    The number of tokens to keep for top-k filtering.

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

    Nucleus sampling parameter. The model considers tokens with top_p probability mass.

Ответы
  • 200
    Тип: object · ChatCompletionResponse

    Successful response with AI answer and citations

    • choices
      Тип: array object[]
      • finish_reason
        Тип: string enum
        значения
        • stop
        • length
      • index
        Тип: integer

        Integer numbers.

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

          The AI-generated answer, with inline citation references like [1][2].

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

      List of source URLs referenced in the answer.

    • created
      Тип: integer

      Unix timestamp of when the completion was created.

    • id
      Тип: string

      Unique identifier for the completion.

    • model
      Тип: string

      The model used for the completion.

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

      Detailed search results with titles, snippets, and URLs.

      • 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

    The request could not be processed. Check the request parameters.

  • 401

    A valid Felo API key is required.

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    A request or spending limit has been reached.

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for 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}'

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

Successful response with AI answer and citations

Perplexity Sonar