> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). The sections below mirror the orientation block in [`/llms.txt`](https://www.socialfetch.dev/llms.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need a structured operation inventory. The catalog covers documented operations with on-site reference pages.

## This page

- **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/instagram/highlights/highlightid/get](https://www.socialfetch.dev/docs/api/v1/instagram/highlights/highlightid/get)
- **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/instagram/highlights/highlightid/get.mdx](https://www.socialfetch.dev/docs/api/v1/instagram/highlights/highlightid/get.mdx)

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json)

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users.
- [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).

---
# Get Instagram highlight (https://www.socialfetch.dev/docs/api/v1/instagram/highlights/highlightid/get)

## Summary

Get stories from a saved Instagram highlight.

**Tags:** `Instagram`

## HTTP

- **Method:** GET
- **Path:** `/v1/instagram/highlights/{highlightId}`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.instagram.getHighlight({ highlightId })`
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Normalization failure (502):** 1 credit charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `highlightId` (path)

- **Required:** yes
- **Constraints:** type `string`; pattern: `^\d+$`
- **Description:** Numeric Instagram highlight id from a highlight URL.

## Responses (status codes)

- **200**: Highlight details (found or not found in body).
- **400**: Invalid highlight id
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data).
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Highlight details (found or not found in body).

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the highlight was resolved: found when metadata and story items are available, or not_found when the highlight does not exist or cannot be accessed.
  - **highlight** (required) — type `object`; nullable. Highlight metadata when found.
    - **id** (required) — type `string`; minLength: 1. Instagram highlight id.
    - **title** (required) — type `string`; nullable. Highlight title when available.
    - **createdAt** (required) — type `integer`; nullable. Unix timestamp when the highlight was created, when available.
    - **latestItemAt** (required) — type `integer`; nullable. Unix timestamp of the latest story item in the highlight, when available.
    - **mediaCount** (required) — type `integer`; minimum: 0; nullable. Number of story items reported for the highlight.
    - **cover** (required) — type `object`; nullable. Highlight cover image when available.
      - **mediaId** (optional) — type `string`. Instagram media id for the cover.
      - **url** (optional) — type `string`; nullable. Cover image URL.
      - **width** (optional) — type `integer`; minimum: 0; nullable. Cover image width in pixels when available.
      - **height** (optional) — type `integer`; minimum: 0; nullable. Cover image height in pixels when available.
    - **owner** (required) — type `object`; nullable. Highlight owner when available.
      - **platformUserId** (optional) — type `string`. Instagram numeric user id.
      - **handle** (optional) — type `string`; minLength: 1. Instagram username without a leading @.
      - **fullName** (optional) — type `string`; nullable. Display name when available.
      - **verified** (optional) — type `boolean`. Whether the account is verified.
      - **avatarUrl** (optional) — type `string`; nullable. Profile picture URL when available.
      - **privateAccount** (optional) — type `boolean`. Whether the account is private when known.
  - **items** (required) — type `array`. Story items in the highlight when found. Empty when `lookupStatus` is `not_found`.
    - _items:_
      - **id** (required) — type `string`; minLength: 1. Instagram story item id.
      - **mediaId** (optional) — type `string`. Instagram media id when distinct from the item id.
      - **mediaType** (required) — type `string`; enum: image, video, unknown. Normalized story media type.
      - **takenAt** (required) — type `integer`; nullable. Unix timestamp when the story item was taken, when available.
      - **displayUrl** (optional) — type `string`; nullable. Primary image URL when available.
      - **thumbnailUrl** (optional) — type `string`; nullable. Thumbnail image URL when available.
      - **videoUrl** (optional) — type `string`; nullable. Direct video URL when available.
      - **videoDurationSec** (optional) — type `number`; minimum: 0; nullable. Video duration in seconds when available.
      - **hasAudio** (optional) — type `boolean`; nullable. Whether the video item has audio when known.
      - **dimensions** (optional) — type `object`. Story media dimensions when available.
        - **width** (required) — type `integer`; minimum: 0. Media width in pixels.
        - **height** (required) — type `integer`; minimum: 0. Media height in pixels.
      - **linkStickers** (optional) — type `array`. Link stickers attached to the story item when available.
        - _items:_
          - **url** (optional) — type `string`; minLength: 1. Link destination URL.
          - **displayUrl** (optional) — type `string`; minLength: 1. Human-readable link label when available.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "highlight": {
      "id": "17929440964811872",
      "title": "Operation Chad",
      "createdAt": 1754706822,
      "latestItemAt": 1754706822,
      "mediaCount": 1,
      "cover": {
        "mediaId": "3574665805209826888_21393171",
        "url": "https://example.com/highlight-cover.jpg",
        "width": 150,
        "height": 150
      },
      "owner": {
        "platformUserId": "2278169415",
        "handle": "mrbeast",
        "fullName": "MrBeast",
        "verified": true,
        "avatarUrl": "https://example.com/avatar.jpg",
        "privateAccount": false
      }
    },
    "items": [
      {
        "id": "3565907942018983442_21393171",
        "mediaId": "3565907942018983442",
        "mediaType": "video",
        "takenAt": 1739309361,
        "displayUrl": "https://example.com/story-video-cover.jpg",
        "thumbnailUrl": "https://example.com/story-video-cover.jpg",
        "videoUrl": "https://example.com/story-video.mp4",
        "videoDurationSec": 55.85,
        "hasAudio": true,
        "dimensions": {
          "width": 1080,
          "height": 1920
        },
        "linkStickers": [
          {
            "url": "https://example.com",
            "displayUrl": "example.com"
          }
        ]
      },
      {
        "id": "3574665805209826888_21393171",
        "mediaId": "3574665805209826888",
        "mediaType": "image",
        "takenAt": 1745272279,
        "displayUrl": "https://example.com/story-image.jpg",
        "thumbnailUrl": "https://example.com/story-image.jpg",
        "dimensions": {
          "width": 1080,
          "height": 1920
        }
      }
    ]
  },
  "meta": {
    "requestId": "req_01example_highlight",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Example JSON (not_found)

```json
{
  "data": {
    "lookupStatus": "not_found",
    "highlight": null,
    "items": []
  },
  "meta": {
    "requestId": "req_01example_highlight_not_found",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid highlight id **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data). **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.instagram.getHighlight({
  highlightId: "17929440964811872",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/instagram/highlights/17929440964811872",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY",
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/instagram/highlights/17929440964811872" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/instagram/highlights/17929440964811872",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```