> ## Documentation Index
> Fetch the complete documentation index at: https://test-62a57ffd.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Summarizer search



## OpenAPI

````yaml api-reference/openapi.json get /v1/summarizer/search
openapi: 3.1.0
info:
  title: Brave Search Products API
  description: |

    Product APIs exposed by Brave Search.

    You will be able to:

    * **Web Search**
  termsOfService: http://localhost:10000/terms-of-use/
  contact:
    name: Brave Search API
    url: http://localhost:10000/contact/
    email: search-api@brave.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
  x-logo:
    url: >-
      https://cdn.search.brave.com/docs/681607ea86f83e9e04d242342a18f73f83f37137f5cd5246753f7a7a5beaca32-brave-logo-home-dark.svg
servers:
  - url: /res
    description: Default server
security:
  - ApiKeyAuth: []
tags:
  - name: web
    description: Get search results from the web
    x-displayName: Web Search
    x-mint:
      title: Web Search API
      description: Get search results from the web
  - name: news
    description: Get search results from the news
    x-displayName: News Search
  - name: videos
    description: Get search results from the videos
    x-displayName: Videos Search
  - name: images
    description: Get search results from the images
    x-displayName: Images Search
  - name: summarizer
    description: Get summarized search results
    x-displayName: AI Search
  - name: other
    description: Other API services
    x-displayName: Other
paths:
  /v1/summarizer/search:
    get:
      tags:
        - summarizer
      summary: Summarizer search
      operationId: summarizer_search_v1_summarizer_search_get
      parameters:
        - name: key
          in: query
          required: true
          schema:
            type: string
            description: >-
              The key is equal to value of field key as part of the Summarizer
              response model.
            title: Key
          description: >-
            The key is equal to value of field key as part of the Summarizer
            response model.
        - name: entity_info
          in: query
          required: false
          schema:
            type: boolean
            description: Returns extra entities info with the summary response.
            default: false
            title: Entity Info
          description: Returns extra entities info with the summary response.
          examples:
            Extra entity info:
              value: true
            No extra entity info:
              value: false
        - name: inline_references
          in: query
          required: false
          schema:
            type: boolean
            description: Adds inline references to the summary response.
            default: false
            title: Inline References
          description: Adds inline references to the summary response.
          examples:
            Inline references:
              value: true
            No inline references:
              value: false
        - name: x-subscription-token
          in: header
          required: true
          schema:
            type: string
            title: Subscription token
            description: The subscription token that was generated for the product.
            examples:
              - BSAgdIxiH0OLq6fnx6F-xp8Yplv4uOp
          description: The subscription token that was generated for the product.
        - name: api-version
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: API version
            description: >-
              The API version to use.                 This is denoted by the
              format `YYYY-MM-DD`.                 Default is the latest that is
              available.
          description: >-
            The API version to use.                 This is denoted by the
            format `YYYY-MM-DD`.                 Default is the latest that is
            available.
        - name: accept
          in: header
          required: false
          schema:
            $ref: '#/components/schemas/Accept'
            title: Media type
            description: The default supported media type is application/json.
            examples:
              - application/json
            default: application/json
          description: The default supported media type is application/json.
        - name: cache-control
          in: header
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/CacheControl'
              - type: 'null'
            title: Cache control
            description: >-
              Brave Search will return cached content by
              default.                 To prevent caching set the Cache-Control
              header to no-cache.                 This is currently done as best
              effort.
          description: >-
            Brave Search will return cached content by default.                
            To prevent caching set the Cache-Control header to
            no-cache.                 This is currently done as best effort.
        - name: user-agent
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: User agent
            description: >-
              The user agent originating the request.                 Brave
              search can utilize the user agent to provide a
              different                 experience depending on the device as
              described by the string.                 The user agent should
              follow the commonly used browser agent                 strings on
              each platform. For more information on curating user
              agents,                 see [RFC
              9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-user-agent).
            examples:
              - >-
                **Android** Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36
                (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36
              - >-
                **iOS** Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X)
                AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63
                Mobile/15E148 Safari/604.1
              - >-
                **macOS** Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4)
                AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0
                Safari/537.36
              - >-
                **Windows** Mozilla/5.0 (Windows NT 10.0; Win64; x64)
                AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0
                Safari/537.36
          description: >-
            The user agent originating the request.                 Brave search
            can utilize the user agent to provide a different                
            experience depending on the device as described by the
            string.                 The user agent should follow the commonly
            used browser agent                 strings on each platform. For
            more information on curating user agents,                 see [RFC
            9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-user-agent).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SummarizerSearchApiResponse'
        '404':
          content:
            application/json:
              examples:
                SUBSCRIPTION_NOT_FOUND:
                  summary: Missing subscription.
                  value:
                    type: ErrorResponse
                    errors:
                      - id: 5d832250-9396-4f6e-b84a-2a1fe524cd7d
                        code: SUBSCRIPTION_NOT_FOUND
                        detail: No subscription found.
                        status: 404
                        meta:
                          component: subscriptions
                    time: 1663072993
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
        '422':
          content:
            application/json:
              examples:
                SUBSCRIPTION_TOKEN_INVALID:
                  summary: Invalid subscription token.
                  value:
                    type: ErrorResponse
                    errors:
                      - id: 5d832250-9396-4f6e-b84a-2a1fe524cd7d
                        code: SUBSCRIPTION_TOKEN_INVALID
                        detail: The provided subscription token is invalid.
                        status: 422
                        meta:
                          component: authentication
                    time: 1663072993
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unprocessable Entity
        '429':
          content:
            application/json:
              examples:
                RATE_LIMITED:
                  summary: Rate limited.
                  value:
                    type: ErrorResponse
                    errors:
                      - id: 5d832250-9396-4f6e-b84a-2a1fe524cd7d
                        code: RATE_LIMITED
                        detail: Request rate limit exceeded for plan.
                        status: 429
                        meta:
                          component: rate_limiter
                    time: 1663072993
                QUOTA_LIMITED:
                  summary: Quota limited.
                  value:
                    type: ErrorResponse
                    errors:
                      - id: 5d832250-9396-4f6e-b84a-2a1fe524cd7d
                        code: QUOTA_LIMITED
                        detail: Request quota limit exceeded for plan.
                        status: 429
                        meta:
                          component: rate_limiter
                    time: 1663072993
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Too Many Requests
components:
  schemas:
    Accept:
      type: string
      enum:
        - application/json
        - '*/*'
      title: Accept
    CacheControl:
      type: string
      enum:
        - no-cache
      const: no-cache
      title: CacheControl
    SummarizerSearchApiResponse:
      properties:
        type:
          type: string
          enum:
            - summarizer
          const: summarizer
          title: Type
          default: summarizer
        status:
          $ref: '#/components/schemas/SummarizerStatus'
          description: >-
            The current status of summarizer for the given key. The value can be
            either failed or complete.
          default: failed
        results:
          anyOf:
            - items:
                $ref: '#/components/schemas/SummarizerResult'
              type: array
            - type: 'null'
          title: Results
          description: The list of search results used to generate the summary.
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
          description: The title for the summary.
        summary:
          anyOf:
            - items:
                $ref: '#/components/schemas/SummaryMessage'
              type: array
            - type: 'null'
          title: Summary
          description: Details for the summary message.
        enrichments:
          anyOf:
            - $ref: '#/components/schemas/SummaryEnrichments'
            - type: 'null'
          description: Enrichments that can be added to the summary message.
        followups:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Followups
          description: Followup queries relevant to the current query.
        entities_infos:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/SummaryEntityInfo'
              type: object
            - type: 'null'
          title: Entities Infos
          description: Details on the entities in the summary message.
      type: object
      title: SummarizerSearchApiResponse
    ErrorResponse:
      properties:
        type:
          type: string
          title: Type
          default: ErrorResponse
        error:
          $ref: '#/components/schemas/ErrorModel'
        time:
          type: integer
          title: Time
          default: 0
      type: object
      required:
        - error
      title: ErrorResponse
    SummarizerStatus:
      type: string
      enum:
        - complete
        - failed
      title: SummarizerStatus
    SummarizerResult:
      properties:
        type:
          type: string
          title: Type
          description: The type of result. The value is always `summarizer_result`.
          default: summarizer_result
        summary:
          type: string
          title: Summary
          description: The generated summary text.
        answer:
          anyOf:
            - $ref: '#/components/schemas/SummarizerAnswer'
            - type: 'null'
          description: The extracted answer if the query is a question.
        references:
          items:
            $ref: '#/components/schemas/ReferenceSource'
          type: array
          title: References
          description: References used to generate the summary.
          default: []
      type: object
      required:
        - summary
      title: SummarizerResult
    SummaryMessage:
      properties:
        type:
          $ref: '#/components/schemas/SummaryMessageType'
          description: The type of subset of a summary message.
        data:
          anyOf:
            - $ref: '#/components/schemas/SummaryEntity'
            - type: string
            - $ref: '#/components/schemas/SummaryInlineReference'
            - type: 'null'
          title: Data
          description: The summary entity, text token, or inline reference data.
      type: object
      required:
        - type
      title: SummaryMessage
    SummaryEnrichments:
      properties:
        raw:
          type: string
          title: Raw
          description: The raw summary message.
        images:
          anyOf:
            - items:
                $ref: '#/components/schemas/SummaryImage'
              type: array
            - type: 'null'
          title: Images
          description: The images associated with the summary.
        qa:
          anyOf:
            - items:
                $ref: '#/components/schemas/SummaryAnswer'
              type: array
            - type: 'null'
          title: Qa
          description: The answers in the summary message.
        entities:
          anyOf:
            - items:
                $ref: '#/components/schemas/SummaryEntity'
              type: array
            - type: 'null'
          title: Entities
          description: The entities in the summary message.
        context:
          anyOf:
            - items:
                $ref: '#/components/schemas/SummaryContext'
              type: array
            - type: 'null'
          title: Context
          description: References based on which the summary was built.
      type: object
      required:
        - raw
      title: SummaryEnrichments
    SummaryEntityInfo:
      properties:
        provider:
          anyOf:
            - type: string
            - type: 'null'
          title: Provider
          description: The name of the provider.
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Description of the entity.
      type: object
      title: SummaryEntityInfo
    ErrorModel:
      properties:
        id:
          type: string
          title: Id
        status:
          type: integer
          title: Status
        code:
          $ref: '#/components/schemas/ErrorCode'
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
        meta:
          anyOf:
            - type: object
            - type: 'null'
          title: Meta
      type: object
      required:
        - id
        - status
        - code
      title: ErrorModel
    SummarizerAnswer:
      properties:
        text:
          type: string
          title: Text
          description: The answer text.
        location:
          $ref: '#/components/schemas/TextLocation'
          description: The location of the answer in the text.
      type: object
      required:
        - text
        - location
      title: SummarizerAnswer
    ReferenceSource:
      properties:
        type:
          type: string
          title: Type
          description: The type of reference source.
        name:
          type: string
          title: Name
          description: The name of the reference source.
        url:
          type: string
          title: Url
          description: The URL of the reference source.
        img:
          anyOf:
            - type: string
            - type: 'null'
          title: Img
          description: The image URL associated with the reference source.
        locations:
          items:
            $ref: '#/components/schemas/TextLocation'
          type: array
          title: Locations
          description: Text locations in the summary where this reference is cited.
          default: []
      type: object
      required:
        - type
        - name
        - url
      title: ReferenceSource
    SummaryMessageType:
      type: string
      enum:
        - token
        - enum_item
        - enum_start
        - enum_end
        - inline_reference
      title: SummaryMessageType
    SummaryEntity:
      properties:
        uuid:
          type: string
          title: Uuid
          description: A unique identifier for the entity.
        name:
          type: string
          title: Name
          description: The name of the entity.
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
          description: The URL where further details on the entity can be found.
        text:
          anyOf:
            - type: string
            - type: 'null'
          title: Text
          description: A text message describing the entity.
        images:
          anyOf:
            - items:
                $ref: '#/components/schemas/SummaryImage'
              type: array
            - type: 'null'
          title: Images
          description: The image associated with the entity.
        highlight:
          anyOf:
            - items:
                $ref: '#/components/schemas/TextLocation'
              type: array
            - type: 'null'
          title: Highlight
          description: The location of the entity in the summary message.
      type: object
      required:
        - uuid
        - name
      title: SummaryEntity
    SummaryInlineReference:
      properties:
        type:
          type: string
          title: Type
          description: >-
            The type of inline reference. The value is always
            `inline_reference`.
        url:
          type: string
          title: Url
          description: The URL that is being referenced.
        start_index:
          type: integer
          title: Start Index
          description: The start index of the inline reference in the summary message.
        end_index:
          type: integer
          title: End Index
          description: The end index of the inline reference in the summary message.
        number:
          type: integer
          title: Number
          description: The ordinal number of the inline reference.
        favicon:
          anyOf:
            - type: string
            - type: 'null'
          title: Favicon
          description: The favicon of the URL that is being referenced.
        snippet:
          anyOf:
            - type: string
            - type: 'null'
          title: Snippet
          description: The reference text snippet.
      type: object
      required:
        - type
        - url
        - start_index
        - end_index
        - number
      title: SummaryInlineReference
    SummaryImage:
      properties:
        thumbnail:
          $ref: >-
            #/components/schemas/app__models__products__search__v1__shared__Thumbnail
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
        properties:
          anyOf:
            - $ref: '#/components/schemas/ImageProperties'
            - type: 'null'
        text:
          anyOf:
            - type: string
            - type: 'null'
          title: Text
          description: Text associated with the image.
      type: object
      required:
        - thumbnail
      title: SummaryImage
    SummaryAnswer:
      properties:
        answer:
          type: string
          title: Answer
          description: The answer text.
        score:
          anyOf:
            - type: number
            - type: 'null'
          title: Score
          description: A score associated with the answer.
        highlight:
          anyOf:
            - $ref: '#/components/schemas/TextLocation'
            - type: 'null'
          description: The location of the answer in the summary message.
      type: object
      required:
        - answer
      title: SummaryAnswer
    SummaryContext:
      properties:
        title:
          type: string
          title: Title
          description: The title of the reference.
        url:
          type: string
          title: Url
          description: The URL where the reference can be found.
        meta_url:
          anyOf:
            - $ref: >-
                #/components/schemas/app__models__products__search__v1__summarizer__MetaUrl
            - type: 'null'
          description: Details on the URL associated with the reference.
      type: object
      required:
        - title
        - url
      title: SummaryContext
    ErrorCode:
      type: string
      enum:
        - INTERNAL
        - INVALID_ID
        - UNAUTHORIZED
        - RESOURCE_NOT_ALLOWED
        - FORBIDDEN
        - VALIDATION
        - INVALID_PASSWORD
        - INVALID_EMAIL
        - INVALID_NAME
        - INVALID_COMPANY
        - INVALID_VAT_NUMBER
        - INVALID_DESCRIPTION
        - INVALID_USAGE
        - INVALID_INVOICE_NOTES
        - INVALID_PURCHASE_ORDER
        - PASSWORD_REUSED
        - PASSWORD_BREACHED
        - INVALID_TIME_RANGE
        - USER_ALREADY_EXISTS
        - USER_INACTIVE
        - RESET_PASSWORD_BAD_TOKEN
        - USER_NOT_FOUND
        - LOGIN_BAD_CREDENTIALS
        - LOGIN_USER_LOCKED_OUT
        - LOGIN_USER_NOT_VERIFIED
        - LOGIN_INVALID_MFA_CHALLENGE
        - VERIFY_USER_BAD_TOKEN
        - VERIFY_USER_ALREADY_VERIFIED
        - PLAN_NOT_FOUND
        - PLAN_ALREADY_EXISTS
        - PLAN_ALREADY_PUBLIC
        - PLAN_ALREADY_ALLOWED
        - STRIPE_CUSTOMER_NOT_EXISTS
        - STRIPE_SUBSCRIPTION_NOT_EXISTS
        - PRODUCT_NOT_FOUND
        - API_VERSION_NOT_FOUND
        - PRODUCT_ALREADY_EXISTS
        - OPTION_NOT_FOUND
        - OPTION_ALREADY_EXISTS
        - OPTION_NOT_IN_PLAN
        - SUBSCRIPTION_TOKEN_LIMIT
        - SUBSCRIPTION_TOKEN_INVALID
        - SUBSCRIPTION_TOKEN_INACTIVE
        - SUBSCRIPTION_TOKEN_DEACTIVATED
        - SUBSCRIPTION_TOKEN_NOT_FOUND
        - SUBSCRIPTION_ALREADY_EXISTS
        - SUBSCRIPTION_NOT_FOUND
        - ACTIVITY_SESSION_NOT_FOUND
        - ORGANIZATION_NOT_FOUND
        - ORGANIZATION_NOT_MEMBER
        - NO_PLANS_SUBSCRIBED
        - QUOTA_LIMITED
        - RATE_LIMITED
        - USAGE_LIMIT_EXCEEDED
        - USAGE_LIMIT_NOT_FOUND
        - USAGE_LIMIT_ALREADY_EXISTS
        - RESOURCE_NOT_SUBSCRIBED
        - CONTENT_TYPE_NOT_SUPPORTED
        - AGGREGATION_NOT_SUPPORTED
        - TIME_GRANULARITY_NOT_SUPPORTED
        - CURRENCY_NOT_FOUND
        - CURRENCY_ALREADY_EXISTS
        - CSRF_VERIFICATION
        - INVALID_GOGGLE_URL
        - INVALID_URL
        - INVALID_DOMAIN
        - INVALID_RESULT_FILTER
        - CONTENT_URL_LIMIT_EXCEEDED
        - TOS_NOT_FOUND
        - ADDENDUM_NOT_FOUND
        - REDACTION_NOT_FOUND
        - REDACTION_ALREADY_EXISTS
        - ADDENDUM_ALREADY_EXISTS
        - TOS_ALREADY_EXISTS
        - QUERY_NOT_FOUND
        - EMAIL_DOMAIN_IN_BLOCKLIST_NOT_FOUND
        - EMAIL_DOMAIN_IN_BLOCKLIST_ALREADY_EXISTS
        - EMAIL_DOMAIN_NOT_ALLOWED
        - INVALID_TOTP_TOKEN
        - EMAIL_MFA_SENT_EXCEEDED
        - EMAIL_MFA_NOT_SENT
        - AUTHENTICATOR_MFA_ALREADY_EXISTS
        - AUTHENTICATOR_MFA_NOT_FOUND
        - MFA_FAIL_TOO_MANY_ATTEMPTS
        - INVALID_RECOVERY_CODE
        - MFA_TOKEN_NOT_FOUND
        - PAYMENT_METHOD_NOT_FOUND
        - PAYMENT_METHOD_ALREADY_EXISTS
        - ROLE_NOT_FOUND
        - USER_ALREADY_MEMBER
        - ORGANIZATION_INVITATION_ALREADY_EXISTS
        - INVALID_ORGANIZATION_INVITATION
        - ORGANIZATION_INVITATION_NOT_FOUND
        - COMPLIANCE_NOT_FOUND
        - AWS_MARKETPLACE_TOKEN_INVALID
        - AWS_MARKETPLACE_TOKEN_EXPIRED
        - AWS_MARKETPLACE_CUSTOMER_RESOLUTION_FAILED
        - AWS_MARKETPLACE_PRODUCT_NOT_FOUND
        - AWS_MARKETPLACE_CREDENTIALS_MISSING
        - AWS_MARKETPLACE_API_ERROR
        - EMAIL_CHANGE_BAD_TOKEN
        - EMAIL_CHANGE_INVALID_MFA_CHALLENGE
        - EMAIL_CHANGE_MFA_FAIL_TOO_MANY_ATTEMPTS
        - EMAIL_CHANGE_RATE_LIMITED
        - EMAIL_CHANGE_INVALID_PASSWORD
      title: ErrorCode
    TextLocation:
      properties:
        start:
          type: integer
          title: Start
          description: The 0-based index, where the important part of the text starts.
        end:
          type: integer
          title: End
          description: The 0-based index, where the important part of the text ends.
      type: object
      required:
        - start
        - end
      title: TextLocation
    app__models__products__search__v1__shared__Thumbnail:
      properties:
        src:
          type: string
          title: Src
        alt:
          anyOf:
            - type: string
            - type: 'null'
          title: Alt
        height:
          anyOf:
            - type: integer
            - type: 'null'
          title: Height
        width:
          anyOf:
            - type: integer
            - type: 'null'
          title: Width
        bg_color:
          anyOf:
            - type: string
            - type: 'null'
          title: Bg Color
        original:
          anyOf:
            - type: string
            - type: 'null'
          title: Original
        logo:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Logo
        duplicated:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Duplicated
        theme:
          anyOf:
            - type: string
            - type: 'null'
          title: Theme
      type: object
      required:
        - src
      title: Thumbnail
    ImageProperties:
      properties:
        url:
          type: string
          title: Url
        resized:
          type: string
          title: Resized
        placeholder:
          type: string
          title: Placeholder
        height:
          anyOf:
            - type: integer
            - type: 'null'
          title: Height
        width:
          anyOf:
            - type: integer
            - type: 'null'
          title: Width
        format:
          anyOf:
            - type: string
            - type: 'null'
          title: Format
        content_size:
          anyOf:
            - type: string
            - type: 'null'
          title: Content Size
      type: object
      required:
        - url
        - resized
        - placeholder
        - content_size
      title: ImageProperties
    app__models__products__search__v1__summarizer__MetaUrl:
      properties:
        scheme:
          anyOf:
            - type: string
            - type: 'null'
          title: Scheme
          description: The protocol scheme extracted from the URL.
        netloc:
          anyOf:
            - type: string
            - type: 'null'
          title: Netloc
          description: The network location part extracted from the URL.
        hostname:
          anyOf:
            - type: string
            - type: 'null'
          title: Hostname
          description: The lowercased domain name extracted from the URL.
        favicon:
          anyOf:
            - type: string
            - type: 'null'
          title: Favicon
          description: The favicon used for the URL.
        path:
          anyOf:
            - type: string
            - type: 'null'
          title: Path
          description: The hierarchical path of the URL useful as a display string.
      type: object
      title: MetaUrl
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-subscription-token
      description: The subscription token that was generated for the product.

````