Perplexity Sonar API

openapi: 3.2.0
info:
  title: Perplexity AI Sonar API
  description: Perplexity AI API
  version: 1.0.0
servers:
- url: https://api.perplexity.ai
  description: Perplexity AI API
tags:
- name: Sonar
paths:
  /v1/sonar:
    post:
      summary: Create Chat Completion
      description: Generate a chat completion response for the given conversation.
      operationId: chat_completions_chat_completions_post
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiChatCompletionsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompletionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Sonar
components:
  schemas:
    ImageResult:
      description: A single image search result
      properties:
        image_url:
          type: string
          description: URL of the image
        origin_url:
          type: string
          description: Original URL where the image was found
        height:
          format: int64
          type: integer
          description: Height of the image in pixels
        width:
          format: int64
          type: integer
          description: Width of the image in pixels
        title:
          type: string
          description: Title or description of the image
      required:
      - image_url
      - origin_url
      - height
      - width
      type: object
      title: ImageResult
    ChatMessageContentPDFChunk:
      properties:
        type:
          type: string
          const: pdf_url
          title: Type
        pdf_url:
          anyOf:
          - $ref: '#/components/schemas/URL'
          - type: string
          title: Pdf Url
      type: object
      required:
      - type
      - pdf_url
      title: ChatMessageContentPDFChunk
    VideoURL:
      properties:
        url:
          type: string
          title: Url
        frame_interval:
          anyOf:
          - type: string
          - type: integer
          title: Frame Interval
          default: 25
      type: object
      required:
      - url
      title: VideoURL
    ApiPublicSearchResult:
      description: A single search result from the web
      properties:
        title:
          type: string
          title: Title
          description: Title of the search result page
        url:
          type: string
          title: Url
          description: URL of the search result page
        date:
          anyOf:
          - type: string
          - type: 'null'
          title: Date
          description: Publication date of the result
        last_updated:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Updated
          description: Date the result was last updated
        snippet:
          type: string
          title: Snippet
          description: Text snippet from the search result
          default: ''
        source:
          type: string
          enum:
          - web
          - attachment
          title: Source
          description: Source type of the result (web or attachment)
          default: web
      type: object
      required:
      - title
      - url
      title: ApiPublicSearchResult
    Choice:
      description: A single completion choice
      properties:
        index:
          type: integer
          title: Index
          description: Index of the choice in the array
        finish_reason:
          anyOf:
          - type: string
            enum:
            - stop
            - length
          - type: 'null'
          title: Finish Reason
          description: Reason generation stopped (stop or length)
        message:
          $ref: '#/components/schemas/ChatMessage-Output'
          description: Complete message (non-streaming)
        delta:
          $ref: '#/components/schemas/ChatMessage-Output'
          description: Incremental message delta (streaming)
      type: object
      required:
      - index
      - message
      - delta
      title: Choice
    UsageInfo:
      description: Token usage and cost information for a request
      properties:
        prompt_tokens:
          type: integer
          title: Prompt Tokens
          description: Number of tokens in the prompt/input
        completion_tokens:
          type: integer
          title: Completion Tokens
          description: Number of tokens in the completion/output
        total_tokens:
          type: integer
          title: Total Tokens
          description: Total tokens used (prompt + completion)
        search_context_size:
          anyOf:
          - type: string
          - type: 'null'
          title: Search Context Size
          description: Size of search context used
        citation_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Citation Tokens
          description: Number of tokens used for citations
        num_search_queries:
          anyOf:
          - type: integer
          - type: 'null'
          title: Num Search Queries
          description: Number of search queries executed
        reasoning_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Reasoning Tokens
          description: Number of tokens used for reasoning
        cost:
          $ref: '#/components/schemas/Cost'
          description: Cost breakdown for the request
      type: object
      required:
      - prompt_tokens
      - completion_tokens
      - total_tokens
      - cost
      title: UsageInfo
    UserLocation:
      description: User's geographic location for search personalization
      properties:
        latitude:
          anyOf:
          - type: number
          - type: 'null'
          title: Latitude
          description: Latitude coordinate
        longitude:
          anyOf:
          - type: number
          - type: 'null'
          title: Longitude
          description: Longitude coordinate
        country:
          anyOf:
          - type: string
          - type: 'null'
          title: Country
          description: ISO 3166-1 alpha-2 country code
        city:
          anyOf:
          - type: string
          - type: 'null'
          title: City
          description: City name
        region:
          anyOf:
          - type: string
          - type: 'null'
          title: Region
          description: State or region name
      type: object
      title: UserLocation
    JSONSchema:
      properties:
        schema:
          additionalProperties: true
          type: object
          title: Schema
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          default: schema
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          default: true
      type: object
      required:
      - schema
      title: JSONSchema
    URL:
      properties:
        url:
          type: string
          title: Url
      type: object
      required:
      - url
      title: URL
    ChatMessage-Input:
      properties:
        role:
          $ref: '#/components/schemas/ChatMessageRole'
        content:
          anyOf:
          - type: string
          - items:
              anyOf:
              - $ref: '#/components/schemas/ChatMessageContentTextChunk'
              - $ref: '#/components/schemas/ChatMessageContentImageChunk'
              - $ref: '#/components/schemas/ChatMessageContentFileChunk'
              - $ref: '#/components/schemas/ChatMessageContentPDFChunk'
              - $ref: '#/components/schemas/ChatMessageContentVideoChunk'
            type: array
            title: Structured Content
          - type: 'null'
          title: Content
      type: object
      required:
      - role
      - content
      title: ChatMessage
    ChatMessageContentFileChunk:
      properties:
        type:
          type: string
          const: file_url
          title: Type
        file_url:
          anyOf:
          - $ref: '#/components/schemas/URL'
          - type: string
          title: File Url
        file_name:
          anyOf:
          - type: string
          - type: 'null'
          title: File Name
      type: object
      required:
      - type
      - file_url
      title: ChatMessageContentFileChunk
    ChatMessageRole:
      type: string
      enum:
      - system
      - user
      - assistant
      - tool
      title: ChatMessageRole
      description: Chat roles enum
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ChatMessage-Output:
      properties:
        role:
          $ref: '#/components/schemas/ChatMessageRole'
        content:
          anyOf:
          - type: string
          - items:
              anyOf:
              - $ref: '#/components/schemas/ChatMessageContentTextChunk'
              - $ref: '#/components/schemas/ChatMessageContentImageChunk'
              - $ref: '#/components/schemas/ChatMessageContentFileChunk'
              - $ref: '#/components/schemas/ChatMessageContentPDFChunk'
              - $ref: '#/components/schemas/ChatMessageContentVideoChunk'
            type: array
            title: Structured Content
          - type: 'null'
          title: Content
      type: object
      required:
      - role
      - content
      title: ChatMessage
    ChatMessageContentVideoChunk:
      properties:
        type:
          type: string
          const: video_url
          title: Type
        video_url:
          anyOf:
          - $ref: '#/components/schemas/VideoURL'
          - type: string
          title: Video Url
      type: object
      required:
      - type
      - video_url
      title: ChatMessageContentVideoChunk
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ChatMessageContentTextChunk:
      properties:
        type:
          type: string
          const: text
          title: Type
        text:
          type: string
          title: Text
      type: object
      required:
      - type
      - text
      title: ChatMessageContentTextChunk
    CompletionResponse:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the completion
        model:
          type: string
          title: Model
          description: Model used for generation
        created:
          type: integer
          title: Created
          description: Unix timestamp when the completion was created
        usage:
          anyOf:
          - $ref: '#/components/schemas/UsageInfo'
          - type: 'null'
        object:
          type: string
          title: Object
          description: Object type identifier
          default: chat.completion
        choices:
          items:
            $ref: '#/components/schemas/Choice'
          type: array
          title: Choices
          description: Array of completion choices
        citations:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Citations
          description: URLs of sources used to generate the response
        search_results:
          anyOf:
          - items:
              $ref: '#/components/schemas/ApiPublicSearchResult'
            type: array
          - type: 'null'
          title: Search Results
          description: Search results used for context in the response
        images:
          anyOf:
          - items:
              $ref: '#/components/schemas/ImageResult'
            type: array
          - type: 'null'
          title: Images
          description: Array of images returned when return_images is true
        related_questions:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Related Questions
          description: Array of related questions returned when return_related_questions is true
      type: object
      required:
      - id
      - model
      - created
      - choices
      title: CompletionResponse
    ChatMessageContentImageChunk:
      properties:
        type:
          type: string
          const: image_url
          title: Type
        image_url:
          anyOf:
          - $ref: '#/components/schemas/URL'
          - type: string
          title: Image Url
      type: object
      required:
      - type
      - image_url
      title: ChatMessageContentImageChunk
    Cost:
      description: Cost breakdown for a chat completion request
      properties:
        input_tokens_cost:
          type: number
          title: Input Tokens Cost
          description: Cost for input tokens in USD
        output_tokens_cost:
          type: number
          title: Output Tokens Cost
          description: Cost for output tokens in USD
        reasoning_tokens_cost:
          anyOf:
          - type: number
          - type: 'null'
          title: Reasoning Tokens Cost
          description: Cost for reasoning tokens in USD
        request_cost:
          anyOf:
          - type: number
          - type: 'null'
          title: Request Cost
          description: Cost for web search requests in USD (includes pro search cost if applicable)
        citation_tokens_cost:
          anyOf:
          - type: number
          - type: 'null'
          title: Citation Tokens Cost
          description: Cost for citation tokens in USD
        search_queries_cost:
          anyOf:
          - type: number
          - type: 'null'
          title: Search Queries Cost
          description: Cost for search queries in USD
        total_cost:
          type: number
          title: Total Cost
          description: Total cost for the request in USD
      type: object
      required:
      - input_tokens_cost
      - output_tokens_cost
      - total_cost
      title: Cost
    ApiChatCompletionsRequest:
      properties:
        max_tokens:
          anyOf:
          - type: integer
            maximum: 128000
            exclusiveMinimum: 0
          - type: 'null'
          title: Max Tokens
          description: Maximum number of completion tokens to generate
        model:
          type: string
          title: Model
          description: Model to use, for example, sonar-pro
          enum:
          - sonar
          - sonar-pro
          - sonar-deep-research
          - sonar-reasoning-pro
        stream:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Stream
          description: If true, returns streaming SSE response
          default: false
        stop:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          - type: 'null'
          title: Stop
          description: Stop sequences. Generation stops when one of these strings is produced
        temperature:
          anyOf:
          - type: number
            minimum: 0
            maximum: 2
          - type: 'null'
          title: Temperature
          description: 'Controls randomness in the response. Higher values make output more random. Range: 0-2'
        top_p:
          anyOf:
          - type: number
            minimum: 0
            maximum: 1
          - type: 'null'
          title: Top P
          description: Nucleus sampling parameter. Controls diversity via nucleus sampling
        response_format:
          anyOf:
          - $ref: '#/components/schemas/ResponseFormatText'
          - $ref: '#/components/schemas/ResponseFormatJSONSchema'
          - type: 'null'
          title: Response Format
          description: Optional. Controls the output format. Omit for default text output. Set `type` to `json_schema` for structured output.
          discriminator:
            propertyName: type
            mapping:
              text: '#/components/schemas/ResponseFormatText'
              json_schema: '#/components/schemas/ResponseFormatJSONSchema'
        messages:
          items:
            $ref: '#/components/schemas/ChatMessage-Input'
          type: array
          title: Messages
          description: Array of messages forming the conversation history
        web_search_options:
          $ref: '#/components/schemas/WebSearchOptions'
        search_mode:
          anyOf:
          - type: string
            enum:
            - web
            - academic
            - sec
          - type: 'null'
          title: Search Mode
          description: Source of search results (web, academic, or sec)
        return_images:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Return Images
          description: When true, include image results in the response
        return_related_questions:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Return Related Questions
          description: When true, generates suggested follow-up queries based on the search results
        enable_search_classifier:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enable Search Classifier
          description: When true, uses a classifier to determine if web search is needed for the query
        disable_search:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Disable Search
          description: When true, disables all web search capabilities. The model responds based solely on its training data
        search_domain_filter:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Search Domain Filter
          description: Limit search results to specific domains (e.g. github.com, wikipedia.org)
        search_language_filter:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Search Language Filter
          description: Filter results by language using ISO 639-1 codes (e.g. en, fr, de)
        search_recency_filter:
          anyOf:
          - type: string
            enum:
            - hour
            - day
            - week
            - month
            - year
          - type: 'null'
          title: Search Recency Filter
          description: Filter by publication recency (hour, day, week, month, or year)
        search_after_date_filter:
          anyOf:
          - type: string
          - type: 'null'
          title: Search After Date Filter
          description: Return results published after this date (MM/DD/YYYY)
        search_before_date_filter:
          anyOf:
          - type: string
          - type: 'null'
          title: Search Before Date Filter
          description: Return results published before this date (MM/DD/YYYY)
        last_updated_before_filter:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Updated Before Filter
          description: Return results last updated before this date (MM/DD/YYYY)
        last_updated_after_filter:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Updated After Filter
          description: Return results last updated after this date (MM/DD/YYYY)
        image_format_filter:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Image Format Filter
          description: Filter image results by format (e.g. png, jpg)
        image_domain_filter:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Image Domain Filter
          description: Limit image results to specific domains
        stream_mode:
          type: string
          enum:
          - full
          - concise
          title: Stream Mode
          description: Controls the format of streaming events. 'full' suppresses reasoning events and includes metadata inline; 'concise' emits reasoning events separately
          default: full
        reasoning_effort:
          anyOf:
          - type: string
            enum:
            - minimal
            - low
            - medium
            - high
          - type: 'null'
          title: Reasoning Effort
          description: Controls how much effort the model spends on reasoning
        language_preference:
          anyOf:
          - type: string
          - type: 'null'
          title: Language Preference
          description: ISO 639-1 language code for preferred response language
      type: object
      required:
      - model
      - messages
      title: ApiChatCompletionsRequest
    WebSearchOptions:
      description: Configuration options for web search behavior
      properties:
        search_context_size:
          type: string
          enum:
          - low
          - medium
          - high
          title: Search Context Size
          description: Amount of search context to include (low, medium, or high)
          default: low
        search_type:
          anyOf:
          - type: string
            enum:
            - fast
            - pro
            - auto
          - type: 'null'
          title: Search Type
          description: Search type (fast for speed, pro for quality, auto to let the model decide)
        user_location:
          anyOf:
          - $ref: '#/components/schemas/UserLocation'
          - type: 'null'
        image_results_enhanced_relevance:
          type: boolean
          title: Image Results Enhanced Relevance
          description: When true, applies enhanced relevance filtering to image results
          default: false
      type: object
      title: WebSearchOptions
    ResponseFormatJSONSchema:
      description: Constrains the model output to match the provided JSON schema.
      properties:
        type:
          type: string
          const: json_schema
          title: Type
          description: Must be `json_schema`.
        json_schema:
          $ref: '#/components/schemas/JSONSchema'
      type: object
      required:
      - type
      - json_schema
      title: ResponseFormatJSONSchema
    ResponseFormatText:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: Must be `text`.
      type: object
      required:
      - type
      title: ResponseFormatText
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer