Content Service API
  • Getting Started
    • Quickstart
  • API
    • Posts
    • Assets
    • Tags
    • Feed
Powered by GitBook
On this page
  1. API

Posts

PreviousQuickstartNextAssets

Last updated 7 months ago

Public Posts

Retrieve a list of public posts

get

Retrieves a list of public posts with optional filtering. Users can filter by tags, creation date, status (draft or published), or post type.

Query parameters
tagsstring[]optional

Filter posts by specific tags

statusstring · enumoptional

Filter posts by status

Available options:
createdAfterstring · date-timeoptional

Filter posts created after a specific date

postTypestringoptional

Filter posts by a specific type from the predefined list

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/posts'
200
[
  {
    "postId": "550e8400-e29b-41d4-a716-446655440000",
    "title": "My First Post",
    "description": "This is the content of my first post.",
    "tags": [
      "example",
      "firstPost"
    ],
    "postType": "blog",
    "accessType": "PUBLIC",
    "status": "DRAFT",
    "created_at": "2025-04-03T05:31:18.500Z",
    "updated_at": "2025-04-03T05:31:18.500Z",
    "deleted_at": "2025-04-03T05:31:18.500Z"
  }
]

A list of posts

Retrieve a public post by ID

get

Retrieves the details of a public post by its unique identifier.

Path parameters
idstringrequired
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/posts/{id}'
200
404
{
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My First Post",
  "description": "This is the content of my first post.",
  "tags": [
    "example",
    "firstPost"
  ],
  "postType": "blog",
  "accessType": "PUBLIC",
  "status": "DRAFT",
  "created_at": "2025-04-03T05:31:18.500Z",
  "updated_at": "2025-04-03T05:31:18.500Z",
  "deleted_at": "2025-04-03T05:31:18.500Z"
}

Post found

Delete a public post by ID

delete

Deletes a public post by its ID. This action is irreversible.

Path parameters
idstringrequired
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/posts/{id}'
204
404
No body

No Content - Post successfully deleted

Retrieve a list of private posts

get

Retrieves a list of private posts with optional filtering. Users can filter by tags, creation date, status (draft or published), or post type.

Query parameters
tagsstring[]optional

Filter posts by specific tags

statusstring · enumoptional

Filter posts by status

Available options:
createdAfterstring · date-timeoptional

Filter posts created after a specific date

postTypestringoptional

Filter posts by a specific type from the predefined list

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/private/posts'
200
[
  {
    "postId": "550e8400-e29b-41d4-a716-446655440000",
    "title": "My First Post",
    "description": "This is the content of my first post.",
    "tags": [
      "example",
      "firstPost"
    ],
    "postType": "blog",
    "accessType": "PUBLIC",
    "status": "DRAFT",
    "created_at": "2025-04-03T05:31:18.500Z",
    "updated_at": "2025-04-03T05:31:18.500Z",
    "deleted_at": "2025-04-03T05:31:18.500Z"
  }
]

A list of private posts

Retrieve a private post by ID

get

Retrieves the details of a private post by its unique identifier.

Path parameters
idstringrequired
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/private/posts/{id}'
200
404
{
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My First Post",
  "description": "This is the content of my first post.",
  "tags": [
    "example",
    "firstPost"
  ],
  "postType": "blog",
  "accessType": "PUBLIC",
  "status": "DRAFT",
  "created_at": "2025-04-03T05:31:18.500Z",
  "updated_at": "2025-04-03T05:31:18.500Z",
  "deleted_at": "2025-04-03T05:31:18.500Z"
}

Post found

Delete a private post by ID

delete

Deletes a private post by its ID. This action is irreversible.

Path parameters
idstringrequired
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/private/posts/{id}'
204
404
No body

No Content - Post successfully deleted

  • Public Posts
  • POSTCreate a new public post
  • GETRetrieve a list of public posts
  • GETRetrieve a public post by ID
  • PUTUpdate an existing public post
  • DELETEDelete a public post by ID
  • POSTCreate a new private post
  • GETRetrieve a list of private posts
  • GETRetrieve a private post by ID
  • PUTUpdate an existing private post
  • DELETEDelete a private post by ID

Create a new public post

post

Each post begins as a draft. A user can only have one active draft at a time. If a draft already exists, it must be published or deleted before a new one can be created.

Body
titlestringoptional
Example: My First Post
descriptionstringoptional
Example: This is the content of my first post.
tagsstring[]optional
Example: ["example","firstPost"]
postTypestringoptional
Example: blog
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/posts' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "My First Post",
    "description": "This is the content of my first post.",
    "tags": [
      "example",
      "firstPost"
    ],
    "postType": "blog"
  }'
201
409
{
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My First Post",
  "description": "This is the content of my first post.",
  "tags": [
    "example",
    "firstPost"
  ],
  "postType": "blog",
  "accessType": "PUBLIC",
  "status": "DRAFT",
  "created_at": "2025-04-03T05:31:18.500Z",
  "updated_at": "2025-04-03T05:31:18.500Z",
  "deleted_at": "2025-04-03T05:31:18.500Z"
}

Created

Update an existing public post

put

Updates the title, content, tags, or post type of an existing public post.

Path parameters
idstringrequired
Body
titlestringoptional
Example: Updated Title
descriptionstringoptional
Example: Updated content of the post.
tagsstring[]optional
Example: ["updated","post"]
postTypestringoptional
Example: news
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url '/posts/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Updated Title",
    "description": "Updated content of the post.",
    "tags": [
      "updated",
      "post"
    ],
    "postType": "news"
  }'
200
404
{
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My First Post",
  "description": "This is the content of my first post.",
  "tags": [
    "example",
    "firstPost"
  ],
  "postType": "blog",
  "accessType": "PUBLIC",
  "status": "DRAFT",
  "created_at": "2025-04-03T05:31:18.500Z",
  "updated_at": "2025-04-03T05:31:18.500Z",
  "deleted_at": "2025-04-03T05:31:18.500Z"
}

Updated successfully

Create a new private post

post

Identical to creating a public post, but this post is private.

Body
titlestringoptional
Example: My First Private Post
descriptionstringoptional
Example: This is the content of my first private post.
tagsstring[]optional
Example: ["example","privatePost"]
postTypestringoptional
Example: privateBlog
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/private/posts' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "My First Private Post",
    "description": "This is the content of my first private post.",
    "tags": [
      "example",
      "privatePost"
    ],
    "postType": "privateBlog"
  }'
201
409
{
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My First Post",
  "description": "This is the content of my first post.",
  "tags": [
    "example",
    "firstPost"
  ],
  "postType": "blog",
  "accessType": "PUBLIC",
  "status": "DRAFT",
  "created_at": "2025-04-03T05:31:18.500Z",
  "updated_at": "2025-04-03T05:31:18.500Z",
  "deleted_at": "2025-04-03T05:31:18.500Z"
}

Created

Update an existing private post

put

Updates the title, content, tags, or post type of an existing private post.

Path parameters
idstringrequired
Body
titlestringoptional
Example: Updated Private Title
descriptionstringoptional
Example: Updated content of the private post.
tagsstring[]optional
Example: ["updated","privatePost"]
postTypestringoptional
Example: privateNews
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url '/private/posts/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Updated Private Title",
    "description": "Updated content of the private post.",
    "tags": [
      "updated",
      "privatePost"
    ],
    "postType": "privateNews"
  }'
200
404
{
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My First Post",
  "description": "This is the content of my first post.",
  "tags": [
    "example",
    "firstPost"
  ],
  "postType": "blog",
  "accessType": "PUBLIC",
  "status": "DRAFT",
  "created_at": "2025-04-03T05:31:18.500Z",
  "updated_at": "2025-04-03T05:31:18.500Z",
  "deleted_at": "2025-04-03T05:31:18.500Z"
}

Updated successfully