How to Set Up API on Janitor AI

AI in 5 Minutes
3 Nov 202303:15

TLDRThis video tutorial guides viewers on setting up an API with Janitor AI. It starts with registration and character creation, including uploading an avatar and defining character attributes. The focus then shifts to API configuration, selecting Open AI, obtaining an API key from open.com, and finally integrating it with Janitor AI. Custom prompts and preset settings are also discussed for a tailored experience.

Takeaways

  • 😀 Visit the Janitor AI website to start the process of setting up an API.
  • 🌐 You must log in or register a new account, with options like Google or Discord available for registration.
  • 👤 Create a character on Janitor AI by uploading an avatar, choosing the character’s gender, and setting the character to public or private.
  • 📜 Define the character’s attributes and scenario, and add example dialogues.
  • 🔑 For API setup, select the OpenAI model and provide an OpenAI API key, either your own or via a reverse proxy.
  • 🔗 To obtain an OpenAI API key, visit open.com, log in, and create a new secret key.
  • 🖥 Once you have the API key, return to Janitor AI and input the key in the appropriate section to link your character to the API.
  • ✔️ Verify the API key on Janitor AI to ensure it's working properly before proceeding.
  • 🛠 Customize the API interaction by adding custom prompts or selecting from preset options.
  • 💾 Save your settings on Janitor AI to complete the setup of your API.

Q & A

  • What is the first step in setting up an API on Janitor AI?

    -The first step is to head over to Janitor AI and log in or register for a new account, continuing with Google or Discord.

  • How do you create a character on Janitor AI?

    -After logging in, go to 'My Characters', and if you don't have a character, hit 'Create a Character'. Then, upload an avatar image, choose the gender, type (public or private), rating (limited or limitless), character definition, scenario, and add example dialogues.

  • What are the necessary components to create a character on Janitor AI?

    -You need to upload an avatar image, select the gender, choose whether it's a public or private character, set a rating (limited or limitless), define the character, choose a scenario, and add example dialogues.

  • How do you access the API setup for your character?

    -Once the character is created, go to 'My Characters', click on the character, and then click 'Chat with it'. When it loads, you will see an option saying 'API not ready', click on it to set up the API.

  • Which API is suggested in the video for use with Janitor AI?

    -The video suggests using the Open AI API for setting up the API on Janitor AI.

  • How do you obtain an Open AI API key?

    -To get an Open AI API key, visit open.com, log in with your Google account, go to 'API', and then to 'Personal or View API Keys'. From there, create a new secret key and copy it once generated.

  • What is the purpose of the Open AI API key in the Janitor AI setup?

    -The Open AI API key is used to connect your Janitor AI character with the Open AI services, allowing you to use the advanced features and capabilities of the Open AI platform.

  • After obtaining the Open AI API key, what is the next step in the Janitor AI API setup?

    -Go back to Janitor AI, click on 'Open AI key', and paste the copied API key. Then, check the API key to ensure it's valid.

  • Can you customize the API settings for your Janitor AI character?

    -Yes, you can add a custom prompt and choose a preset, such as 'default', to tailor the character's responses and behavior according to your preferences.

  • What should you do after setting the custom prompt and choosing a preset?

    -After setting the custom prompt and choosing a preset, click 'Save Settings' to apply the changes to your character's API configuration.

  • How does the video conclude?

    -The video concludes by thanking the viewer for watching and bidding them goodbye.

Outlines

00:00

🚀 Setting Up an API with Janitor AI

The video begins by introducing the process of setting up an API using Janitor AI. The first step involves navigating to the Janitor AI website and either logging in or registering for a new account, continuing with Google or Discord. Once registered, the user is instructed to access the 'My Characters' section, ensuring they have a character or creating one by uploading an avatar image, selecting the gender, and choosing whether the character is for public or private use. The character's definition and scenario are also set, along with example dialogues. After creating the character, the user is guided to set up the API by selecting the desired API, in this case, OpenAI, and obtaining an API key from OpenAI's website. The key is then pasted into Janitor AI, and the API is checked for functionality. Finally, custom prompts can be added, and settings are saved to complete the API setup.

Mindmap

Keywords

💡API

API stands for Application Programming Interface, which is a set of rules and protocols used for building software and applications. In the context of the video, setting up an API for Janitor AI involves creating a bridge that allows different software to communicate with each other, enabling the use of Janitor AI's features in other platforms or applications. The script guides the user through the process of selecting an API and configuring it with Janitor AI to establish this communication.

💡Janitor AI

Janitor AI appears to be the name of a platform or service that offers AI-driven capabilities, likely for chatbots or virtual characters. Throughout the video, the main theme revolves around setting up an API for this service, which suggests that Janitor AI provides a way for users to create and manage virtual characters that can interact with users through an API interface. The video's instructions detail the steps required to register, create a character, and set up the API for further integration and use.

💡Register

The term 'register' refers to the process of creating an account or signing up for a service. In the video, the first step to set up an API on Janitor AI is to register for a new account. This is a standard procedure for most online platforms and involves providing necessary information such as an email address, username, and password. Registration is essential to gain access to the platform's features and services, such as creating characters and setting up APIs.

💡Character

In the context of the video, a 'character' likely refers to a virtual entity or chatbot that users can create and customize on the Janitor AI platform. The creation of a character involves uploading an avatar image, selecting gender, and defining other attributes such as whether the character is public or private. The character is central to the video's theme as it is the entity with which users will interact via the API once it is set up.

💡Avatar Image

An 'avatar image' is a visual representation or icon used to depict a user or a character in digital spaces. In the video, users are instructed to upload an avatar image for their character on Janitor AI. This image helps to personalize the character and make it more relatable and engaging for users. The avatar image is an essential part of creating a character on the platform and is used in conjunction with the API to provide a more immersive and interactive experience.

💡Gender

The term 'gender' refers to the characteristics pertaining to the sex of a character, typically male or female, though it can also encompass non-binary and other gender identities. In the video, when creating a character on Janitor AI, users are required to choose a gender for their virtual character. This choice contributes to the character's identity and can influence the interactions and dialogues that the character engages in with users through the API.

💡Public/Private

In the context of the video, 'public' and 'private' refer to the accessibility settings for the virtual character. A public character can be accessed and interacted with by anyone, whereas a private character is restricted to certain users or requires specific permissions. This distinction is important when setting up the API, as it determines who can access and use the character's functionalities and data.

💡Rating

The 'rating' in the video script likely refers to the content rating of the virtual character, indicating the type of interactions and dialogues that are appropriate for the character. The options 'limited' or 'limitless' suggest a range of restrictions on the character's behavior and the topics it can discuss. This rating is crucial when setting up the API, as it ensures that the character's interactions adhere to the predefined content guidelines.

💡Scenario

A 'scenario' in the context of the video refers to a specific situation or context in which the virtual character is designed to operate. When creating a character on Janitor AI, users are asked to choose a scenario that defines the character's purpose and the type of interactions it will engage in. This is important for the API setup as it helps to tailor the character's responses and behavior to the intended use case.

💡Example Dialogues

Example dialogues are pre-defined conversation snippets or scripts that a virtual character might use when interacting with users. In the video, users are instructed to add example dialogues for their character on Janitor AI. These dialogues serve as a guide for the character's responses and help to shape the character's personality and communication style. They are particularly useful when setting up the API, as they provide a foundation for the character's interactions with users through the API interface.

💡Access Key

An 'access key' is a unique identifier or token that grants access to a specific service or API. In the video, users are guided to obtain an OpenAI access key, which is required to connect and use the OpenAI model within Janitor AI. The access key is a crucial component of the API setup process, as it authenticates requests to the API and ensures that the user has the necessary permissions to utilize the service.

💡Custom Prompt

A 'custom prompt' refers to a user-defined input or message that initiates a specific response or action from an AI system. In the video, after setting up the API and the OpenAI model, users are given the option to add a custom prompt. This allows for personalized interactions with the virtual character through the API, tailoring the character's responses to the user's preferences or requirements.

Highlights

Learn how to set up an API using Janitor AI.

Begin by logging into Janitor AI or registering a new account.

Choose to continue with Google or Discord for registration.

Navigate to 'My Characters' from the top right menu.

Create a new character if you don't have one.

Upload an avatar image and select the gender for your character.

Choose whether your character is public or private and set its rating.

Select the character definition and choose the scenario.

Add example dialogues to your character's profile.

After creating the character, set up the API from the 'My Characters' section.

Click on 'Chat with it' and wait for the loading.

Find the 'API not ready' option and click to set up the desired API.

Select 'Open AI' as the API and input your Open AI API key.

If you have your own key, use it; otherwise, use a reverse proxy.

Go to open.com, log in with your Google account, and create a new secret key.

Copy the new API key and head back to Janitor AI to paste it.

Check the API key and add a custom prompt if desired.

Choose a preset or customize settings to complete the API setup.

The video concludes by thanking viewers for watching.