Emumet REST API (v1)

Download OpenAPI specification:Download

account

Get all your accounts

Authorizations:

BearerAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 5
cursor	string (Common.Types.Nanoid) Example: cursor=V1StGXR8_Z5jdHi6B-myT https://github.com/ai/nanoid
direction	string Default: "next" Enum: "next" "prev" Direction of the cursor

Responses

Response samples

200

Content type

application/json

{"first": "V1StGXR8_Z5jdHi6B-myT",
"last": "V1StGXR8_Z5jdHi6B-myT",
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"publicKey": "string",
"is_bot": true,
"created_at": "string"
}
]
}

Create a new account

Authorizations:

BearerAuth

Request Body schema: application/json
required

name required	string
is_bot required	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"is_bot": true
}

Response samples

200

Content type

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get an account

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"publicKey": "string",
"is_bot": true,
"created_at": "string"
}

Delete an account

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

Responses

Block_get

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

query Parameters

limit	integer [ 1 .. 100 ] Default: 30
cursor	string (Common.Types.Nanoid) Example: cursor=V1StGXR8_Z5jdHi6B-myT https://github.com/ai/nanoid
direction	string Default: "next" Enum: "next" "prev" Direction of the cursor

Responses

Response samples

200

Content type

application/json

{"first": "V1StGXR8_Z5jdHi6B-myT",
"last": "V1StGXR8_Z5jdHi6B-myT",
"items": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Block_post

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

Request Body schema: application/json
required

target

required

string <uuid> (API.AccountAPI.AccountId)

Responses

Request samples

Payload

Content type

application/json

{"target": "65a17d54-9c67-4477-8b80-d3f97e165aa5"
}

Block_delete

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

Request Body schema: application/json
required

target

required

string <uuid> (API.AccountAPI.AccountId)

Responses

Request samples

Payload

Content type

application/json

{"target": "65a17d54-9c67-4477-8b80-d3f97e165aa5"
}

Get followers

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

query Parameters

limit	integer [ 1 .. 100 ] Default: 30
cursor	string (Common.Types.Nanoid) Example: cursor=V1StGXR8_Z5jdHi6B-myT https://github.com/ai/nanoid
direction	string Default: "next" Enum: "next" "prev" Direction of the cursor

Responses

Response samples

200

Content type

application/json

{"first": "V1StGXR8_Z5jdHi6B-myT",
"last": "V1StGXR8_Z5jdHi6B-myT",
"items": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Get follows

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

query Parameters

limit	integer [ 1 .. 100 ] Default: 30
cursor	string (Common.Types.Nanoid) Example: cursor=V1StGXR8_Z5jdHi6B-myT https://github.com/ai/nanoid
direction	string Default: "next" Enum: "next" "prev" Direction of the cursor

Responses

Response samples

200

Content type

application/json

{"first": "V1StGXR8_Z5jdHi6B-myT",
"last": "V1StGXR8_Z5jdHi6B-myT",
"items": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Mute_get

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

query Parameters

limit	integer [ 1 .. 100 ] Default: 30
cursor	string (Common.Types.Nanoid) Example: cursor=V1StGXR8_Z5jdHi6B-myT https://github.com/ai/nanoid
direction	string Default: "next" Enum: "next" "prev" Direction of the cursor

Responses

Response samples

200

Content type

application/json

{"first": "V1StGXR8_Z5jdHi6B-myT",
"last": "V1StGXR8_Z5jdHi6B-myT",
"items": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Mute_post

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

Request Body schema: application/json
required

target

required

string <uuid> (API.AccountAPI.AccountId)

Responses

Request samples

Payload

Content type

application/json

{"target": "65a17d54-9c67-4477-8b80-d3f97e165aa5"
}

Mute_delete

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

Request Body schema: application/json
required

target

required

string <uuid> (API.AccountAPI.AccountId)

Responses

Request samples

Payload

Content type

application/json

{"target": "65a17d54-9c67-4477-8b80-d3f97e165aa5"
}

admin

Get all of accounts in this service

Authorizations:

BearerAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 30
cursor	string (Common.Types.Nanoid) Example: cursor=V1StGXR8_Z5jdHi6B-myT https://github.com/ai/nanoid
direction	string Default: "next" Enum: "next" "prev" Direction of the cursor

Responses

Response samples

200

Content type

application/json

{"first": "V1StGXR8_Z5jdHi6B-myT",
"last": "V1StGXR8_Z5jdHi6B-myT",
"items": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Suspend_get

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

query Parameters

limit	integer [ 1 .. 100 ] Default: 30
cursor	string (Common.Types.Nanoid) Example: cursor=V1StGXR8_Z5jdHi6B-myT https://github.com/ai/nanoid
direction	string Default: "next" Enum: "next" "prev" Direction of the cursor

Responses

Response samples

200

Content type

application/json

{"first": "V1StGXR8_Z5jdHi6B-myT",
"last": "V1StGXR8_Z5jdHi6B-myT",
"items": [{"comment": "string",
"moderated_by": "b5ff5733-153d-4f92-92d8-027f60e34e2a",
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Suspend_post

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

Request Body schema: application/json
required

comment

required

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

Suspend_delete

Unsuspend account

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

Responses

Block_get

Authorizations:

BearerAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 30
cursor	string (Common.Types.Nanoid) Example: cursor=V1StGXR8_Z5jdHi6B-myT https://github.com/ai/nanoid
direction	string Default: "next" Enum: "next" "prev" Direction of the cursor

Responses

Response samples

200

Content type

application/json

{"host": {"first": "V1StGXR8_Z5jdHi6B-myT",
"last": "V1StGXR8_Z5jdHi6B-myT",
"items": [{"comment": "string",
"host": "http://example.com",
"moderated_by": "b5ff5733-153d-4f92-92d8-027f60e34e2a",
"created_at": "2019-08-24T14:15:22Z"
}
]
}
}

Block_post

Authorizations:

BearerAuth

Request Body schema: application/json
required

required

object (API.AdminAPI.Stellar.StellarBlockRequest)

comment required	string
host required	string <uri>

Responses

Request samples

Payload

Content type

application/json

{"host": {"comment": "string",
"host": "http://example.com"
}
}

Block_delete

Authorizations:

BearerAuth

Request Body schema: application/json
required

host

required

string <uri>

Responses

Request samples

Payload

Content type

application/json

{"host": "http://example.com"
}

Operators_get

Authorizations:

BearerAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 30
cursor	string (Common.Types.Nanoid) Example: cursor=V1StGXR8_Z5jdHi6B-myT https://github.com/ai/nanoid
direction	string Default: "next" Enum: "next" "prev" Direction of the cursor
target_role	string (API.AdminAPI.Stellar.Operators.RoleName)

Responses

Response samples

200

Content type

application/json

{"first": "V1StGXR8_Z5jdHi6B-myT",
"last": "V1StGXR8_Z5jdHi6B-myT",
"items": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Operator_get

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.StellarAPI.StellarId)

Responses

Response samples

200

Content type

application/json

{"role": "string"
}

Operator_post

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.StellarAPI.StellarId)

Request Body schema: application/json
required

role

required

string (API.AdminAPI.Stellar.Operators.RoleName)

Responses

Request samples

Payload

Content type

application/json

{"role": "string"
}

Operator_delete

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.StellarAPI.StellarId)

Responses

stellar

Accounts_get

Authorizations:

BearerAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 30
cursor	string (Common.Types.Nanoid) Example: cursor=V1StGXR8_Z5jdHi6B-myT https://github.com/ai/nanoid
direction	string Default: "next" Enum: "next" "prev" Direction of the cursor

Responses

Response samples

200

Content type

application/json

{"first": "V1StGXR8_Z5jdHi6B-myT",
"last": "V1StGXR8_Z5jdHi6B-myT",
"items": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Accounts_getAccount

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.StellarAPI.StellarId)

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"host_id": "eb4e20fc-2b4a-4d0c-811f-48abcf12b89b"
}

Hosts_get

Authorizations:

BearerAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 30
cursor	string (Common.Types.Nanoid) Example: cursor=V1StGXR8_Z5jdHi6B-myT https://github.com/ai/nanoid
direction	string Default: "next" Enum: "next" "prev" Direction of the cursor

Responses

Response samples

200

Content type

application/json

{"first": "V1StGXR8_Z5jdHi6B-myT",
"last": "V1StGXR8_Z5jdHi6B-myT",
"items": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Hosts_getHost

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.StellarAPI.HostId)

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "http://example.com"
}

follow_request

Get follow requests

Authorizations:

BearerAuth

path Parameters

account_id

required

string <uuid> (API.AccountAPI.AccountId)

query Parameters

limit	integer [ 1 .. 100 ] Default: 30
cursor	string (Common.Types.Nanoid) Example: cursor=V1StGXR8_Z5jdHi6B-myT https://github.com/ai/nanoid
direction	string Default: "next" Enum: "next" "prev" Direction of the cursor

Responses

Response samples

200

Content type

application/json

{"first": "V1StGXR8_Z5jdHi6B-myT",
"last": "V1StGXR8_Z5jdHi6B-myT",
"items": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Follow(request or accept) user

Authorizations:

BearerAuth

path Parameters

account_id required	string <uuid> (API.AccountAPI.AccountId)
target_id required	string <uuid> (API.AccountAPI.AccountId)

Responses

Unfollow(or reject) user

Authorizations:

BearerAuth

path Parameters

account_id required	string <uuid> (API.AccountAPI.AccountId)
target_id required	string <uuid> (API.AccountAPI.AccountId)

Responses

metadata

Get all metadatas

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

Responses

Response samples

200

Content type

application/json

[{"id": "V1StGXR8_Z5jdHi6B-myT",
"name": "string",
"description": "string"
}
]

Create a new metadata

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

Request Body schema: application/json
required

name required	string
description required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200

Content type

application/json

"V1StGXR8_Z5jdHi6B-myT"

Update a metadata

Authorizations:

BearerAuth

path Parameters

id

required

string (API.MetadataAPI.MetadataId)

Example: V1StGXR8_Z5jdHi6B-myT

https://github.com/ai/nanoid

Request Body schema: application/json
required

name	string
description	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Delete a metadata

Authorizations:

BearerAuth

path Parameters

id

required

string (API.MetadataAPI.MetadataId)

Example: V1StGXR8_Z5jdHi6B-myT

https://github.com/ai/nanoid

Responses

profile

Get a profile

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

Responses

Response samples

200

Content type

application/json

{"display_name": "string",
"summary": "string",
"icon": "http://example.com",
"banner": "http://example.com"
}

Create a profile

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

Request Body schema: multipart/form-data
required

display_name required	string
summary required	string
icon required	string <binary>
banner required	string <binary>

Responses

Update a profile

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (API.AccountAPI.AccountId)

Request Body schema: multipart/form-data
required

display_name	string
summary	string
icon	string <binary>
banner	string <binary>

Responses

user

Get a user from id

path Parameters

id

required

string <uuid> (UserAPI.UserId)

Responses

Response samples

200

Content type

application/activity+json; charset=utf-8

{"@context": ["http://schema.org/url"
],
"id": "http://example.com",
"type": "Person",
"preferredUsername": "string",
"inbox": "http://example.com",
"outbox": "http://example.com",
"followers": "http://example.com",
"following": "http://example.com",
"featured": "http://example.com",
"summary": "string",
"sharedInbox": "http://example.com",
"endpoints": {"sharedInbox": "http://example.com"
},
"manuallyApprovesFollowers": true,
"discoverable": true,
"publicKey": {"id": "http://example.com",
"type": "Key",
"owner": "http://example.com",
"publicKeyPem": "string"
},
"attachment": [{"type": "PropertyValue",
"name": "string",
"value": "string"
}
],
"image": {"type": "Image",
"url": "http://example.com",
"mediaType": "image/png",
"sensitive": false,
"name": "string"
},
"icon": {"type": "Image",
"url": "http://example.com",
"mediaType": "image/png",
"sensitive": false,
"name": "string"
}
}

Inbox_get

Returns received activities

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid> (UserAPI.UserId)

query Parameters

page	boolean
since_id	string
until_id	string

Responses

Response samples

200

Content type

application/activity+json; charset=utf-8

Example

Common.ActivityStreams.OrderedCollection

{"@context": ["http://schema.org/url"
],
"totalItems": 0,
"first": "http://example.com",
"last": "http://example.com",
"type": "OrderedCollection",
"id": "http://example.com"
}

Inbox_post

path Parameters

id

required

string <uuid> (UserAPI.UserId)

header Parameters

signature required	string
authorization	string

Request Body schema: application/json
required

Any of

type required	string
id required	string <uri>
required	(Array of Common.Types.IRI (string) or objects) or Common.Types.IRI (string) or object

Responses

Request samples

Payload

Content type

application/json

Example

{"type": "string",
"id": "http://example.com",
"@context": ["http://schema.org/url"
]
}

Outbox_get

Returns actor activities

path Parameters

id

required

string <uuid> (UserAPI.UserId)

query Parameters

page	boolean
since_id	string
until_id	string

Responses

Response samples

200

Content type

application/activity+json; charset=utf-8

Example

Common.ActivityStreams.OrderedCollection

{"@context": ["http://schema.org/url"
],
"totalItems": 0,
"first": "http://example.com",
"last": "http://example.com",
"type": "OrderedCollection",
"id": "http://example.com"
}

Outbox_post

path Parameters

id

required

string <uuid> (UserAPI.UserId)

header Parameters

signature required	string
authorization	string

Request Body schema: application/json
required

Any of

type required	string
id required	string <uri>
required	(Array of Common.Types.IRI (string) or objects) or Common.Types.IRI (string) or object

Responses

Request samples

Payload

Content type

application/json

Example

{"type": "string",
"id": "http://example.com",
"@context": ["http://schema.org/url"
]
}

webfinger

Webfinger_get

The WebFinger query

query Parameters

required

string or string

The resource to query

Responses

Response samples

200

Content type

application/jrd+json; charset=utf-8

{"subject": "acct:example@example.com",
"links": [{"rel": "self",
"type": "application/activity+json",
"href": "https://example.com/actor"
}
]
}

Emumet REST API (v1)

account

Get all your accounts

Authorizations:

query Parameters

Responses

Response samples

Create a new account

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get an account

Authorizations:

path Parameters

Responses

Response samples

Delete an account

Authorizations:

path Parameters

Responses

Block_get

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Block_post

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Block_delete

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Get followers

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Get follows

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Mute_get

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Mute_post

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Mute_delete

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

admin

Get all of accounts in this service

Authorizations:

query Parameters

Responses

Response samples

Suspend_get

Authorizations:

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required