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

# Search

> The `/search` endpoint lets you intelligently search a list of videos that precisely ranked by the most relevant moments found within their content.

<Card horizontal="true" arrow="true" title="Get Your Vizlook API Key" icon="key" href="https://www.vizlook.com/dashboard/api-keys">Sign up and receive \$10 free credit.</Card>


## OpenAPI

````yaml POST /search
openapi: 3.1.0
info:
  title: Vizlook API
  description: The Vizlook OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.vizlook.com
security:
  - apiKeyAuth: []
paths:
  /search:
    post:
      description: >-
        The `/search` endpoint lets you intelligently search a list of videos
        that precisely ranked by the most relevant moments found within their
        content.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequestBody'
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
      x-codeSamples:
        - lang: bash
          source: |-
            curl -X POST 'https://api.vizlook.com/search' \
              -H 'x-api-key: YOUR_VIZLOOK_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{
                "query": "how to be productive",
                "maxResults": 5,
                "contentOptions": {
                  "includeTranscription": true,
                  "includeSummary": true
                }
              }'
        - lang: python
          source: |-
            # pip install vizlook
            from vizlook import Vizlook

            vizlook = Vizlook(api_key="YOUR_VIZLOOK_API_KEY")

            response = vizlook.search(
                "how to be productive",
                max_results=5,
                include_transcription=True,
                include_summary=True,
            )

            print("response with original API field name: ")
            print(response.to_dict())

            print("response with snake case field name: ")
            print(response.to_dict(use_api_field_name=False))

            print("get field value with snake case key from pydantic model: ")
            print(response.results)
        - lang: javascript
          source: |-
            // npm install @vizlook/sdk
            import Vizlook from "@vizlook/sdk";

            const vizlook = new Vizlook({
              apiKey: "YOUR_VIZLOOK_API_KEY",
            });

            const response = await vizlook.search("how to be productive", {
              maxResults: 5,
              includeTranscription: true,
              includeSummary: true,
            });

            console.log(response);
components:
  schemas:
    SearchRequestBody:
      required:
        - query
      type: object
      properties:
        query:
          description: The query string for the search.
          type: string
          example: how to be productive
        category:
          description: >-
            A video category to focus on. The video category classified by our
            algorithm.
          type: string
          enum:
            - Healthcare
            - Ecommerce
            - Tech
            - Finance
            - Education
          example: Tech
        startPublishedDate:
          description: >-
            Start date for results based on video published date in ISO
            timestamp string or millisecond. Such as '2025-01-01T00:00:00Z' or
            1735689600000.
          type:
            - string
            - integer
          example: '2025-01-01T00:00:00Z'
        endPublishedDate:
          description: >-
            End date for results based on video published date in ISO timestamp
            string or millisecond. Such as '2025-01-01T00:00:00Z' or
            1735689600000.
          type:
            - string
            - integer
          example: '2025-01-01T00:00:00Z'
        containSpokenText:
          description: >-
            A text string to search for in the video's spoken audio
            transcription, case-insensitive.
          type: string
          example: work smarter and with more intensity
        containScreenText:
          description: >-
            A text string to search for in the video's on-screen text,
            case-insensitive.
          type: string
          example: I struggle a lot with like
        maxResults:
          description: >-
            The maximum number of search results to return. The default value is
            10 and the maximum value is 20.
          type: integer
          example: 5
        contentOptions:
          description: Configure what search results include.
          type: object
          properties:
            includeTranscription:
              description: Whether to include video transcription in the search results.
              type: boolean
              example: true
            includeSummary:
              description: Whether to include video summary in the search results.
              type: boolean
              example: true
    SearchResponse:
      type: object
      properties:
        results:
          description: >-
            A list of search video results containing title, URL, published
            date, author, highlight clips, transcription, summary.
          type: array
          items:
            $ref: '#/components/schemas/SearchResultItem'
        dollarCost:
          description: Dollar cost of the request.
          type: object
          properties:
            total:
              description: Total dollar cost for your request.
              type: number
              example: 0.009
            breakdown:
              description: Breakdown of costs by operation type.
              type: object
              nullable: true
              properties:
                search:
                  description: Cost of your search operations.
                  type: number
                  example: 0.005
                transcription:
                  description: Cost of your transcription operations.
                  type: number
                  nullable: true
                  example: 0.002
                summary:
                  description: Cost of your summary operations.
                  type: number
                  nullable: true
                  example: 0.002
      example:
        results:
          - url: https://www.youtube.com/watch?v=reR_EtTCkW4
            title: Give me 7 minutes and I’ll Make You Dangerously Productive
            description: >-
              ▸▸ Subscribe to The Martell Method Newsletter:
              https://bit.ly/3XEBXez


              ▸▸ Get My New Book (Buy Back Your Time): https://bit.ly/3pCTG78


              Working 18-hour days isn’t productivity; it’s burnout. I’ve built
              teams and companies generating millions, and it wasn’t from
              grinding nonstop. It was from building a system that made me
              unstoppable. In this video, I’ll show you the exact roadmap.
            thumbnail:
              url: https://i.ytimg.com/vi/reR_EtTCkW4/sddefault.jpg
              width: 640
              height: 480
            author:
              name: Dan Martell
              url: https://www.youtube.com/@danmartell
              avatar: >-
                https://yt3.ggpht.com/0EEjg1FatDs8_2tFmzmGEP6dRlQygfqN6uCV17iwl-AymS0OSdWrtDeKq8ZIMZeTWRJO_cTT=s88-c-k-c0x00ffffff-no-rj
            publishedDate: '2025-08-19T15:01:36.000Z'
            duration: 444
            favicon: >-
              https://www.youtube.com/s/desktop/f788da0a/img/logos/favicon_48x48.png
            score: 0.8417034
            highlights:
              - startTime: 55
                endTime: 131
                visualDescription: >-
                  The animated graphic continues, showing the first step: a down
                  arrow and "Cut The Crap". The speaker, in a blue t-shirt, is
                  at his desk, talking and gesturing. Text overlay: "Cut The
                  Crap". He explains to delete what doesn't matter, focusing on
                  his most important goal.

                  The speaker is framed on the right, with a dark background on
                  the left listing productivity steps. Text overlay: "CUT THE
                  CRAP". The list starts with a highlighted bullet point: "Pick
                  one goal.". The background on the left shows a piece of paper
                  with "Goal 1" to "Goal 10" written on it, then "Goal 3" is
                  highlighted, and finally, only "Goal 3" remains, with a list
                  of tasks underneath: "- Develop business plan - Conduct market
                  research - Create brand identity - Build website - Launch
                  product".

                  The speaker continues on the right, with the list expanding on
                  the left. "Pick one goal." is followed by a new highlighted
                  point: "Pull up your calendar.". A Google Calendar for August
                  2025 is shown with numerous appointments. Then, "Go task by
                  task and ask: 'does this move me closer to my 5-year goal?' ->
                  If yes, circle it green." is highlighted, and many calendar
                  entries turn green. The next point is: "Then ask: 'does it
                  pull me away from my 5-year goal?' -> If yes, circle it red.".
                  A man plays video games. People clink beer mugs. Several
                  calendar entries turn red. Finally, "Cut The Red." is
                  highlighted, and all red entries disappear from the calendar.

                  The speaker, in a blue t-shirt, is at his desk. He talks about
                  ruthless cutting and the most successful people. The scene
                  cuts to him shaking hands with John C. Maxwell (Bestselling
                  Author, Speaker) in a podcast studio, then to him interviewing
                  Ed Mylett (Global Entrepreneur & Bestselling Author). The
                  speaker then returns to his desk, stating that if something
                  isn't moving you forward, it's holding you back.

                  The speaker is at his desk. He mentions his book "Buy Back
                  Your Time". Pages from the book are shown, including sections
                  on "Step into the Arena", "Control of Your Week", and a weekly
                  calendar template. The book cover, "BUY BACK YOUR TIME" by Dan
                  Martell, is prominently displayed. Text overlay: "LINK IN
                  DESCRIPTION". He then transitions to the next problem: too
                  many demands on attention.
                audioTranscription: >-
                  First things first, cut the crap. Forget optimizing. First
                  delete what doesn't matter. If it's not driving towards your
                  most important goals, it's dead weight.

                  So here's how you do it. First off, you pick one goal. I
                  remember listening to this productivity guy and he said, hey,
                  pull out a piece paper, write all your goals on that piece of
                  paper. And pick the one goal, if you got it done, it would
                  make all the other goals come true. And then write that goal
                  on the back side of the paper and then write all the projects
                  and things you could do to make that goal come true. That is
                  your focus.

                  Pull up your calendar. Look at a full typical week. Then one
                  by one ask yourself, does this move me closer to my 5-year
                  goal? If yes, circle it green. Then ask yourself, does it pull
                  me away from my 5-year goal? This is playing video games, this
                  is hanging out with friends that don't support your goals. If
                  it's a yes, circle it in red. Now cut the red. Ruthlessly.

                  The most successful people I know can say no. They know what
                  they're focused on, they know what they're going to get done,
                  and they don't allow things to distract them from getting it
                  done. If it's not moving you forward, it's holding you back,
                  period.

                  Now, I actually go way deeper on this in my book Buy Back Your
                  Time. There's a whole section dedicated to exactly how to spot
                  and cut the stuff that's slowing you down. So once you've got
                  all the BS out of the way, you've got a new problem. Now
                  everyone and everything wants a piece of your freaking
                  attention.
            transcription:
              videoClips:
                - startTime: 0
                  endTime: 5
                  visualDescription: >-
                    A male speaker with short, light brown hair, wearing a blue
                    t-shirt and a watch, is seated at a wooden desk in front of
                    a black microphone on a boom arm. He is looking directly at
                    the camera, speaking. The background features light wooden
                    paneling and shelves with various decorative objects and
                    books, including a plant and a white vase. Text overlay
                    reads: "Definition: the state or quality of producing
                    something." and below it, in smaller text, "'Output equals
                    worth' - Believing the more they produce in a day, the more
                    valuable they are, regardless of quality or balance."
                - startTime: 5
                  endTime: 14
                  visualDescription: >-
                    The speaker in the blue t-shirt continues to speak,
                    gesturing with his hands. The scene transitions to a man
                    working on a laptop at night, with office building lights
                    visible outside the window. Text overlay: "putting in crazy
                    hours". Then, a man lies in bed, hands on his head, looking
                    stressed. Text overlay: "grinding non-stop". Next, a
                    close-up of an eye reflecting a screen, then a finger
                    tapping a smartphone with text messages. Text overlay:
                    "checking more boxes". The speaker reappears, emphasizing
                    his point. Fire particle effects briefly animate over him.
                    Text overlay: "Burnout with a To-Do list".
                - startTime: 14
                  endTime: 22
                  visualDescription: >-
                    The scene shows various software interfaces: ClickUp
                    dashboard, Slack channels, and a product launch dashboard
                    with charts. A hand writes in a physical planner. A close-up
                    of eyes behind glasses reflects screen activity. Text
                    overlays: "you're still DROWNING IN TASKS barely moving the
                    needle". The speaker returns to the foreground, animated
                    with a determined expression, gesturing with his hands.
                - startTime: 22
                  endTime: 29
                  visualDescription: >-
                    The speaker is at his desk. A split screen shows a Drake
                    meme with "doing more" disliked and "doing less" liked,
                    illustrating the concept. The scene shifts to the speaker on
                    stage, back to the audience, then facing the audience at a
                    conference with large red screens displaying "FORWARD/".
                    Text overlay: "I've coached thousands of high performers
                    through this exact shift".
                - startTime: 29
                  endTime: 40
                  visualDescription: >-
                    The speaker, in a blue t-shirt, is back at his desk,
                    speaking into the microphone. A montage shows him speaking
                    at various events and in different settings. Logos for
                    'SPHERIC', 'Flowtown', and 'Clarity' appear. He's seen in a
                    meeting with other men, looking at a laptop, with a
                    whiteboard in the background. A group photo shows him
                    holding a YouTube Play Button award with a team. Text
                    overlay: "Generated Millions Every Month". He emphasizes
                    that none of his achievements came from working 18-hour days
                    or daily affirmations.
                - startTime: 40
                  endTime: 55
                  visualDescription: >-
                    The speaker, wearing a blue t-shirt, sits at a wooden desk
                    with a microphone. He is talking and gesturing. The scene
                    briefly splits into two identical images of him. He then
                    appears seated at a desk with another man, looking at
                    laptops and pointing. The scene transitions to him standing
                    and speaking in front of a whiteboard with "THE PUMP"
                    written on the wall behind him. The screen displays "SYSTEM"
                    which then transforms into "SYSTEM = DANGEROUSLY PRODUCTIVE"
                    with an upward-trending graph in the background. An animated
                    graphic shows a figure struggling to climb a staircase,
                    while another figure effortlessly uses a laptop at the top
                    of a rising graph. Text appears, "Become Dangerously
                    Productive", followed by the speaker stating his intention
                    to share the roadmap.
              audioClips:
                - startTime: 0
                  endTime: 5
                  transcription: >-
                    The definition 99% of people use for productivity is dumb as
                    f*ck.
                  speakerId: speaker_1
                - startTime: 5
                  endTime: 14
                  transcription: >-
                    Everyone thinks it's about putting in crazy hours, grinding
                    non-stop and checking more boxes, but that's not
                    productivity, that's burnout with a To-Do list.
                  speakerId: speaker_1
                - startTime: 14
                  endTime: 22
                  transcription: >-
                    And no matter how many apps you download or planners you
                    buy, you're still drowning in tasks barely moving the
                    needle.
                  speakerId: speaker_1
                - startTime: 22
                  endTime: 29
                  transcription: >-
                    Because real productivity isn't about doing more, it's about
                    doing less. I've coached thousands of high performers
                    through this exact shift.
                  speakerId: speaker_1
                - startTime: 29
                  endTime: 40
                  transcription: >-
                    And I've been through it myself. I've scaled and exited
                    multiple companies, built teams that generated millions
                    every month. And none of that happened because I worked 18
                    hours a day or repeated daily affirmations in the mirror.
                  speakerId: speaker_1
                - startTime: 40
                  endTime: 55
                  transcription: >-
                    It happened because I learned how to build a system that
                    made me dangerously productive. And it's your lucky day
                    because I'm going to give you the exact road map, so you can
                    use it too. That way you won't just be productive, you'll be
                    f*cking unstoppable.
                  speakerId: speaker_1
            summary:
              overallSummary: >-
                This video, titled "Give me 7 minutes and I’ll Make You
                Dangerously Productive," challenges common misconceptions about
                productivity, arguing that true productivity isn't about doing
                more, but rather doing less and achieving 10 times more. The
                speaker, Dan Martell, shares a four-step system to achieve
                "dangerous productivity" and avoid burnout. The system focuses
                on ruthlessly eliminating unimportant tasks, strategically
                protecting one's time, leveraging automation and delegation to
                multiply efforts, and winning each day by preparing the night
                before and prioritizing deep work. Martell emphasizes that by
                implementing these strategies, individuals can transform their
                productivity and achieve their full potential.
              sectionSummaries:
                - startTime: 0
                  endTime: 55
                  title: >-
                    Redefining Productivity: Beyond Busywork to a 'Dangerous'
                    System
                  summary: >-
                    Dan Martell critiques the conventional understanding of
                    productivity as constant busywork, which he labels as
                    "burnout with a To-Do list." He highlights common pitfalls
                    like putting in crazy hours, grinding non-stop, and endless
                    task-checking, which lead to feeling overwhelmed. Instead,
                    he asserts that real productivity is about "doing less" to
                    achieve "10x more." Drawing from his experience coaching
                    high-performers and scaling successful companies, Martell
                    introduces his "dangerously productive" system, promising to
                    share the roadmap for becoming unstoppable.
                - startTime: 55
                  endTime: 131
                  title: 'Step 1: Cut The Crap - Eliminating Dead Weight Tasks'
                  summary: >-
                    The first step to dangerous productivity is to "cut the
                    crap" by ruthlessly eliminating tasks that don't contribute
                    to your most important goals. Martell advises identifying
                    your single most important goal and then, using your
                    calendar, categorizing all weekly tasks as either moving you
                    closer (green) or pulling you away (red) from that goal. He
                    stresses the importance of saying "no" to distractions and
                    cutting out all "red" tasks, suggesting his book "Buy Back
                    Your Time" for further guidance on this crucial elimination
                    process.
        dollarCost:
          total: 0.009
          breakdown:
            search: 0.005
            summary: 0.002
            transcription: 0.002
    SearchResultItem:
      allOf:
        - $ref: '#/components/schemas/CommonVideoData'
        - type: object
          properties:
            highlights:
              description: >-
                The video clip that best matches the query. It only one video
                clip now.
              type: array
              items:
                $ref: '#/components/schemas/VideoHighlight'
            transcription:
              $ref: '#/components/schemas/Transcription'
            summary:
              $ref: '#/components/schemas/Summary'
    CommonVideoData:
      type: object
      properties:
        url:
          description: The video page URL.
          type: string
          example: https://www.youtube.com/watch?v=2FMBSblpcrc
        title:
          description: The video title.
          type: string
          example: How to use one paper towel | Joe Smith | TEDxConcordiaUPortland
        description:
          description: The video description.
          type: string
          example: >-
            R. P. Joe Smith served as a District Attorney in Umatilla County and
            nearly won a race for Oregon Attorney General without taking a
            single contribution over $99.99.
        thumbnail:
          description: The video thumbnail image.
          type: object
          properties:
            url:
              description: image URL
              type: string
              example: https://i.ytimg.com/vi/2FMBSblpcrc/sddefault.jpg
            width:
              description: image width
              type: integer
              example: 640
            height:
              description: image height
              type: integer
              example: 480
        author:
          description: The information of video author.
          type: object
          properties:
            name:
              description: author name
              type: string
              example: TEDx Talks
            url:
              description: author detail URL
              type: string
              nullable: true
              example: https://www.youtube.com/@tedx
            avatar:
              description: author avatar URL
              type: string
              example: >-
                https://yt3.ggpht.com/1gDPO-4YPWFErfn3yQBnv0yxpkmiud1m5CrorApkOqUYdNd9FrZQ9xB9C9VmDt4EsgArnlwqAQc=s88-c-k-c0x00ffffff-no-rj
        publishedDate:
          description: Video published date, ISO timestamp string
          type: string
          example: '2012-04-18T04:26:13.000Z'
        duration:
          description: Video duration in seconds
          type: integer
          example: 268
        favicon:
          description: The URL of the favicon for the search result's domain.
          type: string
          example: >-
            https://www.youtube.com/s/desktop/f788da0a/img/logos/favicon_48x48.png
        score:
          description: relevance score for query
          type: number
          nullable: true
          example: 0.6847141
    VideoHighlight:
      description: The video clip that best matches the query.
      type: object
      properties:
        startTime:
          description: Start time of the video clip in seconds.
          type: integer
          example: 47
        endTime:
          description: End time of the video clip in seconds.
          type: integer
          example: 84
        visualDescription:
          description: Visual description of the video clip.
          type: string
          example: >-
            Joe Smith stands center stage, demonstrating various ways people
            grab paper towels. He mimes pulling two or three trifold paper
            towels, then several tear-off sheets which he crumbles, then sheets
            from a self-cutting dispenser which he also crumples. He then
            demonstrates using recycled paper towels, indicating that people
            take more because they are less absorbent. He bends over a white
            basin, then stands up, pointing his finger upwards and smiling,
            emphasizing that everything can be done with 'one towel'.
        audioTranscription:
          description: Audio transcription of the video clip.
          type: string
          nullable: true
          example: >-
            Now there are all kinds of paper towel dispensers. There's the
            trifold. People typically take two or three.

            There's the one that cuts it that you have to tear off. People go
            one, two, three, four, tear, this much, right?

            There's the one that cuts itself. People go, one, two, three, four.

            Or there's the same thing, but recycled paper. You have to get five
            of those because they're not as absorbent, of course.

            The fact is, you can do it all with one towel.
    Transcription:
      description: >-
        The video transcription with visual and auditory when set
        `contentOptions.includeTranscription` as `true`, otherwise null.
      type: object
      nullable: true
      properties:
        videoClips:
          description: Video clips with visual descriptions.
          type: array
          items:
            $ref: '#/components/schemas/VideoClip'
        audioClips:
          description: Audio clips with transcriptions.
          type: array
          items:
            $ref: '#/components/schemas/AudioClip'
    Summary:
      description: >-
        The video summary when set `contentOptions.includeSummary` as `true`,
        otherwise null.
      type: object
      nullable: true
      properties:
        overallSummary:
          description: Overall summary of the video.
          type: string
          example: >-
            Joe Smith's TEDx talk highlights the significant waste generated by
            paper towel usage, with Americans alone consuming billions of pounds
            annually. He proposes a simple, two-step method, 'Shake and Fold,'
            to dry hands effectively using just one paper towel, significantly
            reducing waste. Smith demonstrates this technique for various
            dispenser types, emphasizing that proper technique can achieve
            superior dryness compared to using multiple sheets. He concludes by
            urging the audience to adopt this method, promising a lifelong
            change in their paper towel habits and noting the substantial
            positive environmental impact.
        sectionSummaries:
          description: Section summaries of the video.
          type: array
          items:
            type: object
            properties:
              startTime:
                description: Start time of the section in seconds.
                type: integer
                example: 0
              endTime:
                description: End time of the section in seconds.
                type: integer
                example: 7
              title:
                description: Title of the section.
                type: string
                example: Introduction to TEDx ConcordiaUPortland
              summary:
                description: Summary of the section.
                type: string
                example: >-
                  The video opens with the TEDx ConcordiaUPortland title card,
                  highlighting its independent organization and theme of
                  'Becoming Extraordinary.' It also credits Unconventional
                  Guides for sharing the content. This segment features
                  introductory music and brief applause, setting the stage for
                  the presentation.
    VideoClip:
      description: The video clip with visual description.
      type: object
      properties:
        startTime:
          description: Start time of the video clip in seconds.
          type: integer
          example: 0
        endTime:
          description: End time of the video clip in seconds.
          type: integer
          example: 7
        visualDescription:
          description: Visual description of the video clip.
          type: string
          example: >-
            The video opens with a grey background featuring the red 'TEDx'
            logo, followed by 'ConcordiaUPortland' in black text. Below it, 'x =
            independently organized TED event' is in smaller red text. The text
            'BECOMING EXTRAORDINARY' appears briefly, then a yellow-green
            rectangular banner with an orange bird icon and the text
            'UNCONVENTIONALGUIDES.COM' fades in. The background gradually
            changes from grey to white and then to a darker shade before
            transitioning to black.
    AudioClip:
      description: The video clip with audio transcription.
      type: object
      properties:
        startTime:
          description: Start time of the video clip in seconds.
          type: integer
          example: 11
        endTime:
          description: End time of the video clip in seconds.
          type: integer
          example: 26
        transcription:
          description: Transcription of the audio clip.
          type: string
          example: >-
            571 million, 230,000 pounds of paper towels are used by Americans
            every year.
        speakerId:
          description: >-
            The speaker ID of the audio clip, such as 'speaker_1'. If the
            speaker is identified, it will be set to the speaker's name.
          type: string
          example: Joe Smith
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: x-api-key
      in: header
      description: API key must be provided via `x-api-key` header.

````