ingestMoments

POST

/ingest

curl --request POST \
  --url http://localhost:8080/api/v1/ingest \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --cookie hs_session=<hs_session> \
  --data '{ "account": { "id": "per_01j9x3k8m2q4r5s6t7v8w9y0z1" }, "taskId": "per_01j9x3k8m2q4r5s6t7v8w9y0z1", "items": [ { "platformItemId": "example", "kind": "story", "text": "example", "lang": "example", "url": "https://example.com", "publishedAt": "2026-04-15T12:00:00Z", "expiresAt": "2026-04-15T12:00:00Z", "media": [ { "mediaId": "per_01j9x3k8m2q4r5s6t7v8w9y0z1", "url": "https://example.com", "mime": "example", "width": 1, "height": 1, "durationMs": 1, "posterMediaId": "per_01j9x3k8m2q4r5s6t7v8w9y0z1", "posterUrl": "https://example.com", "alt": "example" } ] } ] }'

• Your Homestead (default port; replace with your address)

Authorizations

• cookieAuth
• bearerAuth

Parameters

Header Parameters

Idempotency-Key

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

account

required

One of:

object

object

id

required

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

object

object

platform

required

string

Allowed values: instagram facebook line wechat bluesky x douyin xiaohongshu truthsocial

handle

required

string

taskId

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

items

required

Array<object>

<= 100 items

object

platformItemId

required

string

>= 1 characters <= 200 characters

kind

required

string

Allowed values: story post video link text

text

Plain text. HTML is stripped.

string

<= 5000 characters

lang

string

<= 20 characters

url

required

string format: uri

publishedAt

required

string format: date-time

expiresAt

string format: date-time

media

Array<object>

<= 20 items

One of:

object

Give either mediaId (uploaded first) or url (platform CDN host on the allow-list).

object

mediaId

required

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

url

string format: uri

mime

string

width

integer

height

integer

durationMs

integer

posterMediaId

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

posterUrl

string format: uri

alt

string

<= 1000 characters

object

Give either mediaId (uploaded first) or url (platform CDN host on the allow-list).

object

mediaId

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

url

required

string format: uri

mime

string

width

integer

height

integer

durationMs

integer

posterMediaId

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

posterUrl

string format: uri

alt

string

<= 1000 characters

Responses

200

Per-item results. Valid items are stored even if some are rejected.

Media typeapplication/json

object

batchId

required

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

accepted

required

integer

duplicates

required

integer

rejected

required

Array<object>

object

index

required

integer

code

required

string

Allowed values: invalid_kind invalid_url media_host_not_allowed media_fetch_failed too_old text_too_long

momentIds

required

Array<string>

Examples

Exampleseed

Derived from fixtures/seed.json.

{
  "accepted": 2,
  "batchId": "bat_01j9a1b2c3d4e5f6g7h8j9k02g",
  "duplicates": 1,
  "momentIds": [
    "mom_01j9adj9t141gzfk8s7x1yyg4j",
    "mom_01j991j97j1nk24fm0mgptj50b"
  ],
  "rejected": [
    {
      "code": "media_host_not_allowed",
      "index": 2
    }
  ]
}

400

Invalid request.

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"
    }
  ]
}

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"
    }
  ]
}

409

Conflicts with current state.

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"
    }
  ]
}