{"info":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","description":"

HTTP-based API to interact with Ayako

Authorization

Authorization is either a Bearer or a Bot Token

Do not use your Discord Bot's Token as Authorization Token

Obtain a Token at https://ayakobot.com/@me (if it exists yet)

TypeScript Types

All endpoint response types are available at GitHub.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"17898470","collectionId":"ef8c7f20-c699-42e6-bf2d-724feac5d521","publishedId":"2sA3rzLYtY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-08-07T20:18:13.000Z"},"item":[{"name":"v1","item":[{"name":"Short-URLs","item":[{"name":"get short urls","id":"4f219246-70cc-40c6-8e5d-af15cd1b3afc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/short-urls","description":"

Returns all short URLs of the user

Response Body

The response body is of type ShortURL[]

ShortURL

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
id	string	ID of the short URL (wzxy.org/ID)
forward	string	URL this short URL forwards to
uses	number	amount of uses

Returns the uses of a short URL

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
id	string	ID of the short URL

Response Body

The response body is of type ShortURLUse[]

Short URL Use

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
id	string	ID of the short URL (wzxy.org/ID)
timestamp	number	UNIX timestamp in milliseconds of when the URL was used

Returns information about the user with the corresponding Bearer or Bot token.

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
id	Snowflake	the users ID
name	string	the users name
avatar	string?	a URL to the users avatar
votereminders	boolean	whether the user has vote-reminders enabled
socials	Social[]	a list of socials connected to the user

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
url	string	URL of the linked social
type	string	the socials name (like \"Discord\" or \"GitHub\")

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"63461477-70d7-43f8-8c78-2527cc358e15","id":"63461477-70d7-43f8-8c78-2527cc358e15","name":"Self","type":"folder"}},"urlObject":{"path":["@me"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[]}},"response":[{"id":"106ecabe-645a-4334-ad3a-526d4c6f5303","name":"OK","originalRequest":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"650691698409734151\",\r\n \"name\": \"Ayako\",\r\n \"avatar\": \"https://cdn.discordapp.com/avatars/650691698409734151/9ca4ad70d8ef529d31a3ec03923bddcb.webp\",\r\n \"socials\": [\r\n {\r\n \"url\": \"https://ayakobot.com\",\r\n \"type\": \"AyakoBot.com\"\r\n },\r\n {\r\n \"url\": \"https://github.com/AyakoBot\",\r\n \"type\": \"GitHub\"\r\n }\r\n ],\r\n \"votereminders\": true\r\n}"},{"id":"b84b63b5-1e4c-4044-8f6c-d0b957eb374d","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me"},"status":"Forbidden","code":403,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"4b0d3157-d85b-4933-88e1-c4ae6f7d34f3"},{"name":"generate API token","id":"50a15c71-9a7f-47d7-a1fe-202c83e2130f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.ayakobot.com/v1/@me/auth/generate","description":"

Generates an API token.
If the user already had an API token generated earlier it will be invalidated and replaced.

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Descriptíon
token	string	the access token

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"63461477-70d7-43f8-8c78-2527cc358e15","id":"63461477-70d7-43f8-8c78-2527cc358e15","name":"Self","type":"folder"}},"urlObject":{"path":["@me","auth","generate"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[]}},"response":[{"id":"4e26f74a-d64f-4d0e-9a3d-e36dd98354d1","name":"OK","originalRequest":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/auth/generate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"token\": \"MzE4NDUzMTQzNDc2MzcxNDU2.H4M0WNQ.XBWDGryN69_RKOBkMJU0kIPP2TzKf0USvhV6zb0w4QBia\"\r\n}"},{"id":"bfe14139-c350-4f76-9970-8ea26573d643","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/auth/generate"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"f251e5cd-607b-443e-b9e4-2ed0617f1531","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/auth/generate"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"50a15c71-9a7f-47d7-a1fe-202c83e2130f"},{"name":"get guilds","id":"c3ad899d-5a8d-420c-8c59-01bef0755a36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/guilds","description":"

Returns a list of guilds the user is member ofo

Response Body

The response body will be of type Guild[]

Guild

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
hasBot	boolean	whether the guild has Ayako added
id	Snowflake	ID of the guild
name	string	name of the guild
icon	string?	icon hash of the guild
banner	string?	banner hash of the guild
owner	boolean	whether the user is owner of this guild
features	GuildFeature[]	features this guild has access to
permissions	Permissions	permissions of the user in this guild
approximate_member_count	number?	rough estimate of amount of members this guild has
approximate_presence_count	number?	rough estimate of amount of presences this guild has

For data related to the user/bot sending the request

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bearer "}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b203a781-a874-455f-b018-4e4c01bd3a8d","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"c6df5b2f-01d1-4a90-8a02-548576b1f0b7","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"63461477-70d7-43f8-8c78-2527cc358e15"},{"name":"Appeals","item":[{"name":"get appealable guilds","id":"fae485c9-c18a-4d8c-aa0f-dd27ab845ee1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bearer "}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/appeals/guilds","description":"

Returns a list of appealable guilds the user making the request is in.

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
appealEnabled	AppealGuild[]	list of guilds the user can send appeals to
otherMutuals	AppealGuild[]	list of guilds the users can not send appeals to

Appeal Guild

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
id	Snowflake	the guilds ID
name	string	the guilds name
icon	string?	an image hash to the guilds icon
banner	string?	an image hash to the guilds banner

","urlObject":{"path":["@me","appeals","guilds"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[]}},"response":[{"id":"f3b40b69-1e37-4e76-a2b6-90435b97d85c","name":"OK","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"Bearer "}},"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/appeals/guilds"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"appealEnabled\": [\r\n {\r\n \"id\": \"298954459172700181\",\r\n \"name\": \"Animekos | Anime ❀ Social ❀ Ayako\",\r\n \"icon\": \"a_2a945cea66c917f525df699e08f315e6\",\r\n \"banner\": \"afc4e3d92f6230c58240df79e263c186\"\r\n },\r\n {\r\n \"id\": \"669893888856817665\",\r\n \"name\": \"Ayako's Hideout\",\r\n \"icon\": null,\r\n \"banner\": null\r\n }\r\n ],\r\n \"otherMutuals\": []\r\n}"},{"id":"b2d239f7-4db0-46e2-b5b7-1f25ab8eacd8","name":"Forbidden","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"Bearer "}},"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/appeals/guilds"},"status":"Forbidden","code":403,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"fae485c9-c18a-4d8c-aa0f-dd27ab845ee1"},{"name":"post appeal","id":"1b77e89d-4f66-42fd-bd74-ca2ddcab896d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bearer "}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"\": \"\",\r\n\r\n // key = question Id\r\n // value = stringified answer\r\n\r\n // # Examples:\r\n \"1\": \"\", // boolean\r\n \"2\": \"[\\\"\\\"]\", // single_choice\r\n \"3\": \"[\\\"\\\",\\\"\\\"]\", // multiple_choice\r\n \"4\": \"\", // number\r\n \"5\": \"\" // short / paragraph \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/punishments/:punishmentId/appeal","description":"

Creates an appeal for a punishment.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
punishmentId	integer	the ID of the punishment

Request Body

The request body consists of Record.
The key of the record represents a question id and the value the stringified response.

Answer Types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Accepted Values	Example
boolean	true, false, on, off	\"true\"
single_choice	[\\\"\\\"]	\"[\\\"foo\\\"]\"
multiple_choice	[\\\"\\\",\\\"\\\"]	\"[\\\"foo\\\",\\\"bar\\\"]\"
number	number	\"1\"
short	string	\"bar\"
paragraph	string	\"baz\"
text

Questions of type text cannot be answered.
Short and Paragraph can be up to 2,000 letters long.

\n","urlObject":{"path":["punishments",":punishmentId","appeal"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[{"type":"string","value":"","key":"punishmentId"}]}},"response":[{"id":"cebd3ff0-2f8a-42ba-ad62-09695d319edc","name":"Created","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"Bearer "}},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"1727691172746\": \"on\", // boolean\r\n \"1727691172747\": \"true\", // boolean\r\n \"1727691172748\": \"off\", // boolean\r\n \"1727691172749\": \"false\", // boolean\r\n \"1727691172740\": \"[\\\"foo\\\"]\", // single_choice\r\n \"1727691172741\": \"[\\\"foo\\\",\\\"bar\\\"]\", // multiple_choice\r\n \"1727691172742\": \"5\", // number\r\n \"1727691142743\": \"foo\", // paragraph\r\n \"1727691142744\": \"bar\" // short\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.ayakobot.com/v1/punishments/:punishmentId/appeal","host":["https://api.ayakobot.com/v1"],"path":["punishments",":punishmentId","appeal"],"variable":[{"key":"punishmentId","value":"","type":"string"}]}},"status":"Created","code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"fbbd26f0-1a6f-45fe-9bc7-af6a40754569","name":"Bad Request","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"Bearer "}},"method":"POST","header":[],"url":{"raw":"https://api.ayakobot.com/v1/punishments/:punishmentId/appeal","host":["https://api.ayakobot.com/v1"],"path":["punishments",":punishmentId","appeal"],"variable":[{"id":0,"key":"punishmentId","value":"","type":"string"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"20aada73-78bf-4faf-b390-bc18c3774299","name":"Unauthorized","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"Bearer "}},"method":"POST","header":[],"url":{"raw":"https://api.ayakobot.com/v1/punishments/:punishmentId/appeal","host":["https://api.ayakobot.com/v1"],"path":["punishments",":punishmentId","appeal"],"variable":[{"id":0,"key":"punishmentId","value":"","type":"string"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"ea22d4e3-3a14-4402-b326-511fb01717df","name":"Forbidden","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"Bearer "}},"method":"POST","header":[],"url":{"raw":"https://api.ayakobot.com/v1/punishments/:punishmentId/appeal","host":["https://api.ayakobot.com/v1"],"path":["punishments",":punishmentId","appeal"],"variable":[{"id":0,"key":"punishmentId","value":"","type":"string"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"1b77e89d-4f66-42fd-bd74-ca2ddcab896d"},{"name":"get appeal questions","id":"09ec3984-aae3-47dc-8757-1cc3bc288945","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/guilds/:guildId/settings/appeal-questions","description":"

Returns the punishment appeal's questions.

Request

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
guildId	Snowflake	the ID of the guild

Response Body

The response body will be of type Question[].
Find type definitions at GET appeal questions.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}},"urlObject":{"path":["guilds",":guildId","settings","appeal-questions"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[{"type":"string","value":"","key":"guildId"}]}},"response":[{"id":"49171d7e-e84f-491c-8f47-29e0984ecae1","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/settings/appeal-questions","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","settings","appeal-questions"],"variable":[{"key":"guildId","value":"","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"guildid\": \"298954459172700181\",\r\n \"id\": 1716238435819,\r\n \"active\": true,\r\n \"question\": \"How will you improve your Behaviour in the Future?\",\r\n \"answertype\": \"paragraph\",\r\n \"required\": true,\r\n \"options\": []\r\n },\r\n {\r\n \"guildid\": \"298954459172700181\",\r\n \"id\": 1716238435817,\r\n \"active\": true,\r\n \"question\": \"What do you want to appeal?\",\r\n \"answertype\": \"multiple_choice\",\r\n \"required\": false,\r\n \"options\": [\"A Channel-Ban\", \"A Ban\"]\r\n }\r\n]"},{"id":"7c6711f3-8077-4351-b1d0-912fdc5a11aa","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/settings/appeal-questions","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","settings","appeal-questions"],"variable":[{"id":0,"key":"guildId","value":"","type":"string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"3e05b009-a5a3-438b-b2a3-5eafaa1084ef","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/settings/appeal-questions","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","settings","appeal-questions"],"variable":[{"id":0,"key":"guildId","value":"","type":"string"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"5032c74d-a68a-4cc2-91c0-5c4cb012cd3b","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/settings/appeal-questions","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","settings","appeal-questions"],"variable":[{"id":0,"key":"guildId","value":"","type":"string"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"09ec3984-aae3-47dc-8757-1cc3bc288945"},{"name":"get appeal status","id":"6dfd33b7-c8e5-473d-a71a-7264c31d72f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/punishments/:punishmentId/status","description":"

Returns the appeals status.

Request

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
punishmentId	integer	the ID of the punishment

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
status	AppealStatus	the status of the appeal

Requests related to punishment appeals

\n","_postman_id":"1c253cc0-b820-4910-bb12-0c19a04eef27","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}}},{"name":"Guilds","item":[{"name":"get guilds","id":"29bdd309-98b3-4727-b01d-fb7a14c1ce31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/guilds?take=&skip=&leastMemberCount=&q=","description":"

Returns a list of guilds based on the provided filters.

Request

Query Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
take	integer?	the amount of guilds to return (max `1000`)
skip	integer?	the amount of guilds to skip
leastMemberCount	integer?	the minimum amount of members to filter the guilds by
q	string?	a string to filter the guild names by

Response Body

The response body will be of type GuildPreview[].

Guild Preview

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
guildid	Snowflake	the guilds ID
name	string	the guilds name
icon	string?	a URL to the guilds icon
banner	string?	a URL to the guilds banner
invite	string?	the guilds vanity invite URL
membercount	number?	the guilds amount of members

","urlObject":{"path":["guilds"],"host":["https://api.ayakobot.com/v1"],"query":[{"key":"take","value":""},{"id":1,"key":"skip","value":""},{"id":2,"key":"leastMemberCount","value":""},{"id":3,"key":"q","value":""}],"variable":[]}},"response":[{"id":"ff78d595-0a1e-4c2e-8170-ca1fbc80abf1","name":"OK","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds?take=&skip=&leastMemberCount=&q=","host":["https://api.ayakobot.com/v1"],"path":["guilds"],"query":[{"key":"take","value":""},{"key":"skip","value":""},{"key":"leastMemberCount","value":""},{"key":"q","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"guildid\": \"298954459172700181\",\r\n \"name\": \"Animekos | Anime ❀ Social ❀ Ayako\",\r\n \"icon\": \"https://cdn.discordapp.com/icons/298954459172700181/a_2a945cea66c917f525df699e08f315e6.gif\",\r\n \"banner\": \"https://cdn.discordapp.com/banners/298954459172700181/afc4e3d92f6230c58240df79e263c186.webp\",\r\n \"invite\": \"animekos\",\r\n \"membercount\": 67584\r\n },\r\n {\r\n \"guildid\": \"669893888856817665\",\r\n \"name\": \"Ayaok's Hideout\",\r\n \"icon\": null,\r\n \"banner\": null,\r\n \"invite\": null,\r\n \"membercount\": 17\r\n }\r\n]"},{"id":"b3f2cab0-5288-4e88-b41c-db4ffc6b2ff9","name":"Bad Request","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds?take=&skip=&leastMemberCount=&q=","host":["https://api.ayakobot.com/v1"],"path":["guilds"],"query":[{"key":"take","value":"","type":"text","id":0},{"key":"skip","value":"","type":"text","id":1},{"key":"leastMemberCount","value":"","type":"text","id":2},{"key":"q","value":"","type":"text","id":3}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"29bdd309-98b3-4727-b01d-fb7a14c1ce31"},{"name":"get guild","id":"83d93346-e7a9-4a21-b26f-e93c18664763","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/guilds/:guildId","description":"

Returns details for a guild.

Request

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
guildId	Snowflake	the ID of the guild

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
banner	string?	a URL to the guilds banner
features	string[]	the guilds features
id	Snowflake	the guilds ID
icon	string?	a URL to the guilds icon
invite	string?	the guilds vanity invite URL
memberCount	integer	the guilds member count
name	string	the guilds name
presenceCount	integer?	the guilds presence count (only supplied at 10k+ members)

","urlObject":{"path":["guilds",":guildId"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[{"type":"string","value":"","key":"guildId"}]}},"response":[{"id":"0e751bb7-0c92-4db0-881c-2e71fe4a3f26","name":"OK","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId"],"variable":[{"key":"guildId","value":"","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"banner\": null,\r\n \"features\": [\r\n \"AUTO_MODERATION\",\r\n \"CHANNEL_ICON_EMOJIS_GENERATED\",\r\n \"GUILD_ONBOARDING_HAS_PROMPTS\",\r\n \"NEWS\",\r\n \"GUILD_SERVER_GUIDE\",\r\n \"GUILD_ONBOARDING\",\r\n \"SOUNDBOARD\",\r\n \"COMMUNITY\",\r\n \"GUILD_ONBOARDING_EVER_ENABLED\"\r\n ],\r\n \"id\": \"669893888856817665\",\r\n \"icon\": \"https://cdn.discordapp.com/icons/669893888856817665/186138abe2d087b115e985df6cb6f9eb.webp\",\r\n \"invite\": null,\r\n \"memberCount\": 21,\r\n \"name\": \"Ayako's Hideout\",\r\n \"presenceCount\": null\r\n}"},{"id":"43203bd9-0870-48c2-a3f5-7c72495de45b","name":"Bad Request","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId"],"variable":[{"id":0,"key":"guildId","value":"","type":"string"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"92339007-46a7-4341-aca9-fb6ed6f2c829","name":"Not Found","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId"],"variable":[{"id":0,"key":"guildId","value":"","type":"string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"83d93346-e7a9-4a21-b26f-e93c18664763"},{"name":"get guild roles","id":"24d0c753-c293-4683-9fe7-bd43eeae0d5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/guilds/:guildId/roles","description":"

Returns the roles of a guild.

Request

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
guildId	Snowflake	the ID of the guild

Response

The response body will be of type Role[]

Role

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
id	Snowflake	the roles ID
name	string	the name of the role
color	integer	the color of the role as integer
hoist	boolean	whether the role is hoisted
icon_url	string?	the url to this role's icon
unicode_emoji	string?	the unicode emoji of this role
position	integer	the position of this role
permissions	string	the permissions of this role as bit string
managed	boolean	whether this role is managed
mentionable	boolean	whether this role can be mentioned
guild_id	Snowflake	the guild ID of the guild this role belongs to
tags	RoleTags	the tags of this role
flags	RoleFlags	the flags of this role

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}},"urlObject":{"path":["guilds",":guildId","roles"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[{"type":"string","value":"","key":"guildId"}]}},"response":[{"id":"d689e79d-e844-42b6-b555-85ab2675768d","name":"OK","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId","protocol":"https","host":["api","ayakobot","com"],"path":["v1","guilds",":guildId"],"variable":[{"key":"guildId","value":"","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"unicode_emoji\": null,\r\n \"tags\": {\r\n \"bot_id\": \"650691698409734151\"\r\n },\r\n \"position\": 180,\r\n \"permissions\": \"8804682812662\",\r\n \"name\": \"Snow Queen Ayako\",\r\n \"mentionable\": true,\r\n \"managed\": true,\r\n \"id\": \"670020358086066199\",\r\n \"hoist\": true,\r\n \"flags\": 0,\r\n \"color\": 11599616,\r\n \"guild_id\": \"298954459172700181\",\r\n \"icon_url\": \"https://cdn.discordapp.com/role-icons/670020358086066199/1973311c8bd3832b7f4913fad5fa57dc.webp\"\r\n }\r\n]"},{"id":"957b541c-7e85-4f74-9375-e3111d296746","name":"Bad Request","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId"],"variable":[{"id":0,"key":"guildId","value":"","type":"string"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"d4b269bc-a3e2-4a4d-8ca1-7b23e9059250","name":"Not Found","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId"],"variable":[{"id":0,"key":"guildId","value":"","type":"string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"e4d21a12-7f55-4312-bb9c-bd4a4fc259f1","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/roles","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","roles"],"variable":[{"key":"guildId","value":"","type":"string"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"24d0c753-c293-4683-9fe7-bd43eeae0d5b"},{"name":"get guild channels","id":"5a88765c-cd52-485e-aca7-c6f90c525427","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/guilds/:guildId/channels?types=","description":"

Returns the roles of a guild.

Request

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
guildId	Snowflake	the ID of the guild

Response

The response body will be of type Channel[]

Channel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
id	Snowflake	the channels ID
name	string	the name of the channel
guild_id	string	the guild ID of the guild this channel belongs to
type	ChannelType	the type of the channel
permission_overwrites	PermissionOverwrite[]	the permission overwrites of the channel
position	integer	the position of this channel
parent_id	Snowflake?	the ID of the parent of this channel
nsfw	boolean	whether the channel is marked as nsfw
rate_limit_per_user	integer	the user ratelimit in seconds
default_auto_archive_duration	integer?	the default auto archive duration of threads created in this channel
default_thread_rate_limit_per_user	integer?	the default user ratelimit in threads created in this channel
topic	string?	the channel topic
bitrate	bitrate?	the bitrate (in bits) of this channel
user_limit	integer?	the max amount of users in this channel
rtc_region	string?	the voice region of this channel
video_quality_mode	VideoQualityMode	the video quality mode of the channel
last_pin_timestamp	ISO8601 timestamp?	the ISO timestamp of the last pin in this channel
available_tags	Tag[]	list of available tags in this channel
default_reaction_emoji	DefaultReactionEmoji	the default reaction emoji for threads in this channel
default_sort_order	DefaultSortOrder	the default sort order of threads in this channel
default_forum_layout	DefaultForumLayout	the default forum layout of threads in this channel

https://discord.com/developers/docs/resources/channel#channel-object-channel-types

\n","type":"text/plain"},"key":"types","value":""}],"variable":[{"type":"string","value":"","key":"guildId"}]}},"response":[{"id":"7f264cfa-f674-43cf-bbb0-0884007c75af","name":"OK","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId","protocol":"https","host":["api","ayakobot","com"],"path":["v1","guilds",":guildId"],"variable":[{"key":"guildId","value":"","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"unicode_emoji\": null,\r\n \"tags\": {\r\n \"bot_id\": \"650691698409734151\"\r\n },\r\n \"position\": 180,\r\n \"permissions\": \"8804682812662\",\r\n \"name\": \"Snow Queen Ayako\",\r\n \"mentionable\": true,\r\n \"managed\": true,\r\n \"id\": \"670020358086066199\",\r\n \"hoist\": true,\r\n \"flags\": 0,\r\n \"color\": 11599616,\r\n \"guild_id\": \"298954459172700181\",\r\n \"icon_url\": \"https://cdn.discordapp.com/role-icons/670020358086066199/1973311c8bd3832b7f4913fad5fa57dc.webp\"\r\n }\r\n]"},{"id":"58884a30-9331-4c56-80d6-e1aa17d034a0","name":"Bad Request","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId"],"variable":[{"id":0,"key":"guildId","value":"","type":"string"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"5237a305-07ce-40b1-ba75-2550e58f09bf","name":"Not Found","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId"],"variable":[{"id":0,"key":"guildId","value":"","type":"string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"c2c7d648-2d70-45c8-a7c8-30d5308570d3","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/channels?types=","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","channels"],"query":[{"key":"types","value":"","description":"https://discord.com/developers/docs/resources/channel#channel-object-channel-types"}],"variable":[{"key":"guildId","value":"","type":"string"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"5a88765c-cd52-485e-aca7-c6f90c525427"},{"name":"get leaderboard","id":"7ce282e9-bbf5-4401-940c-3a2eb0f611b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/guilds/:guildId/lb?take=&skip=","description":"

Returns a guilds leaderboard.

Request

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
guildId	Snowflake	the ID of the guild

Query Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
take	integer?	the amount of entries to return (max `100`)
skip	integer?	the amount of entries to skip

Response Body

The response will be of type Level[]

Level

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
xp	integer	the users XP
level	integer	the users level
multiplier	number	the users current level multiplier
user	LevelUser	the user

Level User

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
id	Snowflake	the users ID
name	string	the users name
avatar	string?	a URL to the users avatar

","urlObject":{"path":["guilds",":guildId","lb"],"host":["https://api.ayakobot.com/v1"],"query":[{"key":"take","value":""},{"id":1,"key":"skip","value":""}],"variable":[{"type":"string","value":"","key":"guildId"}]}},"response":[{"id":"a6e5102f-dde2-43cd-bd59-d0ec9e65aa68","name":"OK","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/lb?take=&skip=","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","lb"],"query":[{"key":"take","value":""},{"key":"skip","value":""}],"variable":[{"key":"guildId","value":"","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"xp\": 100,\r\n \"level\": 1,\r\n \"multiplier\": 1,\r\n \"user\": {\r\n \"id\": \"776493966341570591\",\r\n \"name\": \"Ayako Dev Version\",\r\n \"avatar\": \"https://cdn.discordapp.com/avatars/776493966341570591/a24ff80c1fa597b27fa1a5023264308c.webp\"\r\n }\r\n },\r\n {\r\n \"xp\": 1,\r\n \"level\": 0,\r\n \"multiplier\": 1,\r\n \"user\": {\r\n \"id\": \"318453143476371456\",\r\n \"name\": \"lars_und_so\",\r\n \"avatar\": \"https://cdn.discordapp.com/avatars/318453143476371456/88210272e98a942384d69eaa3a9ae89c.webp\"\r\n }\r\n },\r\n]"},{"id":"0ac4c308-ed98-4d05-ae8b-cc6d120da266","name":"Bad Request","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/lb?take=&skip=","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","lb"],"query":[{"key":"take","value":"","type":"text","id":0},{"key":"skip","value":"","type":"text","id":1}],"variable":[{"id":0,"key":"guildId","value":"","type":"string"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"7ce282e9-bbf5-4401-940c-3a2eb0f611b2"}],"id":"bef34836-2a9c-462d-8bc4-8700515451da","description":"

Guild related endpoints

\n","_postman_id":"bef34836-2a9c-462d-8bc4-8700515451da","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}}},{"name":"Punishments","item":[{"name":"get punishments","id":"20d17b97-edea-4023-b8e0-ec2fe2bbeab5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bearer "}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/punishments?guildId=","description":"

Returns a list of the user's punishments.

Request

Query Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
guildId	Snowflake	the guild to filter the punishments by

Response Body

The response will be of type Punishment[].

Punishment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
appealed	boolean	whether the punishment has already been appealed
type	PunishmenType	the punishments type
reason	string	the punishments reason
id	integer	the punishments ID
channel	Channel	the punishments channel
duration	integer?	the punishments duration (in seconds)

Channel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
name	string	the channels name
id	Snowflake	the channels ID

","urlObject":{"path":["@me","punishments"],"host":["https://api.ayakobot.com/v1"],"query":[{"key":"guildId","value":""}],"variable":[]}},"response":[{"id":"fc649b66-59c6-4f3c-bfdd-8628f8a26c72","name":"OK","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"Bearer "}},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/@me/punishments?guildId=","host":["https://api.ayakobot.com/v1"],"path":["@me","punishments"],"query":[{"key":"guildId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"appealed\": true,\r\n \"type\": \"bans\",\r\n \"reason\": \"foo\",\r\n \"id\": 1727691172746,\r\n \"channel\": {\r\n \"name\": \"general\",\r\n \"id\": \"298954459172700181\"\r\n },\r\n \"duration\": null\r\n },\r\n {\r\n \"appealed\": false,\r\n \"type\": \"tempmutes\",\r\n \"reason\": \"bar\",\r\n \"id\": 1727691172736,\r\n \"channel\": {\r\n \"name\": \"general\",\r\n \"id\": \"298954459172700181\"\r\n },\r\n \"duration\": 3600000\r\n }\r\n]"},{"id":"11e39ec7-2e9f-40f1-9a1a-0eac820e20a1","name":"Bad Request","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"Bearer "}},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/@me/punishments?guildId=","host":["https://api.ayakobot.com/v1"],"path":["@me","punishments"],"query":[{"key":"guildId","value":"","id":0}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"f9bdb5f8-f844-4e71-9e6b-9f60ef4d0925","name":"Unauthorized","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"Bearer "}},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/@me/punishments?guildId=","host":["https://api.ayakobot.com/v1"],"path":["@me","punishments"],"query":[{"key":"guildId","value":"","id":0}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"446ce70f-38cd-474f-a8c2-d56cda3bc81c","name":"Forbidden","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"Bearer "}},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/@me/punishments?guildId=","host":["https://api.ayakobot.com/v1"],"path":["@me","punishments"],"query":[{"key":"guildId","value":"","id":0}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"20d17b97-edea-4023-b8e0-ec2fe2bbeab5"},{"name":"get punishment","id":"abf003d1-658d-4734-8b44-dab4035e6092","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/punishments/:punishmentId","description":"

Returns a specific punishment.

Request

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
punishmentId	integer	the ID of the punishment

Response Body

The response will be of type Punishment.
For type definitions see GET punishments.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}},"urlObject":{"path":["punishments",":punishmentId"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[{"type":"string","value":"","key":"punishmentId"}]}},"response":[{"id":"f714bbb7-82b3-490a-b512-b14ff7121308","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/punishments/:punishmentId","host":["https://api.ayakobot.com/v1"],"path":["punishments",":punishmentId"],"variable":[{"key":"punishmentId","value":"","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"appealed\": false,\r\n \"type\": \"tempmutes\",\r\n \"reason\": \"bar\",\r\n \"id\": 1727691172736,\r\n \"channel\": {\r\n \"name\": \"general\",\r\n \"id\": \"298954459172700181\"\r\n },\r\n \"duration\": 3600000\r\n}"},{"id":"2978312c-e992-4a4e-8837-a7e9eb8ae12c","name":"Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/punishments/:punishmentId","host":["https://api.ayakobot.com/v1"],"path":["punishments",":punishmentId"],"variable":[{"id":0,"key":"punishmentId","value":"","type":"string"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"efae5b9a-c8dd-48b5-8328-e9659d920b28","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/punishments/:punishmentId","host":["https://api.ayakobot.com/v1"],"path":["punishments",":punishmentId"],"variable":[{"id":0,"key":"punishmentId","value":"","type":"string"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"828c2ce5-95af-4afa-85da-efca86372b19","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/punishments/:punishmentId","host":["https://api.ayakobot.com/v1"],"path":["punishments",":punishmentId"],"variable":[{"id":0,"key":"punishmentId","value":"","type":"string"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"750cdd33-cbff-44ce-9746-f2079b9cb824","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/punishments/:punishmentId","host":["https://api.ayakobot.com/v1"],"path":["punishments",":punishmentId"],"variable":[{"id":0,"key":"punishmentId","value":"","type":"string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"abf003d1-658d-4734-8b44-dab4035e6092"}],"id":"c0935ed7-9d95-4262-8b44-f3655a5d162d","description":"

Punishment related endpoints

\n","_postman_id":"c0935ed7-9d95-4262-8b44-f3655a5d162d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}}},{"name":"QOTD","item":[{"name":"get qotd","id":"0b4e18a6-34fd-4183-91fb-29e14ffdd927","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/qotd","description":"

Returns today's question of the day.

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
question	string	the question

","urlObject":{"path":["qotd"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[]}},"response":[{"id":"757ef549-686c-4899-872b-ead894e282de","name":"OK","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/qotd"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"question\": \"What are you going to develop today?\"\r\n}"}],"_postman_id":"0b4e18a6-34fd-4183-91fb-29e14ffdd927"}],"id":"7d50e4b9-1800-43f1-b059-ec100a9ef74e","description":"

Question of the Day

\n","_postman_id":"7d50e4b9-1800-43f1-b059-ec100a9ef74e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}}},{"name":"Linked Roles","item":[{"name":"get decorative linked role","id":"5591aa95-ea54-4f30-9580-828d37da4867","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/guilds/:guildId/linked-roles/:settingsId/decoration?code=","description":"

Endpoint used for Discord's Linked Roles Verification and OAuth2 redirect.

Request

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
guildId	Snowflake	the ID of the guild
settingsId	integer	the ID of the linked-role setting

Query Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
code	string?	Discord's OAuth2 authorization code

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"ba85de35-c8af-409b-8dc4-2398717f8c8d","id":"ba85de35-c8af-409b-8dc4-2398717f8c8d","name":"Linked Roles","type":"folder"}},"urlObject":{"path":["guilds",":guildId","linked-roles",":settingsId","decoration"],"host":["https://api.ayakobot.com/v1"],"query":[{"key":"code","value":""}],"variable":[{"type":"string","value":"","key":"guildId"},{"type":"string","value":"","key":"settingsId"}]}},"response":[{"id":"7fd939bd-25cf-4c12-9a29-b1940675c739","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/linked-roles/:settingsId/decoration?code=","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","linked-roles",":settingsId","decoration"],"query":[{"key":"code","value":""}],"variable":[{"key":"guildId","value":"","type":"string"},{"key":"settingsId","value":"","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"foo, bar\"\r\n}"},{"id":"5386e75c-6800-4455-929b-2b90318ec09a","name":"Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/linked-roles/:settingsId/decoration?code=","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","linked-roles",":settingsId","decoration"],"query":[{"key":"code","value":"","type":"text","id":0}],"variable":[{"id":0,"key":"guildId","value":"","type":"string"},{"id":1,"key":"settingsId","value":"","type":"string"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"b737f203-ab4d-4e6b-bea7-328806f1c856","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/linked-roles/:settingsId/decoration?code=","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","linked-roles",":settingsId","decoration"],"query":[{"key":"code","value":"","type":"text","id":0}],"variable":[{"id":0,"key":"guildId","value":"","type":"string"},{"id":1,"key":"settingsId","value":"","type":"string"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"acf6b0e3-aa8a-40f6-8093-00ee75268fd1","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/linked-roles/:settingsId/decoration?code=","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","linked-roles",":settingsId","decoration"],"query":[{"key":"code","value":"","type":"text","id":0}],"variable":[{"id":0,"key":"guildId","value":"","type":"string"},{"id":1,"key":"settingsId","value":"","type":"string"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"aa379c2d-2072-4743-ad19-01ba3d697f08","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/linked-roles/:settingsId/decoration?code=","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","linked-roles",":settingsId","decoration"],"query":[{"key":"code","value":"","type":"text","id":0}],"variable":[{"id":0,"key":"guildId","value":"","type":"string"},{"id":1,"key":"settingsId","value":"","type":"string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"480be278-e1d4-4031-a738-230f951e6f86","name":"Failed Dependency","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/linked-roles/:settingsId/decoration?code=","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","linked-roles",":settingsId","decoration"],"query":[{"key":"code","value":"","type":"text","id":0}],"variable":[{"id":0,"key":"guildId","value":"","type":"string"},{"id":1,"key":"settingsId","value":"","type":"string"}]}},"status":"Failed Dependency (WebDAV) (RFC 4918)","code":424,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"5591aa95-ea54-4f30-9580-828d37da4867"}],"id":"ba85de35-c8af-409b-8dc4-2398717f8c8d","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e104f0ab-0780-4327-b93c-b055290202c8","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"636294d0-3b75-4a1d-9a67-aa92fe268c89","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"ba85de35-c8af-409b-8dc4-2398717f8c8d","description":""},{"name":"Bot","item":[{"name":"get stats","id":"90cfa7d6-3e52-464c-8223-f0f915dc7eea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/bot/stats","description":"

Returns Ayakos guild and user count statistics.

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
guildInstallCount	integer	the amount of guilds Ayako is installed in
userInstallCount	integer	the amount of users Ayako is installed on
userCount	integer	the amount of users Ayako can access across all guilds

Returns Ayakos Top.gg reviews.

Response Body

The response body will be of type Review[].

Review

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
userid	Snowflake	the reviewers user ID
score	integer	the reviews score in steps of 20 (100 = 5 stars, 20 = 1 star)
content	string	the reviews content
username	string	the reviewers name
avatar	string?	a URL to the reviewers avatar

Returns a list of Ayakos feature previews.

Request

Query Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
blocks	integer	the amount of blocks to return the response in

Response Body

The response body will be of type Feature[][].

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`blocks` Param Value In Request	Response Body Type
3	Feature[3][]
2	Feature[2][]

Feature

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
title	string	the features title
subtitle	string	the features subtitle
image	string	a relative URL to the features image
placeholder	string	a relative URL to the features placeholder image

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"f69c86ae-ffbb-480d-8374-0f90e18e9216","id":"f69c86ae-ffbb-480d-8374-0f90e18e9216","name":"Bot","type":"folder"}},"urlObject":{"path":["bot","features"],"host":["https://api.ayakobot.com/v1"],"query":[{"key":"blocks","value":""}],"variable":[]}},"response":[{"id":"80ba3b34-0ea8-4b30-b165-63acfda5f195","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/bot/features?blocks=","host":["https://api.ayakobot.com/v1"],"path":["bot","features"],"query":[{"key":"blocks","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"[\r\n [\r\n {\r\n \"title\": \"foo\",\r\n \"subtitle\": \"bar\",\r\n \"image\": \"baz.png\",\r\n \"placeholder\": \"bum.png\"\r\n },\r\n {\r\n \"title\": \"foo\",\r\n \"subtitle\": \"bar\",\r\n \"image\": \"baz.png\",\r\n \"placeholder\": \"bum.png\"\r\n }\r\n ],\r\n [\r\n {\r\n \"title\": \"foo\",\r\n \"subtitle\": \"bar\",\r\n \"image\": \"baz.png\",\r\n \"placeholder\": \"bum.png\"\r\n }\r\n ]\r\n]"},{"id":"a866993f-cd79-459e-ad8f-af72ff709b3a","name":"Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/bot/features?blocks=","host":["https://api.ayakobot.com/v1"],"path":["bot","features"],"query":[{"key":"blocks","value":"","type":"text","id":0}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"f53b00f9-cdb1-4f10-9bf6-a6103f40c240"},{"name":"get contributers","id":"568ce8be-26e4-40d7-b335-22b98d5f14de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/bot/contributers","description":"

Returns a list of Ayakos contributers.

Response Body

The reponse body will be of type Contributer[].

Contributer

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
userid	Snowflake	the users ID
roles	string[]	the users roles
username	string	the users name
avatar	string?	a URL to the users avatar
socials	Social	the users connected socials

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"f69c86ae-ffbb-480d-8374-0f90e18e9216","id":"f69c86ae-ffbb-480d-8374-0f90e18e9216","name":"Bot","type":"folder"}},"urlObject":{"path":["bot","contributers"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[]}},"response":[{"id":"b6cd018d-94f7-45fa-ab46-8db7e0323b4e","name":"OK","originalRequest":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/bot/contributers"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"userid\": \"318453143476371456\",\r\n \"roles\": [\r\n \"Ayako Creator\",\r\n \"Ayako Host\",\r\n \"Website Creator\",\r\n \"Website Host\",\r\n \"Website Designer\"\r\n ],\r\n \"username\": \"lars_und_so\",\r\n \"avatar\": \"https://cdn.discordapp.com/avatars/318453143476371456/88210272e98a942384d69eaa3a9ae89c.webp\",\r\n \"socials\": [\r\n {\r\n \"type\": \"GitHub\",\r\n \"url\": \"https://github.com/Larsundso\"\r\n }\r\n ]\r\n },\r\n {\r\n \"userid\": \"529804646030770178\",\r\n \"roles\": [\r\n \"Ayako Artist\",\r\n \"Ayako Icon Artist\"\r\n ],\r\n \"username\": \"fuyurein\",\r\n \"avatar\": \"https://cdn.discordapp.com/avatars/529804646030770178/01e1aa344de2d880262e53cd008cb54f.webp\",\r\n \"socials\": [\r\n {\r\n \"type\": \"Instagram\",\r\n \"url\": \"https://www.instagram.com/fuyurei\"\r\n }\r\n ]\r\n },\r\n {\r\n \"userid\": \"267835618032222209\",\r\n \"roles\": [\r\n \"Ayako Artist\",\r\n \"Ayako Emoji Artist\",\r\n \"Website Creator\",\r\n \"Website Designer\"\r\n ],\r\n \"username\": \"a.lilac\",\r\n \"avatar\": \"https://cdn.discordapp.com/avatars/267835618032222209/d58f0114731950e4003327f2ac2a22bc.webp\",\r\n \"socials\": [\r\n {\r\n \"type\": \"Twitter\",\r\n \"url\": \"https://x.com/aqlilac\"\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"568ce8be-26e4-40d7-b335-22b98d5f14de"},{"name":"get artwork","id":"cd0e08ad-0b71-4265-9480-3227897056d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/bot/artworks?q=&type=","description":"

Returns a list of Ayakos artworks.

Request

Query Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
q	string?	a query to filter the entries by
type	ArtType?	the type of the artworks

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
user	ArtUser	the artworks author
art	Artwork	the artwork

Art User

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
username	string	the users username
avatar	string?	a URL to the users avatar
socials	Social[]	the users connected socials

Artwork

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
url	string	a URL to the artworks image
type	ArtType	the artworks type
created	integer	the artworks upload unix time
description	string?	the artworks description

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"f69c86ae-ffbb-480d-8374-0f90e18e9216","id":"f69c86ae-ffbb-480d-8374-0f90e18e9216","name":"Bot","type":"folder"}},"urlObject":{"path":["bot","artworks"],"host":["https://api.ayakobot.com/v1"],"query":[{"key":"q","value":""},{"id":1,"key":"type","value":""}],"variable":[]}},"response":[{"id":"17c1cf0f-941d-443b-8a7a-e70d7151a649","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/bot/artworks?q=&type=<'emoji','full','icon',null>","host":["https://api.ayakobot.com/v1"],"path":["bot","artworks"],"query":[{"key":"q","value":""},{"key":"type","value":"<'emoji','full','icon',null>"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"user\": {\r\n \"username\": \"fuyurein\",\r\n \"avatar\": \"https://cdn.discordapp.com/avatars/529804646030770178/01e1aa344de2d880262e53cd008cb54f.webp\",\r\n \"socials\": [\r\n {\r\n \"type\": \"Instagram\",\r\n \"url\": \"https://www.instagram.com/fuyurei\"\r\n }\r\n ]\r\n },\r\n \"art\": {\r\n \"url\": \"peace.png\",\r\n \"type\": \"full\",\r\n \"created\": 1665401574928,\r\n \"description\": null\r\n }\r\n },\r\n {\r\n \"user\": {\r\n \"username\": \"a.lilac\",\r\n \"avatar\": \"https://cdn.discordapp.com/avatars/267835618032222209/d58f0114731950e4003327f2ac2a22bc.webp\",\r\n \"socials\": [\r\n {\r\n \"type\": \"Twitter\",\r\n \"url\": \"https://x.com/aqlilac\"\r\n }\r\n ]\r\n },\r\n \"art\": {\r\n \"url\": \"ayako.png\",\r\n \"type\": \"full\",\r\n \"created\": 1665401573936,\r\n \"description\": null\r\n }\r\n },\r\n]"},{"id":"49ed082b-71c8-454c-901a-4737b6d86605","name":"Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/bot/artworks?q=&type=<'emoji','full','icon',null>","host":["https://api.ayakobot.com/v1"],"path":["bot","artworks"],"query":[{"key":"q","value":"","type":"text","id":0},{"key":"type","value":"<'emoji','full','icon',null>","type":"text","id":1}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"cd0e08ad-0b71-4265-9480-3227897056d1"},{"name":"get settings","id":"e85b1d21-daff-471e-bf18-8888a2b5069d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/bot/settings","description":"

Returns a lists of Ayakos available settings.

Response Body

The response body will be of type Setting[].

Setting

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
name	string	the name of the setting
id	string	the id of the setting
isMulti	boolean	whether a guild can have multiple of these settings
category	string	the category of the setting
description	string	short description of the setting
explainDescription	string	undefined
fields	SettingsField[]	the fields of the setting

SettingsField

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
type	SettingsType	the type of the field
name	string	the name of the field
description	string	the description of the field

Endpoints related to Ayako

\n","auth":{"type":"noauth","isInherited":false},"_postman_id":"f69c86ae-ffbb-480d-8374-0f90e18e9216"},{"name":"Settings","item":[{"name":"get appeal questions","id":"594667ed-fcb0-4d09-94f4-0797cae69674","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/guilds/:guildId/settings/appeal-questions","description":"

Returns a list of the guilds appeal questions.

Request

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
guildId	Snowflake	the ID of the guild

Response Body

The response will be of type AppealQuestion[].

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
guildid	Snowflake	the questions guild ID
id	integer	the questions ID
active	boolean	whether the question is enabled
question	string	the question
answertype	AnswerType	the questions answer type
required	boolean	whether the questions answer is required
options	string[]	a multi- and single-choice questions options

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}},"urlObject":{"path":["guilds",":guildId","settings","appeal-questions"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[{"type":"string","value":"","key":"guildId"}]}},"response":[{"id":"4a9a16d9-e00f-447b-9c14-c86a97570675","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/settings/appeal-questions","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","settings","appeal-questions"],"variable":[{"key":"guildId","value":"","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"guildid\": \"298954459172700181\",\r\n \"id\": 1716238435819,\r\n \"active\": true,\r\n \"question\": \"How will you improve your Behaviour in the Future?\",\r\n \"answertype\": \"paragraph\",\r\n \"required\": true,\r\n \"options\": []\r\n },\r\n {\r\n \"guildid\": \"298954459172700181\",\r\n \"id\": 1716238435817,\r\n \"active\": true,\r\n \"question\": \"What do you want to appeal?\",\r\n \"answertype\": \"multiple_choice\",\r\n \"required\": false,\r\n \"options\": [\"A Channel-Ban\", \"A Ban\"]\r\n }\r\n]"},{"id":"2a29689b-72e2-4f3e-9201-4af99c3bfca8","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/settings/appeal-questions","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","settings","appeal-questions"],"variable":[{"id":0,"key":"guildId","value":"","type":"string"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"06d6e5b8-e465-4048-b6a2-5a9f8873017e","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/settings/appeal-questions","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","settings","appeal-questions"],"variable":[{"id":0,"key":"guildId","value":"","type":"string"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"ef8eb081-7ec3-49a6-95c1-2b2a308329ea","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/guilds/:guildId/settings/appeal-questions","host":["https://api.ayakobot.com/v1"],"path":["guilds",":guildId","settings","appeal-questions"],"variable":[{"id":0,"key":"guildId","value":"","type":"string"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"594667ed-fcb0-4d09-94f4-0797cae69674"}],"id":"f006dd02-5828-4963-aee0-a8961b5f1d09","description":"

Settings related endpoints

\n","_postman_id":"f006dd02-5828-4963-aee0-a8961b5f1d09","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}}},{"name":"URL Scan","item":[{"name":"get URL scan","id":"4323d0c0-47ee-41c3-8fc5-674c72333237","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"url\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan","description":"

Returns a scan result of a previously scanned URL.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
url	string	a URL starting with `http://` or `https://`

Response

This endpoint will not respond with a body.
The scan result depends on the HTTP status code.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	Description
202 - Accepted	the URL is clean or not malicious
204 - No Content	the URL is stored as malicious
404 - Not Found	the URL has not been scanned before

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}},"urlObject":{"path":["url-scan"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[]}},"response":[{"id":"2220fe54-012d-416a-bb8c-0a9147b99465","name":"Accepted","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n // May be any valid URL (with query params, path variables, and fragment identifiers) \r\n \"url\": \"<(https://,http://)>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"99b07664-665b-4e8c-b4b6-9c3179ceca9b","name":"No Content","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n // May be any valid URL (with query params, path variables, and fragment identifiers) \r\n \"url\": \"<(https://,http://)>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/urlScan"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"83367f7c-e124-4134-b052-4d6ec104a98f","name":"Not Found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n // May be any valid URL (with query params, path variables, and fragment identifiers) \r\n \"url\": \"<(https://,http://)>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/urlScan"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"9188269d-18de-4157-bab8-bf0d0b474009","name":"Bad Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n // May be any valid URL (with query params, path variables, and fragment identifiers) \r\n \"url\": \"<(https://,http://)>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"4323d0c0-47ee-41c3-8fc5-674c72333237"},{"name":"submit URL for scan","id":"789d9ab6-2ca9-48fc-8fa6-286683c5ebdc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"url\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan","description":"

Submit a URL for scanning.

Request Body

For type definitions see POST get URL scan.

Response

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
scanId	string	the URL scan ID used for future requests
idExpires	integer	the expiration time of the scanId as unix

Status Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	Description
200 - OK	successfully submitted this URL for scanning
208 - Already Reported	this URL has already been scanned

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}},"urlObject":{"path":["url-scan"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[]}},"response":[{"id":"901af028-5dc7-43ec-8464-02bc4693458b","name":"OK","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n // May be any valid URL (with query params, path variables, and fragment identifiers) \r\n \"url\": \"<(https://,http://)>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"scanId\": \"529fa13b-7765-48e1-bc10-ea7ca7adaf43\",\r\n \"idExpires\": 1727693141607\r\n}"},{"id":"98558205-72e7-4dc6-8e51-d55858d54359","name":"Already Reported","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n // May be any valid URL (with query params, path variables, and fragment identifiers) \r\n \"url\": \"<(https://,http://)>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan"},"status":"Already reported","code":208,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"f16636ca-1f9d-4cb5-a944-660163a31e6d","name":"Forbidden","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n // May be any valid URL (with query params, path variables, and fragment identifiers) \r\n \"url\": \"<(https://,http://)>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan"},"status":"Forbidden","code":403,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"5483d1c5-5b99-48b4-9115-3f09243593d2","name":"Unauthorized","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n // May be any valid URL (with query params, path variables, and fragment identifiers) \r\n \"url\": \"<(https://,http://)>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"b315be68-30d4-441e-b10e-9c4ba311e16a","name":"Bad Request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n // May be any valid URL (with query params, path variables, and fragment identifiers) \r\n \"url\": \"<(https://,http://)>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"}],"_postman_id":"789d9ab6-2ca9-48fc-8fa6-286683c5ebdc"},{"name":"get URL scan by Id","id":"6096c5f3-c06e-4bd5-b5ee-ea064493d1cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/url-scan/:scanId","description":"

Returns the result of a scanned URL.

Request

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
scanId	string	the scanId retrieved from PUT submit URL for scan

Response

This endpoint will not respond with a body.
The scan result depends on the HTTP status code.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	Description
202 - Accepted	the URL is clean or not malicious
204 - No Content	the URL is stored as malicious
409 - Conflict	the URL is not done getting scanned
412 - Precognition Failed	the URL does not respond with anything (anymore)
419 - Page Expired	the Scan ID has expired

","urlObject":{"path":["url-scan",":scanId"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[{"type":"any","value":"","key":"scanId"}]}},"response":[{"id":"697fb664-3a6f-4dff-b1af-588f50533e91","name":"Accepted","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/url-scan/:scanId","host":["https://api.ayakobot.com/v1"],"path":["url-scan",":scanId"],"variable":[{"key":"scanId","value":""}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"634b126e-3671-4532-809b-64b7d180d006","name":"No Content","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/url-scan/:scanId","host":["https://api.ayakobot.com/v1"],"path":["url-scan",":scanId"],"variable":[{"key":"scanId","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"bd4972b7-b9bb-434c-a04a-92b0a69a76bb","name":"Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/url-scan/:scanId","host":["https://api.ayakobot.com/v1"],"path":["url-scan",":scanId"],"variable":[{"key":"scanId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"8ec15fe6-7565-45e9-a725-97fbe6c181b3","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/url-scan/:scanId","host":["https://api.ayakobot.com/v1"],"path":["url-scan",":scanId"],"variable":[{"key":"scanId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"19607f49-36d5-4bcf-8d67-dafd5fa4494f","name":"Conflict","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/url-scan/:scanId","host":["https://api.ayakobot.com/v1"],"path":["url-scan",":scanId"],"variable":[{"key":"scanId","value":""}]}},"status":"Too Early","code":425,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"e2b97502-635c-48d8-8533-31b552c81e28","name":"Precognition Failed","originalRequest":{"auth":{"type":"noauth"},"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/url-scan/:scanId","host":["https://api.ayakobot.com/v1"],"path":["url-scan",":scanId"],"variable":[{"key":"scanId","value":""}]},"description":"Returns the result of a scanned URL.\n\n### Request\n\n#### Path Variables\n\n| **Key** | **Value Type** | **Value Description** |\n| --- | --- | --- |\n| scanId | string | the scanId retrieved from [PUT submit URL for scan](#789d9ab6-2ca9-48fc-8fa6-286683c5ebdc) |\n\n### Response\n\nThis endpoint will not respond with a body. \nThe scan result depends on the HTTP status code.\n\n| **Status Code** | **Description** |\n| --- | --- |\n| 102 - Processing | the URL is not done getting scanned |\n| 202 - Accepted | the URL is clean or not malicious |\n| 204 - No Content | the URL is stored as malicious |\n| 412 - Precognition Failed | the URL does not respond with anything (anymore) |\n| 419 - Page Expired | the Scan ID has expired |"},"status":"Precondition Failed","code":412,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"fcd9c4a6-6599-4021-8911-ce1dc505a2ec","name":"Page Expired","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/url-scan/:scanId","host":["https://api.ayakobot.com/v1"],"path":["url-scan",":scanId"],"variable":[{"key":"scanId","value":""}]}},"status":"Page Expired","code":419,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6096c5f3-c06e-4bd5-b5ee-ea064493d1cb"},{"name":"resubmit URL for scan","id":"21138ff9-8537-4020-8de4-00513671f671","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"url\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan","description":"

Resubmit URL for scanning.

Request Body

For type definitions see POST get URL scan.

Response Body

For type definitions see PUT submit URL for scan.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}},"urlObject":{"path":["url-scan"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[]}},"response":[{"id":"b6f696fa-313e-41db-9de2-58adedb4bd6d","name":"OK","originalRequest":{"method":"PATCH","header":[],"url":"https://api.ayakobot.com/v1/scan-url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"scanId\": \"529fa13b-7765-48e1-bc10-ea7ca7adaf43\",\r\n \"idExpires\": 1727693141607\r\n}"},{"id":"271273c2-aec5-4769-84ea-fd7a2ee6b6e8","name":"Already Reported","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"url\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan","description":"Resubmit URL for scanning.\n\n### Request Body\n\nFor type definitions see [POST get URL scan](#4323d0c0-47ee-41c3-8fc5-674c72333237).\n\n### Response Body\n\nFor type definitions see [PUT submit URL for scan](#789d9ab6-2ca9-48fc-8fa6-286683c5ebdc)."},"status":"208 Already Reported","_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"0160cf20-ad4a-4d82-9479-d7108af24f85","name":"Bad Request","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n // May be any valid URL (with query params, path variables, and fragment identifiers) \r\n \"url\": \"<(https://,http://)>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan"},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"26dffe60-c080-4489-9b38-60b02e08563d","name":"Forbidden","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n // May be any valid URL (with query params, path variables, and fragment identifiers) \r\n \"url\": \"<(https://,http://)>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan"},"status":"Forbidden","code":403,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"8fc4e048-f6f3-43cb-881b-4a41f5de6b76","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n // May be any valid URL (with query params, path variables, and fragment identifiers) \r\n \"url\": \"<(https://,http://)>\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/url-scan"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"21138ff9-8537-4020-8de4-00513671f671"}],"id":"50720b10-97af-448f-b264-7f6d6888b966","description":"

Ayakos URL scanning endpoints use a multitude of third party threat intelligence APIs and block-lists to determine a URLs legitimacy and intentions.

Disclaimer:

\n
While we strive to keep our services results as accurate and precise as possible, no automated checking system will ever be 100% accurate.
Please contact @lars_und_so on Discord via https://discord.gg/animekos if you believe a URL you own has falsely been flagged by Ayakos API.
\n

Internally used `Threat Intelligence APIs` and `Domain Block-Lists`

Domain Lists

All Domains scanned through Ayako will be listed in one of the following text files, unless the Domain is not registered.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

List	Description
allowlisted.txt	Marked as clean or not malicous at scan time
allowlistedCDN.txt	Content providers or Short-Link services that will still be scanned but won't me marked as malicious themselves
badlinks.txt	Marked as malicious by any of the above listed APIs or block-lists
denylisted.txt	Domains not marked as malicious by the above listed APIs or block-lists while actually being malicious (Deprecated)

","_postman_id":"50720b10-97af-448f-b264-7f6d6888b966","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}}},{"name":"RP","item":[{"name":"get rp status","id":"1ba635d6-ad39-40f6-991b-f7fe58d44735","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/rp","description":"

Returns the current RP-Command block status of the user

Response Body

The response will be of type BlockStatus[]

BlockStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
commands	string[]	Blocked commands
user	Snowflake or '0'	User Id of the blocked user or '0' for global

Updates the RP-Command block status of the user

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
command	string	Command name
enabled	boolean	Whether the command is enabled
userId	Snowflake or '0'	User Id of the blocked user, or '0' for global

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}},"urlObject":{"path":["@me","rp"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[]}},"response":[{"id":"9e1ad792-0ea0-4e5c-9849-1c7f9baee272","name":"Bad Request","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"command\": \"\",\r\n \"enabled\": \"\",\r\n \"userId\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/rp","description":"Updates the RP-Command block status of the user\n\n### Request Body\n\n| Key | Value Type | **Value Description** |\n| --- | --- | --- |\n| command | string | Command name |\n| enabled | boolean | Whether the command is enabled |\n| userId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) or '0' | User Id of the blocked user, or '0' for global |"},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"a8244ccc-bffd-43d1-b931-8c158fdac79a","name":"Forbidden","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"command\": \"\",\r\n \"enabled\": \"\",\r\n \"userId\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/rp","description":"Updates the RP-Command block status of the user\n\n### Request Body\n\n| Key | Value Type | **Value Description** |\n| --- | --- | --- |\n| command | string | Command name |\n| enabled | boolean | Whether the command is enabled |\n| userId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) or '0' | User Id of the blocked user, or '0' for global |"},"status":"Forbidden","code":403,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"9fb74008-ab12-4d60-a514-d6128124431d","name":"No Content","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"command\": \"\",\r\n \"enabled\": \"\",\r\n \"userId\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/rp","description":"Updates the RP-Command block status of the user\n\n### Request Body\n\n| Key | Value Type | **Value Description** |\n| --- | --- | --- |\n| command | string | Command name |\n| enabled | boolean | Whether the command is enabled |\n| userId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) or '0' | User Id of the blocked user, or '0' for global |"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"75b1988a-f830-47f1-b4d5-b98ace1787d0"},{"name":"delete rp block","id":"5d65aa6d-23a1-4a43-b05b-20919ac158cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"\",\r\n \"command\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/rp","description":"

Unblock a user from RP-Commands on this user

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
userId	Snowflake	User Id of the user to unblock
command	string	Command to unblock the user from

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}},"urlObject":{"path":["@me","rp"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[]}},"response":[{"id":"1ba6ba7e-c064-4f45-9cde-728d6f6a78cf","name":"Forbidden","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"\",\r\n \"command\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/rp","description":"Unblock a user from RP-Commands on this user\n\n### Request Body\n\n| Key | Value Type | **Value Description** |\n| --- | --- | --- |\n| userId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) | User Id of the user to unblock |\n| command | string | Command to unblock the user from |"},"status":"Forbidden","code":403,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"249244bf-99d3-4680-9078-4a9524982311","name":"Bad Request","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"\",\r\n \"command\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/rp","description":"Unblock a user from RP-Commands on this user\n\n### Request Body\n\n| Key | Value Type | **Value Description** |\n| --- | --- | --- |\n| userId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) | User Id of the user to unblock |\n| command | string | Command to unblock the user from |"},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"394a1f9d-9478-4099-86a7-792487e4b919","name":"No Content","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"\",\r\n \"command\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/rp","description":"Unblock a user from RP-Commands on this user\n\n### Request Body\n\n| Key | Value Type | **Value Description** |\n| --- | --- | --- |\n| userId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) | User Id of the user to unblock |\n| command | string | Command to unblock the user from |"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5d65aa6d-23a1-4a43-b05b-20919ac158cf"},{"name":"post rp block","id":"66258f89-8efc-4bf5-afb1-5c421d56ee29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"403{\r\n \"userId\": \"\",\r\n \"command\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/rp","description":"

Block a user from using RP-Commands on the user

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
userId	Snowflake	User Id to block
command	string	Command to block

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}},"urlObject":{"path":["@me","rp"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[]}},"response":[{"id":"8151c77a-138f-4276-9f18-76cb4a3be927","name":"Bad Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"\",\r\n \"command\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/rp","description":"Block a user from using RP-Commands on the user\n\n### Request Body\n\n| Key | Value Type | **Value Description** |\n| --- | --- | --- |\n| userId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) | User Id to block |\n| command | string | Command to block |"},"status":"Bad Request","code":400,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"59b1c835-5a65-4844-a7fc-ed57fccecf0b","name":"Forbidden","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"\",\r\n \"command\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/rp","description":"Block a user from using RP-Commands on the user\n\n### Request Body\n\n| Key | Value Type | **Value Description** |\n| --- | --- | --- |\n| userId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) | User Id to block |\n| command | string | Command to block |"},"status":"Forbidden","code":403,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"\"\r\n}"},{"id":"b5b1822b-2874-4700-8d5d-72c5e06cedb4","name":"No Content","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"\",\r\n \"command\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/rp","description":"Block a user from using RP-Commands on the user\n\n### Request Body\n\n| Key | Value Type | **Value Description** |\n| --- | --- | --- |\n| userId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) | User Id to block |\n| command | string | Command to block |"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"66258f89-8efc-4bf5-afb1-5c421d56ee29"}],"id":"a9b90913-fb5a-4607-a18e-7a5c07131da7","_postman_id":"a9b90913-fb5a-4607-a18e-7a5c07131da7","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}}},{"name":"Reminders","item":[{"name":"get own reminders","id":"a734cb09-99a0-40d5-b996-5d7f74b06685","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/reminders","description":"

Get the users reminders

Reponse Body

The response body is of type Reminder[]

Reminder

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value
id	integer	Id of the reminder
endTime	integer	end time of the reminder in milliseconds since epoch
channelId	Snowflake or 'Website'	origin of the reminder, i.e. where it was created
content	string	content of the reminder
userId	Snowflake	user Id of the owner of this reminder
startTime	integer	start time of the reminder in milliseconds since epoch

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}},"urlObject":{"path":["@me","reminders"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[]}},"response":[{"id":"63d4c566-7e47-433c-85c2-a3696dde7cce","name":"OK","originalRequest":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/reminders","description":"Get the users reminders\n\n### Reponse Body\n\nThe response body is of type `Reminder[]`\n\n### Reminder\n\n| Key | Value Type | **Value** |\n| --- | --- | --- |\n| id | integer | Id of the reminder |\n| endTime | integer | end time of the reminder in milliseconds since epoch |\n| channelId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) or 'Website' | origin of the reminder, i.e. where it was created |\n| content | string | content of the reminder |\n| userId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) | user Id of the owner of this reminder |\n| startTime | integer | start time of the reminder in milliseconds since epoch |"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"userId\": \"318453143476371456\",\r\n \"channelId\": \"Website\",\r\n \"reason\": \"My reminder\",\r\n \"startTime\": 1746178025870,\r\n \"id\": 1746178025870,\r\n \"endTime\": 1746455651230\r\n },\r\n {\r\n \"userId\": \"318453143476371456\",\r\n \"channelId\": \"298954459172700181\",\r\n \"reason\": \"My second reminder\",\r\n \"startTime\": 1746157565870,\r\n \"id\": 1746157565870,\r\n \"endTime\": 1746469651230\r\n }\r\n]"},{"id":"bad34bee-03e1-4723-97d3-82f4e5d8f0c2","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/reminders","description":"Get the users reminders\n\n### Reponse Body\n\nThe response body is of type `Reminder[]`\n\n### Reminder\n\n| Key | Value Type | **Value** |\n| --- | --- | --- |\n| id | integer | Id of the reminder |\n| endTime | integer | end time of the reminder in milliseconds since epoch |\n| channelId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) or 'Website' | origin of the reminder, i.e. where it was created |\n| content | string | content of the reminder |\n| userId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) | user Id of the owner of this reminder |\n| startTime | integer | start time of the reminder in milliseconds since epoch |"},"status":"Forbidden","code":403,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"a734cb09-99a0-40d5-b996-5d7f74b06685"},{"name":"get own reminder","id":"30f44816-170e-4392-a66d-2637ad97af70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ayakobot.com/v1/@me/reminders/:reminderId","description":"

Get a reminder of the user

Reponse Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value
id	integer	Id of the reminder
endTime	integer	end time of the reminder in milliseconds since epoch
channelId	Snowflake or 'Website'	origin of the reminder, i.e. where it was created
content	string	content of the reminder
userId	Snowflake	user Id of the owner of this reminder
startTime	integer	start time of the reminder in milliseconds since epoch

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}},"urlObject":{"path":["@me","reminders",":reminderId"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[{"type":"string","value":"Id of the reminder","key":"reminderId"}]}},"response":[{"id":"dc268fed-c7a7-4d10-b3da-624d4ad0ea3b","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/@me/reminders/:reminderId","host":["https://api.ayakobot.com/v1"],"path":["@me","reminders",":reminderId"],"variable":[{"key":"reminderId","value":"Id of the reminder","id":0}]},"description":"Get the users reminders\n\n### Reponse Body\n\nThe response body is of type `Reminder[]`\n\n### Reminder\n\n| Key | Value Type | **Value** |\n| --- | --- | --- |\n| id | integer | Id of the reminder |\n| endtime | integer | endtime of the reminder in milliseconds since epoch |\n| channelid | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) or 'Website' | origin of the reminder, i.e. where it was created |\n| content | string | content of the reminder |\n| userid | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) | user Id of the owner of this reminder |"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"userId\": \"318453143476371456\",\r\n \"channelId\": \"Website\",\r\n \"reason\": \"My reminder\",\r\n \"startTime\": 1746178025870,\r\n \"id\": 1746178025870,\r\n \"endTime\": 1746455651230\r\n}"},{"id":"a7a9bcb5-2d3d-4a04-811e-9d27ea84fed7","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/@me/reminders/:reminderId","host":["https://api.ayakobot.com/v1"],"path":["@me","reminders",":reminderId"],"variable":[{"key":"reminderId","value":"","id":0,"type":"text"}]},"description":"Get the users reminders\n\n### Reponse Body\n\nThe response body is of type `Reminder[]`\n\n### Reminder\n\n| Key | Value Type | **Value** |\n| --- | --- | --- |\n| id | integer | Id of the reminder |\n| endTime | integer | end time of the reminder in milliseconds since epoch |\n| channelId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) or 'Website' | origin of the reminder, i.e. where it was created |\n| content | string | content of the reminder |\n| userId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) | user Id of the owner of this reminder |\n| startTime | integer | start time of the reminder in milliseconds since epoch |"},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"f73811e0-4a19-47a9-b2ed-e5265573f717","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.ayakobot.com/v1/@me/reminders/:reminderId","host":["https://api.ayakobot.com/v1"],"path":["@me","reminders",":reminderId"],"variable":[{"id":0,"key":"reminderId","value":"Id of the reminder","type":"string"}]},"description":"Get a reminder of the user\n\n### Reponse Body\n\n| Key | Value Type | **Value** |\n| --- | --- | --- |\n| id | integer | Id of the reminder |\n| endTime | integer | end time of the reminder in milliseconds since epoch |\n| channelId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) or 'Website' | origin of the reminder, i.e. where it was created |\n| content | string | content of the reminder |\n| userId | [Snowflake](https://discord.com/developers/docs/reference#snowflakes) | user Id of the owner of this reminder |\n| startTime | integer | start time of the reminder in milliseconds since epoch |"},"status":"Forbidden","code":403,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"30f44816-170e-4392-a66d-2637ad97af70"},{"name":"delete own reminder","id":"c23b4997-dc21-4c42-995d-62ac26856056","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.ayakobot.com/v1/@me/reminders/:reminderId","description":"

Delete a reminder of the user

Creates a reminder for the user

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
reason	string	reason for the reminder
endTime	integer	end time of the reminder in milliseconds since epoch
startTime?*	integer	start time of the reminder in milliseconds since epoch

* if not provided a startTime will be auto-generated

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}},"urlObject":{"path":["@me","reminders"],"host":["https://api.ayakobot.com/v1"],"query":[],"variable":[]}},"response":[{"id":"137b9236-ffeb-4c3e-9c81-7c26c613dacb","name":"OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"403","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/reminders","description":"Creates a reminder for the user\n\n### Request Body\n\n| **Key** | **Value Type** | **Value Description** |\n| --- | --- | --- |\n| reason | string | reason for the reminder |\n| endTime | integer | end time of the reminder in milliseconds since epoch |\n| startTime?\\* | integer | start time of the reminder in milliseconds since epoch |\n\n\\* if not provided a startTime will be auto-generated"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"userId\": \"318453143476371456\",\r\n \"reason\": \"My reminder\",\r\n \"endTime\": 1746179646004,\r\n \"startTime\": 1746179604555,\r\n \"id\": 1746179604555,\r\n \"channelId\": \"Website\"\r\n}"},{"id":"8046b9ac-ed3d-430d-9a88-47c176717f2d","name":"Bad Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"reason\": \"\",\r\n \"endTime\": \"\",\r\n \"startTime\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/reminders","description":"Creates a reminder for the user\n\n### Request Body\n\n| **Key** | **Value Type** | **Value Description** |\n| --- | --- | --- |\n| reason | string | reason for the reminder |\n| endTime | integer | end time of the reminder in milliseconds since epoch |\n| startTime?\\* | integer | start time of the reminder in milliseconds since epoch |\n\n\\* if not provided a startTime will be auto-generated"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"d8d89c3d-0b61-48fc-8a5a-d340e27e389d","name":"Forbidden","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"reason\": \"\",\r\n \"endTime\": \"\",\r\n \"startTime\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/@me/reminders","description":"Creates a reminder for the user\n\n### Request Body\n\n| **Key** | **Value Type** | **Value Description** |\n| --- | --- | --- |\n| reason | string | reason for the reminder |\n| endTime | integer | end time of the reminder in milliseconds since epoch |\n| startTime?\\* | integer | start time of the reminder in milliseconds since epoch |\n\n\\* if not provided a startTime will be auto-generated"},"status":"Forbidden","code":403,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"cfa61b43-d43e-437c-8b4e-3301410c84a5"}],"id":"f0398cf3-0b12-492b-96c4-5da8c111b313","_postman_id":"f0398cf3-0b12-492b-96c4-5da8c111b313","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}}},{"name":"Users","item":[{"name":"find many","id":"a8968b03-4262-43e9-884f-6bae68716764","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"userIds\": [\"650691698409734151\", \"318453143476371456\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ayakobot.com/v1/users/find-many","description":"

Get multiple users by their user Id

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
userIds	Snowflake[]	array of user Ids to retrieve

Response Body

The response will be of type User[]

paragraph
short
number
boolean
multiple_choice (options field will hold choices)
single_choice (options field will hold choices)
text (cannot be answered)

\n","_postman_id":"9c515b55-671d-4d20-8563-255f03ef6ec9","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","name":"Types","type":"folder"}}},{"name":"AppealStatus","item":[],"id":"04837df8-e82a-46f9-9fe6-4dab2cd3993f","description":"

pending
accepted
rejected

\n","_postman_id":"04837df8-e82a-46f9-9fe6-4dab2cd3993f","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","name":"Types","type":"folder"}}},{"name":"ArtType","item":[],"id":"a632f804-e951-4964-8aec-bf58b82c53e0","description":"

emoji
full
icon
all

\n","_postman_id":"a632f804-e951-4964-8aec-bf58b82c53e0","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","name":"Types","type":"folder"}}},{"name":"PunishmentType","item":[],"id":"c74d39cf-27a1-45f4-9e59-54f6056eca2d","description":"

bans
channelbans
kicks
mutes
warns
tempchannelbans
tempbans
tempmutes

\n","_postman_id":"c74d39cf-27a1-45f4-9e59-54f6056eca2d","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","name":"Types","type":"folder"}}},{"name":"User","item":[],"id":"b514c40b-bfb7-4bc8-afbe-f22d624070bf","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
id	Snowflake	Id of the User
username	string	name of the user
discriminator	string	discriminator of the user
global_name	string	null
avatar_url	string	null
bot	boolean	whether the user is a bot
system	boolean	whether the user is the official Discord system user
banner_url	string	null
accent_color	string	null
verified	string	whether the user is verified
flags	integer	flags of the user
public_flags	integer	public flags of the user
avatar_decoration_data	AvatarDecorationData	null

Avatar Decoration Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value Type	Value Description
asset_url	string	URL of the avatar decoration asset
sku_id	Snowflake	Id of the avatar decorations SKU

This type is a modified version of the Discord API User Object

\n","_postman_id":"b514c40b-bfb7-4bc8-afbe-f22d624070bf","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","name":"Types","type":"folder"}}},{"name":"SettingsType","item":[],"id":"54766358-735a-41f4-bd3d-1ce7d3eeefaa","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Type Reference
channel	Snowflake
channels	Snowflake[]
role	Snowflake
roles	Snowflake[]
user	Snowflake
users	Snowflake[]
mention	Snowflake
mentions	Snowflake[]
message	Snowflake
boolean
duration	float
string
language	LanguageType
number	float
punishment	PunishmentType
antiraid-punishment	AntiraidPunishmentType
embed	Embed
bot-token	Authentication Token
token	string
message	ShopType
emote	unicode emoji or `${name}:${id}` of custom emoji
emotes	array of unicode emojis or array of `${name}:${id}` of custom emojis

","_postman_id":"54766358-735a-41f4-bd3d-1ce7d3eeefaa","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","name":"Types","type":"folder"}}},{"name":"LanguageType","item":[],"id":"8b479d3c-8d58-490b-ab77-41c706cafff5","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type
en-GB
en-US
de-DE

","_postman_id":"8b479d3c-8d58-490b-ab77-41c706cafff5","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","name":"Types","type":"folder"}}},{"name":"AntiraidPunishmentType","item":[],"id":"d738dfe4-6843-430c-9b77-c3749011327c","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type
kick
ban

","_postman_id":"d738dfe4-6843-430c-9b77-c3749011327c","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","name":"Types","type":"folder"}}},{"name":"ShopType","item":[],"id":"70c33171-c96a-45c5-9a49-af15acbdb010","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Type Description
command	Shop is command based (/shop)
message	Shop is a button on a message

","_postman_id":"70c33171-c96a-45c5-9a49-af15acbdb010","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","name":"Types","type":"folder"}}}],"id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","auth":{"type":"noauth","isInherited":false},"_postman_id":"123d1c42-ce0a-49ec-86b4-a595dc69caf5","description":""}],"id":"5f2b09a2-eb3d-443f-bf41-b83e6e06bc4e","description":"

Version 1 of the API

\n","_postman_id":"5f2b09a2-eb3d-443f-bf41-b83e6e06bc4e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]},"isInherited":true,"source":{"_postman_id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","id":"ef8c7f20-c699-42e6-bf2d-724feac5d521","name":"Ayako API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Bearer "}]}},"event":[{"listen":"prerequest","script":{"id":"41a0f3ae-436b-4a16-8027-e5495be46345","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"96978fc4-97af-4a6e-abde-a45b2019d453","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrlV1","value":"https://api.ayakobot.com/v1"},{"key":"botToken","value":"Bot ","type":"string"},{"key":"userToken","value":"Bearer ","type":"string"}]}