> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pal.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Search



## OpenAPI

````yaml POST /search
openapi: 3.1.0
info:
  title: HeyPal API
  version: '1.0'
  description: >-
    The HeyPal API makes it easy to add A.I. powered semantic-search & other
    A.I. functionality to your product & content.
servers:
  - url: https://api.pal.ai/v1
security:
  - API Key: []
paths:
  /search:
    post:
      summary: Search
      operationId: post-search
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                applicationId:
                  type: string
                  x-stoplight:
                    id: rm5w9upaj7zt4
                query:
                  type: string
                  x-stoplight:
                    id: hie2sb82op0go
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    $ref: '#/components/schemas/SearchResults'
                    x-stoplight:
                      id: g7dhoqwwhigef
            application/xml:
              schema:
                type: object
                properties: {}
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  '':
                    type: string
                    x-stoplight:
                      id: zwvs68z5s6ca8
components:
  schemas:
    SearchResults:
      title: SearchResults
      x-stoplight:
        id: 8ru9mlevhbb5a
      type: object
      properties:
        documents:
          x-stoplight:
            id: a6hm8esk8vbu6
          type: array
          items:
            $ref: '#/components/schemas/SearchResultDocument'
            x-stoplight:
              id: q7awucxjehpxc
        sections:
          x-stoplight:
            id: djy5szi7gar58
          type: array
          items:
            $ref: '#/components/schemas/SearchResultSection'
            x-stoplight:
              id: 8epjxbwwli6c0
    SearchResultDocument:
      title: SearchResultDocument
      x-stoplight:
        id: tedvaboygvsz3
      type: object
      properties:
        id:
          type: string
        title:
          type: string
          x-stoplight:
            id: szfb41o346s8j
        url:
          type: string
          x-stoplight:
            id: twz4ofljy43vm
        contentPreview:
          type: string
          x-stoplight:
            id: smvofz5kercly
      required:
        - id
        - title
        - contentPreview
    SearchResultSection:
      title: SearchResultSection
      x-stoplight:
        id: 40kaw83usyn3x
      type: object
      properties:
        id:
          type: string
        applicationId:
          type: string
          x-stoplight:
            id: 1hf86daam0v0v
        heading:
          type: string
          x-stoplight:
            id: yocswro10mueg
        text:
          type: string
          x-stoplight:
            id: k0xka7fthms8p
        documentId:
          type: string
          x-stoplight:
            id: libpxrvo8dr98
        indexOrder:
          type: string
          x-stoplight:
            id: unc8se3x8631p
        indexId:
          type: string
          x-stoplight:
            id: nmb2ghiaab592
        indexName:
          type: string
          x-stoplight:
            id: 7ut3j1bx5d29i
        indexInfo:
          type: string
          x-stoplight:
            id: s3mpr2hvaopm3
        deletedAt:
          type: string
          x-stoplight:
            id: amaxct5n3t92s
        updatedAt:
          type: string
          x-stoplight:
            id: bbef3z6fhqekq
        createdAt:
          type: string
          x-stoplight:
            id: rc91811wlffd7

````