/v0/notes

POST

/v0/notes

• Local server

Authorizations

• bearer

Request Body

object

content

required

Note content (max 3000 characters/if attachment file exists, allow 0 character)

string

"" <= 3000 characters

Example

hello world!

visibility

required

Note visibility (PUBLIC/HOME/FOLLOWERS/DIRECT)

string

default: PUBLIC

Example

PUBLIC

attachment_file_ids

required

Attachment file IDs (max 16 files)

Array<string>

default: <= 16 items

Example

[
  "38477395",
  "38477396"
]

contents_warning_comment

required

Contents warning comment (max 256 characters)

string

"" <= 256 characters

Example

This note contains sensitive content

send_to

Send to account ID (if visibility is DIRECT)

string

""

Example

38477395

Responses

200

OK

object

id

required

Note ID

string

Example

38477395

content

required

Note content

string

Example

hello world!

visibility

required

Note visibility

string

Example

PUBLIC

contents_warning_comment

required

Contents warning comment

string

Example

This note contains sensitive content

send_to

Send to account ID

string

Example

38477395

author_id

required

Author account ID

string

Example

38477395

created_at

required

Note created date

string

Example

2021-01-01T00:00:00Z

attachment_files

required

Note Attachment Media

Array<object>

<= 16 items

object

id

required

Attachment Medium id

string

Example

39783475

name

required

Attachment filename

string

Example

image.jpg

author_id

required

Attachment author account id

string

Example

309823457

hash

required

Attachment medium blurhash

string

Example

e9f*5oin{dn

mime

required

Attachment medium mime type

string

Example

image/jpeg

nsfw

required

If true, attachment is nsfw

boolean

url

required

Attachment medium url

string format: uri

Example

https://images.example.com/image.webp

thumbnail

required

Attachment thumbnail url

string

Example

https://images.example.com/image_thumbnail.webp

400

Bad Request

object

error

required

Any of:

string

This note has too many attachments

string

Allowed values: TOO_MANY_ATTACHMENTS

string

This note has too many (CW Comments or Note content)

string

Allowed values: TOO_MANY_CONTENT

string

This note has no destination

string

Allowed values: NO_DESTINATION

string

This note has an invalid visibility

string

Allowed values: INVALID_VISIBILITY

403

You are silenced

You can’t set note visibility to PUBLIC

object

error

required

You are silenced (You cannot set visibility to public

string

Allowed values: YOU_ARE_SILENCED

404

Not Found

object

error

required

Any of:

string

Attachment not found

string

Allowed values: ATTACHMENT_NOT_FOUND

string

Account not found.

string

Allowed values: ACCOUNT_NOT_FOUND

500

Internal Server Error

Internal Error

object

error

required

Internal Error

string

Allowed values: INTERNAL_ERROR