Skip to content

getCapture

GET
/captures/{captureId}
curl --request GET \
  --url http://localhost:8080/api/v1/captures/per_01j9x3k8m2q4r5s6t7v8w9y0z1 \
  --cookie hs_session=<hs_session>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
captureId
required
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

Responses

Section titled “Responses”

200

Section titled “200”

Capture status and results.

Media typeapplication/json
object
id
required
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/
platform
required
string
Allowed values: instagram facebook line wechat bluesky x douyin xiaohongshu truthsocial
person
One of:
object
id
required
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/
displayName
required
string
relationLabel
string | null
kind
required
string
Allowed values: family friend creator other
closeness
required

1 = closest. Weights the feed and hearth picks.

integer
>= 1 <= 3
avatar
One of:
object
id
required
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/
url
required

Signed URL, valid 24 h.

string
thumbUrl
string
cardUrl
string
posterUrl
string
mime
required
string
width
integer
height
integer
durationMs
integer
blurhash
string
alt
string
member
One of:
object
id
required
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/
displayName
required
string
avatar
One of:
object
id
required
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/
url
required

Signed URL, valid 24 h.

string
thumbUrl
string
cardUrl
string
posterUrl
string
mime
required
string
width
integer
height
integer
durationMs
integer
blurhash
string
alt
string
mode
required
string
Allowed values: passive update
runId
One of:
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/
status
required
string
Allowed values: uploading queued processing done failed skipped
pageState
string | null
Allowed values: ok login_wall not_found blocked empty unrelated
detailKey
string | null
receivedAt
required
string format: date-time
assetsTotal
required
integer
assetsMissing
required
integer
newMoments
required
integer
duplicates
required
integer
model
string | null

Examples

Exampleseed

Derived from fixtures/seed.json.

{
  "assetsMissing": 1,
  "assetsTotal": 9,
  "detailKey": null,
  "duplicates": 0,
  "id": "cap_01j9gphaxv8vvfby5wwrgqzve0",
  "member": {
    "avatar": null,
    "displayName": "Mali",
    "id": "mem_01j9kt0d8rwgmhnmxkmv0frnr0"
  },
  "mode": "passive",
  "model": "xiaomi/mimo-v2.6-pro",
  "newMoments": 3,
  "pageState": "ok",
  "person": {
    "avatar": null,
    "closeness": 1,
    "displayName": "Mom",
    "id": "per_01j9wst6a8vjc69r66y6fj70t5",
    "kind": "family",
    "relationLabel": "แม่"
  },
  "platform": "instagram",
  "receivedAt": "2026-10-17T08:40:00.000Z",
  "runId": null,
  "status": "done"
}

404

Section titled “404”

Not found.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
code
required
string
i18nKey
string
detail
string
fields
Array<object>
object
path
required
string
code
required
string
i18nKey
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "i18nKey": "example",
  "detail": "example",
  "fields": [
    {
      "path": "example",
      "code": "example",
      "i18nKey": "example"
    }
  ]
}