# Instagram Highlight Detail (`instagram.highlight_detail`)

Every story item of one Instagram highlight by id: photo and video URLs, sizes, durations and timestamps.

Docs: https://primaryapi.com/docs/api-reference/instagram/highlight_detail

- Endpoint: `POST https://api.primaryapi.com/v1/run/instagram.highlight_detail`
- Category: Social · Platform: `instagram` · Kind: lookup · Status: live
- Price: 1 credit per call; up to 3 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=instagram.highlight_detail`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `id` | string | yes |  | pattern: ^(highlight:)?\d{5,25}$ | Highlight id, with or without the "highlight:" prefix, for example "18067016518767507" (from instagram.user_highlights). |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `id` | string | Highlight id (digits, without the highlight: prefix) |
| `title` | string \| null |  |
| `ownerHandle` | string \| null |  |
| `ownerId` | string \| null |  |
| `avatarUrl` | string \| null |  |
| `coverUrl` | string \| null |  |
| `createdUtc` | integer \| null |  |
| `mediaCount` | integer \| null |  |
| `items` | object[] |  |
| `items[].id` | string |  |
| `items[].code` | string \| null |  |
| `items[].mediaType` | integer \| null | 1 = photo, 2 = video |
| `items[].productType` | string \| null |  |
| `items[].createdUtc` | integer \| null |  |
| `items[].durationSeconds` | number \| null |  |
| `items[].hasAudio` | boolean \| null |  |
| `items[].width` | integer \| null |  |
| `items[].height` | integer \| null |  |
| `items[].image` | string \| null | Image or video cover URL (temporary CDN link) |
| `items[].videoUrl` | string \| null | Video file URL (temporary CDN link) |
| `items[].paidPartnership` | boolean \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/instagram.highlight_detail" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"18067016518767507"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "id": "18067016518767507",
      "title": "string",
      "ownerHandle": "string",
      "ownerId": "string",
      "avatarUrl": "https://example.com",
      "coverUrl": "https://example.com",
      "createdUtc": 0,
      "mediaCount": 0,
      "items": [
        {
          "id": "18067016518767507",
          "code": "string",
          "mediaType": 0,
          "productType": "string",
          "createdUtc": 0,
          "durationSeconds": 0,
          "hasAudio": true,
          "width": 0,
          "height": 0,
          "image": "string",
          "videoUrl": "https://example.com",
          "paidPartnership": true
        }
      ]
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: up to 3 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=instagram.highlight_detail`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

All items of the highlight in one response; media URLs are temporary CDN links.

