Skip to content

Commit c7ecc76

Browse files
a3ryka3ryk
committed
Improved the documentation
1 parent 9ed3bcf commit c7ecc76

File tree

3 files changed

+170
-174
lines changed

3 files changed

+170
-174
lines changed

‎pages/faq.mdx

Lines changed: 75 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,80 @@
1-
## FREQUENTLY ASKED QUESTIONS
1+
# **Frequently Asked Questions (FAQ)**
22

3-
<br />
3+
### **How do I get an API token?**
44

5-
### How do I get the API token?
6-
- To get your API token, just login to [dashboard](https://waifu.it/dashboard)
5+
To obtain your API token, simply log in to the **[Waifu.it Dashboard](https://waifu.it/dashboard)**.
76

8-
{/* ### CORS causing trouble?
7+
---
98

10-
<details>
11-
<summary>Use the Waifuit CORS proxy.</summary>
12-
Append the source link for the media to `https://cors.waifuit.stream/`, like so:
13-
```
14-
https://cors.waifuit.stream/<SOURCE_LINK>
15-
```
16-
</details> */}
9+
### **How can I support the project?**
1710

18-
### How can I support the project?
19-
- Contribute to the [API](https://github.com/WaifuAPI/Waifu.it)
20-
- Donate me via [Ko-fi](https://ko-fi.com/Aeryk)
21-
- Give feedback or suggestions in [discord server](https://discord.gg/yyW389c).
11+
We appreciate any form of support! Here’s how you can help:
12+
13+
- ⭐ **Contribute** to the API on **[GitHub](https://github.com/WaifuAPI/Waifu.it)**.
14+
- ☕ **Donate** via **[Ko-fi](https://ko-fi.com/Aeryk)** to help with server costs.
15+
- 💬 **Share your feedback** or suggest improvements in our **[Discord server](https://discord.gg/yyW389c)**.
16+
17+
---
18+
19+
### **What happens if I run out of quota?**
20+
21+
If you exhaust your quota, you’ll receive a **403 Forbidden** error. To continue using the API, you’ll need to **earn more quota** (see the next question for details).
22+
23+
You can check your available quota using:
24+
25+
- **`-profile <discord_user_id>`** (Discord command).
26+
- The **Waifu.it Dashboard** for real-time quota tracking.
27+
28+
---
29+
30+
### **How can I earn more API quota?**
31+
32+
You can earn quota in multiple ways:
33+
34+
#### **1. Starring or Following Our GitHub Repositories**
35+
36+
Earn **150 quota** per star when you star our GitHub repositories!
37+
38+
- **⚠️ Note:** Removing the star will revoke the corresponding quota.
39+
- **🛠️ How to Redeem:** Create a ticket to claim your quota.
40+
- **📂 GitHub Repositories:**
41+
- **Organization:** [Click here](https://github.com/WaifuAPI)
42+
- **API:** [Click here](https://github.com/WaifuAPI/api)
43+
- **Website:** [Click here](https://github.com/WaifuAPI/website)
44+
- **Documentation:** [Click here](https://github.com/WaifuAPI/documentation)
45+
46+
#### **2. Donating**
47+
48+
Support our API and help keep it running! By donating, you can receive **bonus quota** and other perks.
49+
50+
- **📈 Quota Increase:** Varies based on the donation amount.
51+
- **🎖️ Additional Benefits:**
52+
- Special **donator role** in our Discord server.
53+
- **Access to premium endpoints** and exclusive features.
54+
- **Early access** to upcoming cool features.
55+
- **🛠️ How to Redeem:** Create a ticket after donating to claim your quota.
56+
57+
#### **3. Upgrading to a Premium Plan**
58+
59+
For users who need a **higher quota limit** with additional benefits, we offer premium plans!
60+
61+
- **🚀 Basic Plan - $5/month:**
62+
- **X monthly quota**
63+
- **Access to premium endpoints**
64+
- **Priority support**
65+
- **🌟 Pro Plan - $15/month:**
66+
- **X monthly quota**
67+
- **Faster API response times**
68+
- **Access to exclusive beta features**
69+
- **🔥 Ultimate Plan - $30/month:**
70+
71+
- **X monthly quota**
72+
- **Highest API priority**
73+
- **Custom API limits upon request**
74+
- **Personalized support**
75+
76+
- **💳 How to Subscribe:** Visit the **Waifu.it Discord** and create a ticket.
77+
78+
---
79+
80+
With these methods, you can continue using Waifu.it **without running out of quota!** 🎉 Need more help? Join our **[Discord server](https://discord.gg/yyW389c)** for assistance! 🚀

‎pages/index.mdx

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1-
# Introduction
1+
# **🌸 Welcome to Waifu.it Documentation!**
22

3-
Welcome to the documentation for Waifu.it, a comprehensive API that offers a wealth of anime-related information spanning various entertainment mediums, including anime, manga, light novels, and movies. Additionally, it provides direct links to these contents from publicly accessible online sources. This documentation aims to guide you on how to effectively utilize the API, which can be accessed at [https://waifu.it](https://waifu.it).
3+
Your ultimate source for **anime-related content**! 🎉 Waifu.it provides seamless access to a vast collection of data spanning **anime, manga, light novels, and movies**, along with direct links to publicly available sources.
4+
5+
## **Why Use Waifu.it?**
6+
7+
✅ **Comprehensive Database** – Fetch detailed information on characters, series, and more.
8+
✅ **Lightning-Fast Responses** – Optimized for speed and efficiency.
9+
✅ **Easy Integration** – Perfect for Discord bots, websites, and AI-powered projects.
10+
11+
📌 **API Documentation:**
12+
🌐 **[https://waifu.it](https://waifu.it)**
13+
14+
Get started today and bring your anime-related projects to life effortlessly! 🚀

‎pages/list-of-endpoints.mdx

Lines changed: 82 additions & 156 deletions
Original file line numberDiff line numberDiff line change
@@ -1,156 +1,82 @@
1-
2-
## List of Endpoints
3-
4-
Waifu.it supports a wealth of endpoints, which can be categorized into the following groups:
5-
6-
### Interactions
7-
8-
- [Angry](https://docs.waifu.it/rest-api/Interactions/Angry/search): This endpoint retrieves a random anime GIF that portrays an angry reaction.
9-
10-
- [Baka](https://docs.waifu.it/rest-api/Interactions/Baka/search): Get a random anime GIF that represents the expression of being a "baka" or an idiot.
11-
12-
- [Bite](https://docs.waifu.it/rest-api/Interactions/Bite/search): Explore a random anime GIF that showcases a biting action.
13-
14-
- [Blush](https://docs.waifu.it/rest-api/Interactions/Blush/search): Get a random anime GIF showcasing a blushing expression.
15-
16-
- [Bonk](https://docs.waifu.it/rest-api/Interactions/Bonk/search): Obtain a random anime GIF capturing a bonking action.
17-
18-
- [Bored](https://docs.waifu.it/rest-api/Interactions/Bored/search): This endpoint provides a random anime GIF displaying a bored expression.
19-
20-
- [Bully](https://docs.waifu.it/rest-api/Interactions/Bully/search): Retrieve a random anime GIF that illustrates a bullying action.
21-
22-
- [Bye](https://docs.waifu.it/rest-api/Interactions/Bye/search): Obtain a random anime GIF depicting a goodbye gesture.
23-
24-
- [Chase](https://docs.waifu.it/rest-api/Interactions/Chase/search): Get a random anime GIF showcasing a chasing action.
25-
26-
- [Cheer](https://docs.waifu.it/rest-api/Interactions/Cheer/search): Retrieve a random anime GIF representing a cheering expression.
27-
28-
- [Cringe](https://docs.waifu.it/rest-api/Interactions/Cringe/search): This endpoint returns a random anime GIF with a cringing reaction.
29-
30-
- [Cry](https://docs.waifu.it/rest-api/Interactions/Cry/search): Get a random anime GIF with a crying reaction.
31-
32-
- [Cuddle](https://docs.waifu.it/rest-api/Interactions/Cuddle/search): Obtain a random anime GIF depicting a cuddling action.
33-
34-
- [Dab](https://docs.waifu.it/rest-api/Interactions/Dab/search): Get a random anime GIF with a dabbing action.
35-
36-
- [Dance](https://docs.waifu.it/rest-api/Interactions/Dance/search): Retrieve a random anime GIF featuring a dancing action.
37-
38-
- [Die](https://docs.waifu.it/rest-api/Interactions/Die/search): Obtain a random anime GIF depicting a dying action.
39-
40-
- [Disgust](https://docs.waifu.it/rest-api/Interactions/Disgust/search): Get a random anime GIF with a disgusted reaction.
41-
42-
- [Facepalm](https://docs.waifu.it/rest-api/Interactions/Facepalm/search): Retrieve a random anime GIF depicting a facepalm reaction.
43-
44-
- [Feed](https://docs.waifu.it/rest-api/Interactions/Feed/search): Get a random anime GIF with a feeding action.
45-
46-
- [Glomp](https://docs.waifu.it/rest-api/Interactions/Glomp/search): Retrieve a random anime GIF featuring a glomping action.
47-
48-
- [Happy](https://docs.waifu.it/rest-api/Interactions/Happy/search): Obtain a random anime GIF showcasing a happy expression.
49-
50-
- [Hi](https://docs.waifu.it/rest-api/Interactions/Hi/search): Get a random anime GIF with a greeting gesture.
51-
52-
- [Highfive](https://docs.waifu.it/rest-api/Interactions/Highfive/search): Retrieve a random anime GIF capturing a high five action.
53-
54-
- [Hold](https://docs.waifu.it/rest-api/Interactions/Hold/search): Obtain a random anime GIF depicting a holding action.
55-
56-
- [Hug](https://docs.waifu.it/rest-api/Interactions/Hug/search): Get a random anime GIF featuring a hugging action.
57-
58-
- [Kick](https://docs.waifu.it/rest-api/Interactions/Kick/search): Retrieve a random anime GIF showcasing a kicking action.
59-
60-
- [Kill](https://docs.waifu.it/rest-api/Interactions/Kill/search): Obtain a random anime GIF with a killing action.
61-
62-
- [Kiss](https://docs.waifu.it/rest-api/Interactions/Kiss/search): Get a random anime GIF depicting a kissing action.
63-
64-
- [Laugh](https://docs.waifu.it/rest-api/Interactions/Laugh/search): Retrieve a random anime GIF showcasing a laughing reaction.
65-
66-
- [Lick](https://docs.waifu.it/rest-api/Interactions/Lick/search): Obtain a random anime GIF with a licking action.
67-
68-
- [Love](https://docs.waifu.it/rest-api/Interactions/Love/search): Get a random anime GIF depicting a loving expression.
69-
70-
- [Lurk](https://docs.waifu.it/rest-api/Interactions/Lurk/search): Retrieve a random anime GIF featuring a lurking action.
71-
72-
- [Midfing](https://docs.waifu.it/rest-api/Interactions/Midfing/search): This endpoint returns a random anime GIF with a middle finger gesture.
73-
74-
- [Nervous](https://docs.waifu.it/rest-api/Interactions/Nervous/search): Get a random anime GIF portraying a nervous expression.
75-
76-
- [Nom](https://docs.waifu.it/rest-api/Interactions/Nom/search): Retrieve a random anime GIF showcasing a nomming action.
77-
78-
- [Nope](https://docs.waifu.it/rest-api/Interactions/Nope/search): Obtain a random anime GIF representing a "nope" reaction.
79-
80-
- [Nuzzle](https://docs.waifu.it/rest-api/Interactions/Nuzzle/search): Get a random anime GIF depicting a nuzzling action.
81-
82-
- [Panic](https://docs.waifu.it/rest-api/Interactions/Panic/search): Retrieve a random anime GIF showing a panic reaction.
83-
84-
- [Pat](https://docs.waifu.it/rest-api/Interactions/Pat/search): Get a random anime GIF featuring a patting action.
85-
86-
- [Peck](https://docs.waifu.it/rest-api/Interactions/Peck/search): Retrieve a random anime GIF showcasing a pecking action.
87-
88-
- [Poke](https://docs.waifu.it/rest-api/Interactions/Poke/search): Obtain a random anime GIF with a poking action.
89-
90-
- [Pout](https://docs.waifu.it/rest-api/Interactions/Pout/search): Get a random anime GIF featuring a pouting expression.
91-
92-
- [Punch](https://docs.waifu.it/rest-api/Interactions/Punch/search): Retrieve a random anime GIF illustrating a punching action.
93-
94-
- [Run](https://docs.waifu.it/rest-api/Interactions/Run/search): Get a random anime GIF showcasing a running action.
95-
96-
- [Sad](https://docs.waifu.it/rest-api/Interactions/Sad/search): Retrieve a random anime GIF representing a sad expression.
97-
98-
- [Shoot](https://docs.waifu.it/rest-api/Interactions/Shoot/search): This endpoint returns a random anime GIF depicting a shooting action.
99-
100-
- [Shrug](https://docs.waifu.it/rest-api/Interactions/Shrug/search): Get a random anime GIF with a shrugging gesture.
101-
102-
- [Sip](https://docs.waifu.it/rest-api/Interactions/Sip/search): Retrieve a random anime GIF showcasing a sipping action.
103-
104-
- [Slap](https://docs.waifu.it/rest-api/Interactions/Slap/search): Obtain a random anime GIF illustrating a slapping action.
105-
106-
- [Sleepy](https://docs.waifu.it/rest-api/Interactions/Sleepy/search): Get a random anime GIF featuring a sleepy expression.
107-
108-
- [Smile](https://docs.waifu.it/rest-api/Interactions/Smile/search): Retrieve a random anime GIF with a smiling expression.
109-
110-
- [Smug](https://docs.waifu.it/rest-api/Interactions/Smug/search): Get a random anime GIF showcasing a smug expression.
111-
112-
- [Stab](https://docs.waifu.it/rest-api/Interactions/Stab/search): Obtain a random anime GIF depicting a stabbing action.
113-
114-
- [Stare](https://docs.waifu.it/rest-api/Interactions/Stare/search): Get a random anime GIF featuring a staring expression.
115-
116-
- [Suicide](https://docs.waifu.it/rest-api/Interactions/Suicide/search): Retrieve a random anime GIF related to suicide Interactions.
117-
118-
- [Tease](https://docs.waifu.it/rest-api/Interactions/Tease/search): Obtain a random anime GIF with a teasing action.
119-
120-
- [Think](https://docs.waifu.it/rest-api/Interactions/Think/search): Get a random anime GIF showcasing a thinking expression.
121-
122-
- [Thumbsup](https://docs.waifu.it/rest-api/Interactions/Thumbsup/search): Retrieve a random anime GIF with a thumbs-up gesture.
123-
124-
- [Tickle](https://docs.waifu.it/rest-api/Interactions/Tickle/search): Get a random anime GIF illustrating a tickling action.
125-
126-
- [Triggered](https://docs.waifu.it/rest-api/Interactions/Triggered/search): Obtain a random anime GIF representing a triggered reaction.
127-
128-
- [Wag](https://docs.waifu.it/rest-api/Interactions/Wag/search): Get a random anime GIF showcasing a wagging action.
129-
130-
- [Wave](https://docs.waifu.it/rest-api/Interactions/Wave/search): Get a random anime GIF with a waving gesture.
131-
132-
- [Wink](https://docs.waifu.it/rest-api/Interactions/Wink/search): Obtain a random anime GIF featuring a winking expression.
133-
134-
- [Yes](https://docs.waifu.it/rest-api/Interactions/Yes/search): Get a random anime GIF expressing a positive affirmation.
135-
136-
137-
### Images
138-
139-
- [Waifu:](https://docs.waifu.it/rest-api/Images/Waifu/search) Immerse yourself in the captivating world of anime with the Waifu endpoint.
140-
- [Husbando:](https://docs.waifu.it/rest-api/Images/Husbando/search) Get yourself a good and cool looking husbando.
141-
142-
### Texts
143-
144-
- [Fact](https://docs.waifu.it/rest-api/Texts/Fact/search): Retrieve a random anime fact to expand your knowledge.
145-
146-
- [Password](https://docs.waifu.it/rest-api/Texts/Password/generate): Generate a unique and secure `base64` string for password purposes.
147-
148-
- [Quote](https://docs.waifu.it/rest-api/Texts/Quote/search): Discover an inspiring or memorable anime quote to motivate or entertain you.
149-
150-
- [Tags](https://docs.waifu.it/rest-api/Texts/Tags/search): Get a list of available tags that can be used for specific queries in certain endpoints.
151-
152-
- [Owoify](https://docs.waifu.it/rest-api/Texts/Owoify/generate): The text you want to convert into an "owo" language-style format.
153-
154-
- [Uvuify](https://docs.waifu.it/rest-api/Texts/Uvuify/generate): Convert the provided text into the style of the "uvu" language.
155-
156-
- [Uwuify](https://docs.waifu.it/rest-api/Texts/Uwuify/generate): Transforming the given text into the "uwu" language-style format is what you desire.
1+
## **List of Endpoints**
2+
3+
Waifu.it offers a rich collection of API endpoints, thoughtfully categorized to enhance user experience and functionality:
4+
5+
- **🌀 Interactions** – Power dynamic engagements with interactive features.
6+
- **🖼️ Images** – Access a vast library of stunning anime artwork.
7+
- **📝 Texts** – Retrieve, generate, and explore captivating text-based content.
8+
9+
Unlock limitless possibilities with Waifu.it’s API and bring your projects to life! 🚀
10+
11+
---
12+
13+
### 🌀 Interactions
14+
15+
Retrieve random anime GIFs representing various emotions and actions.
16+
17+
- **[Angry](https://docs.waifu.it/rest-api/Interactions/Angry/search)** – Express frustration with an angry reaction.
18+
- **[Baka](https://docs.waifu.it/rest-api/Interactions/Baka/search)** – Playfully call someone an idiot.
19+
- **[Bite](https://docs.waifu.it/rest-api/Interactions/Bite/search)** – Show affection or aggression with a bite.
20+
- **[Blush](https://docs.waifu.it/rest-api/Interactions/Blush/search)** – Display embarrassment with a blush.
21+
- **[Bonk](https://docs.waifu.it/rest-api/Interactions/Bonk/search)** – Knock some sense into someone.
22+
- **[Bored](https://docs.waifu.it/rest-api/Interactions/Bored/search)** – Express boredom.
23+
- **[Bully](https://docs.waifu.it/rest-api/Interactions/Bully/search)** – Engage in lighthearted teasing.
24+
- **[Bye](https://docs.waifu.it/rest-api/Interactions/Bye/search)** – Wave farewell.
25+
- **[Chase](https://docs.waifu.it/rest-api/Interactions/Chase/search)** – Run after someone.
26+
- **[Cheer](https://docs.waifu.it/rest-api/Interactions/Cheer/search)** – Show enthusiasm and support.
27+
- **[Cringe](https://docs.waifu.it/rest-api/Interactions/Cringe/search)** – React to something awkward.
28+
- **[Cry](https://docs.waifu.it/rest-api/Interactions/Cry/search)** – Express sadness.
29+
- **[Cuddle](https://docs.waifu.it/rest-api/Interactions/Cuddle/search)** – Share a warm embrace.
30+
- **[Dab](https://docs.waifu.it/rest-api/Interactions/Dab/search)** – Show off a stylish dab move.
31+
- **[Dance](https://docs.waifu.it/rest-api/Interactions/Dance/search)** – Express joy through dance.
32+
- **[Facepalm](https://docs.waifu.it/rest-api/Interactions/Facepalm/search)** – React to something foolish.
33+
- **[Feed](https://docs.waifu.it/rest-api/Interactions/Feed/search)** – Offer food to someone.
34+
- **[Glomp](https://docs.waifu.it/rest-api/Interactions/Glomp/search)** – Enthusiastically tackle someone in a hug.
35+
- **[Happy](https://docs.waifu.it/rest-api/Interactions/Happy/search)** – Share a cheerful expression.
36+
- **[Hi](https://docs.waifu.it/rest-api/Interactions/Hi/search)** – Say hello with a friendly wave.
37+
- **[Highfive](https://docs.waifu.it/rest-api/Interactions/Highfive/search)** – Celebrate with a high five.
38+
- **[Hug](https://docs.waifu.it/rest-api/Interactions/Hug/search)** – Show affection with a heartfelt hug.
39+
- **[Kick](https://docs.waifu.it/rest-api/Interactions/Kick/search)** – Deliver a swift kick.
40+
- **[Kill](https://docs.waifu.it/rest-api/Interactions/Kill/search)** – (Fictionally) eliminate someone dramatically.
41+
- **[Kiss](https://docs.waifu.it/rest-api/Interactions/Kiss/search)** – Share a loving kiss.
42+
- **[Laugh](https://docs.waifu.it/rest-api/Interactions/Laugh/search)** – Burst into laughter.
43+
- **[Lick](https://docs.waifu.it/rest-api/Interactions/Lick/search)** – Playfully lick someone.
44+
- **[Love](https://docs.waifu.it/rest-api/Interactions/Love/search)** – Express deep affection.
45+
- **[Nuzzle](https://docs.waifu.it/rest-api/Interactions/Nuzzle/search)** – Show fondness by rubbing affectionately.
46+
- **[Pat](https://docs.waifu.it/rest-api/Interactions/Pat/search)** – Comfort someone with a gentle pat.
47+
- **[Poke](https://docs.waifu.it/rest-api/Interactions/Poke/search)** – Get someone’s attention with a poke.
48+
- **[Punch](https://docs.waifu.it/rest-api/Interactions/Punch/search)** – Throw a strong punch.
49+
- **[Run](https://docs.waifu.it/rest-api/Interactions/Run/search)** – Dash away in a hurry.
50+
- **[Slap](https://docs.waifu.it/rest-api/Interactions/Slap/search)** – Deliver a sharp slap.
51+
- **[Smile](https://docs.waifu.it/rest-api/Interactions/Smile/search)** – Show a bright and cheerful smile.
52+
- **[Wave](https://docs.waifu.it/rest-api/Interactions/Wave/search)** – Greet someone with a friendly wave.
53+
- **[Wink](https://docs.waifu.it/rest-api/Interactions/Wink/search)** – Flirt or tease with a wink.
54+
- **[Yes](https://docs.waifu.it/rest-api/Interactions/Yes/search)** – Express strong approval.
55+
56+
For the complete list of interaction endpoints, visit their respective documentation pages.
57+
58+
---
59+
60+
### 🎨 Images
61+
62+
Discover stunning anime artwork and character portraits.
63+
64+
- **[Waifu](https://docs.waifu.it/rest-api/Images/Waifu/search)** – Find captivating waifus.
65+
- **[Husbando](https://docs.waifu.it/rest-api/Images/Husbando/search)** – Discover charming husbandos.
66+
67+
---
68+
69+
### 📜 Texts
70+
71+
Get fascinating anime-related text content.
72+
73+
- **[Fact](https://docs.waifu.it/rest-api/Texts/Fact/search)** – Learn a random anime fact.
74+
- **[Quote](https://docs.waifu.it/rest-api/Texts/Quote/search)** – Discover inspiring anime quotes.
75+
- **[Tags](https://docs.waifu.it/rest-api/Texts/Tags/search)** – Retrieve a list of tags for filtering results.
76+
- **[Owoify](https://docs.waifu.it/rest-api/Texts/Owoify/generate)** – Convert text into a cute “owo” style.
77+
- **[Uwuify](https://docs.waifu.it/rest-api/Texts/Uvuify/generate)** – Transform text into an adorable “uwu” format.
78+
- **[Password](https://docs.waifu.it/rest-api/Texts/Password/generate)** – Generate a secure Base64 password.
79+
80+
---
81+
82+
For more details, visit their respective documentation pages or explore the [Waifu.it API](https://waifu.it).

0 commit comments

Comments
 (0)