API docs by Redocly

Content Publishing Service API (1.0)

Download OpenAPI specification:Download

Content Publishing Service API

v1/asset

Upload asset files

Request Body schema: multipart/form-data
required

Asset files

files
required
Array of strings <binary> [ items <binary > ]

Responses

Response samples

Content type
application/json
{
  • "assetIds": [
    ]
}

v1/content

Create DSNP Broadcast for user

path Parameters
msaId
required
string
Example: 2

Msa Id of requested account

Request Body schema: application/json
required
required
object (NoteActivityDto)

Responses

Request samples

Content type
application/json
{
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "referenceId": "string"
}

Create DSNP Reply for user

path Parameters
msaId
required
string
Example: 2

Msa Id of requested account

Request Body schema: application/json
required
inReplyTo
required
string

Target DSNP Content URI

required
object (NoteActivityDto)

Responses

Request samples

Content type
application/json
{
  • "inReplyTo": "dsnp://78187493520/bdyqdua4t4pxgy37mdmjyqv3dejp5betyqsznimpneyujsur23yubzna",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "referenceId": "string"
}

Create DSNP Reaction for user

path Parameters
msaId
required
string
Example: 2

Msa Id of requested account

Request Body schema: application/json
required
emoji
required
string non-empty DSNP_EMOJI_REGEX

the encoded reaction emoji

apply
required
number

Indicates whether the emoji should be applied and if so, at what strength

inReplyTo
required
string

Target DSNP Content URI

Responses

Request samples

Content type
application/json
{
  • "emoji": "😀",
  • "apply": 1,
  • "inReplyTo": "dsnp://78187493520/bdyqdua4t4pxgy37mdmjyqv3dejp5betyqsznimpneyujsur23yubzna"
}

Response samples

Content type
application/json
{
  • "referenceId": "string"
}

Update DSNP Content for user

path Parameters
msaId
required
string
Example: 2

Msa Id of requested account

Request Body schema: application/json
required
targetAnnouncementType
required
string (ModifiableAnnouncementType)
Enum: "broadcast" "reply"

Target announcement type

targetContentHash
required
string

Target DSNP Content Hash

required
object (NoteActivityDto)

Responses

Request samples

Content type
application/json
{
  • "targetAnnouncementType": "broadcast",
  • "targetContentHash": "bdyqdua4t4pxgy37mdmjyqv3dejp5betyqsznimpneyujsur23yubzna",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "referenceId": "string"
}

Delete DSNP Content for user

path Parameters
msaId
required
string
Example: 2

Msa Id of requested account

Request Body schema: application/json
required
targetAnnouncementType
required
string (ModifiableAnnouncementType)
Enum: "broadcast" "reply"

Target announcement type

targetContentHash
required
string

Target DSNP Content Hash

Responses

Request samples

Content type
application/json
{
  • "targetAnnouncementType": "broadcast",
  • "targetContentHash": "bdyqdua4t4pxgy37mdmjyqv3dejp5betyqsznimpneyujsur23yubzna"
}

Response samples

Content type
application/json
{
  • "referenceId": "string"
}

health

Check the health status of the service

Responses

Check the live status of the service

Responses

Check the ready status of the service

Responses

v1/profile

Update a user's Profile

path Parameters
msaId
required
string
Example: 2

Msa Id of requested account

Request Body schema: application/json
required
required
object (ProfileActivityDto)

Responses

Request samples

Content type
application/json
{
  • "profile": {
    }
}