Assets

Attach an image asset to a post

Attaches an image asset to a post. The service determines under the hood whether the asset is attached to a public or private post based on the post type.

POST/assets/attach-image

Body

multipart/form-data

postIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

imageFilestring (binary)

The image file to attach

Response

200404

Image asset successfully attached

Body

application/json

assetIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

postIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

assetTypeenum

IMAGEVIDEO

urlstring

Example: "https://cdn.example.com/assets/image.jpg"

orderIndexinteger

Example: 1

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/assets/attach-image', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "assetId": "550e8400-e29b-41d4-a716-446655440000",
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "assetType": "IMAGE",
  "url": "https://cdn.example.com/assets/image.jpg",
  "orderIndex": 1,
  "created_at": "2024-12-22T22:19:26.478Z",
  "updated_at": "2024-12-22T22:19:26.478Z"
}

Attach a video asset to a post

Attaches a video asset to a post. The service determines under the hood whether the asset is attached to a public or private post based on the post type.

POST/assets/attach-video

Body

multipart/form-data

postIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

videoFilestring (binary)

The video file to attach

Response

200404

Video asset successfully attached

Body

application/json

assetIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

postIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

assetTypeenum

IMAGEVIDEO

urlstring

Example: "https://cdn.example.com/assets/image.jpg"

orderIndexinteger

Example: 1

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/assets/attach-video', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "assetId": "550e8400-e29b-41d4-a716-446655440000",
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "assetType": "IMAGE",
  "url": "https://cdn.example.com/assets/image.jpg",
  "orderIndex": 1,
  "created_at": "2024-12-22T22:19:26.478Z",
  "updated_at": "2024-12-22T22:19:26.478Z"
}

Rearrange the order of assets

Rearranges the order of assets attached to a post by taking an ordered array of asset IDs and updating the orderIndex property of each asset accordingly.

POST/assets/rearrange

Body

application/json

assetOrderarray of string (uuid)

An ordered array of asset IDs

Response

200404

Assets successfully rearranged

Request

JavaScriptCurlPython

const response = await fetch('/assets/rearrange', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete an asset by ID

Deletes an asset associated with a post. The service handles the underlying logic to ensure proper deletion based on whether the asset belongs to a public or private post.

DELETE/assets/{assetId}

Path parameters

assetId*string (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

Response

204404

No Content - Asset successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('/assets/{assetId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();