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

# Get a highlight and its stories

> Get a saved Instagram highlight and its available stories, including media variants, publish times, author details, mentions, links and shared posts. Saved highlights do not expire. Stories in a highlight are returned together without pagination. Costs 1 credit per request.



## OpenAPI

````yaml /openapi.json post /instagram/highlight
openapi: 3.1.0
info:
  title: Bridgly API
  description: >-
    Web scraping API for LinkedIn, X (Twitter), Reddit, GitHub, Instagram and
    TikTok. Authenticated endpoints accept a Bridgly API key (`bgly_…`) via
    `Authorization: Bearer <token>`.
  version: 1.0.0
servers:
  - url: https://api.bridgly.app
    description: Production
security: []
tags:
  - name: LinkedIn
    description: Scrape LinkedIn profiles, companies, posts, and search.
  - name: Reddit
    description: Scrape Reddit posts, subreddits, users, and search.
  - name: X (Twitter)
    description: Scrape tweets and search X.
  - name: GitHub
    description: >-
      Fetch GitHub profiles, pinned repos, contributions, repositories, stars,
      and projects via GitHub's GraphQL API.
  - name: Instagram
    description: Scrape Instagram profiles, posts, followers, and search.
  - name: TikTok
    description: Fetch TikTok profiles.
paths:
  /instagram/highlight:
    post:
      tags:
        - Instagram
      summary: Get a highlight and its stories
      description: >-
        Get a saved Instagram highlight and its available stories, including
        media variants, publish times, author details, mentions, links and
        shared posts. Saved highlights do not expire. Stories in a highlight are
        returned together without pagination. Costs 1 credit per request.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                highlightId:
                  type: string
                  minLength: 1
                  description: >-
                    Numeric highlight ID, highlight:<ID>, or an Instagram
                    stories/highlights link.
              required:
                - highlightId
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  timeMs:
                    type: number
                    description: >-
                      Wall-clock time the request took to complete, in
                      milliseconds.
                  creditsCost:
                    type: number
                    description: Number of account credits this request consumed.
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Highlight ID. Pass this to getHighlight.
                      title:
                        anyOf:
                          - type: string
                          - type: 'null'
                      cover_url:
                        anyOf:
                          - type: string
                          - type: 'null'
                      owner_id:
                        anyOf:
                          - type: string
                          - type: 'null'
                      owner:
                        anyOf:
                          - type: object
                            properties:
                              id:
                                type: string
                              username:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              full_name:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              profile_pic_url:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              is_private:
                                anyOf:
                                  - type: boolean
                                  - type: 'null'
                              is_verified:
                                anyOf:
                                  - type: boolean
                                  - type: 'null'
                              profile_pic_id:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              latest_reel_media:
                                description: >-
                                  Latest story publish time as Unix seconds;
                                  zero means no recent story.
                                anyOf:
                                  - type: number
                                  - type: 'null'
                              is_mentionable:
                                anyOf:
                                  - type: boolean
                                  - type: 'null'
                            required:
                              - id
                            additionalProperties: false
                          - type: 'null'
                      latest_story_at:
                        description: Latest story publish time as Unix seconds.
                        anyOf:
                          - type: number
                          - type: 'null'
                      username:
                        anyOf:
                          - type: string
                          - type: 'null'
                      url:
                        type: string
                      stories:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            display_url:
                              anyOf:
                                - type: string
                                - type: 'null'
                            video_url:
                              anyOf:
                                - type: string
                                - type: 'null'
                            width:
                              anyOf:
                                - type: number
                                - type: 'null'
                            height:
                              anyOf:
                                - type: number
                                - type: 'null'
                            video_duration:
                              description: Video duration in seconds.
                              anyOf:
                                - type: number
                                - type: 'null'
                            accessibility_caption:
                              anyOf:
                                - type: string
                                - type: 'null'
                            image_versions:
                              anyOf:
                                - type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                      width:
                                        anyOf:
                                          - type: number
                                          - type: 'null'
                                      height:
                                        anyOf:
                                          - type: number
                                          - type: 'null'
                                    required:
                                      - url
                                    additionalProperties: false
                                - type: 'null'
                            video_versions:
                              anyOf:
                                - type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                      width:
                                        anyOf:
                                          - type: number
                                          - type: 'null'
                                      height:
                                        anyOf:
                                          - type: number
                                          - type: 'null'
                                      type:
                                        description: Instagram video rendition type.
                                        anyOf:
                                          - type: number
                                          - type: 'null'
                                    required:
                                      - url
                                    additionalProperties: false
                                - type: 'null'
                            has_audio:
                              anyOf:
                                - type: boolean
                                - type: 'null'
                            video_dash_manifest:
                              description: MPEG-DASH playback manifest.
                              anyOf:
                                - type: string
                                - type: 'null'
                            number_of_qualities:
                              anyOf:
                                - type: number
                                - type: 'null'
                            shortcode:
                              anyOf:
                                - type: string
                                - type: 'null'
                            url:
                              description: >-
                                Story link, or the parent Highlight link for a
                                saved story.
                              anyOf:
                                - type: string
                                - type: 'null'
                            type:
                              anyOf:
                                - type: string
                                  enum:
                                    - Image
                                    - Video
                                - type: 'null'
                            owner:
                              anyOf:
                                - type: object
                                  properties:
                                    id:
                                      type: string
                                    username:
                                      anyOf:
                                        - type: string
                                        - type: 'null'
                                    full_name:
                                      anyOf:
                                        - type: string
                                        - type: 'null'
                                    profile_pic_url:
                                      anyOf:
                                        - type: string
                                        - type: 'null'
                                    is_private:
                                      anyOf:
                                        - type: boolean
                                        - type: 'null'
                                    is_verified:
                                      anyOf:
                                        - type: boolean
                                        - type: 'null'
                                    profile_pic_id:
                                      anyOf:
                                        - type: string
                                        - type: 'null'
                                    latest_reel_media:
                                      description: >-
                                        Latest story publish time as Unix
                                        seconds; zero means no recent story.
                                      anyOf:
                                        - type: number
                                        - type: 'null'
                                    is_mentionable:
                                      anyOf:
                                        - type: boolean
                                        - type: 'null'
                                  required:
                                    - id
                                  additionalProperties: false
                                - type: 'null'
                            is_edited:
                              anyOf:
                                - type: boolean
                                - type: 'null'
                            is_paid_partnership:
                              anyOf:
                                - type: boolean
                                - type: 'null'
                            mentions:
                              anyOf:
                                - type: array
                                  items:
                                    type: object
                                    properties:
                                      username:
                                        type: string
                                      full_name:
                                        anyOf:
                                          - type: string
                                          - type: 'null'
                                    required:
                                      - username
                                    additionalProperties: false
                                - type: 'null'
                            links:
                              anyOf:
                                - type: array
                                  items:
                                    type: string
                                - type: 'null'
                            shared_posts:
                              anyOf:
                                - type: array
                                  items:
                                    type: object
                                    properties:
                                      shortcode:
                                        anyOf:
                                          - type: string
                                          - type: 'null'
                                      url:
                                        anyOf:
                                          - type: string
                                          - type: 'null'
                                      product_type:
                                        anyOf:
                                          - type: string
                                          - type: 'null'
                                    additionalProperties: false
                                - type: 'null'
                            music:
                              anyOf:
                                - type: array
                                  items:
                                    type: object
                                    properties:
                                      title:
                                        anyOf:
                                          - type: string
                                          - type: 'null'
                                      artist:
                                        anyOf:
                                          - type: string
                                          - type: 'null'
                                    additionalProperties: false
                                - type: 'null'
                            timestamp:
                              description: Publish time as Unix seconds.
                              anyOf:
                                - type: number
                                - type: 'null'
                            expires_at:
                              description: Expiration time as Unix seconds.
                              anyOf:
                                - type: number
                                - type: 'null'
                            caption:
                              anyOf:
                                - type: string
                                - type: 'null'
                          required:
                            - id
                          additionalProperties: false
                    required:
                      - id
                      - url
                      - stories
                    additionalProperties: false
                required:
                  - timeMs
                  - creditsCost
                  - data
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '402':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '422':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: typescript
          label: Bridgly SDK
          source: |-
            import { Bridgly } from '@bridgly/sdk';

            const client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });

            const res = await client.instagram.getHighlight({
              highlightId: "string",
            });
            if (res.type === 'success') console.log(res.data);
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Bridgly API key (`bgly_…`). Metered endpoints deduct credits from the
        resolved account.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.