Skip to content

Latest commit

 

History

History
51 lines (29 loc) · 3.68 KB

README.md

File metadata and controls

51 lines (29 loc) · 3.68 KB

zukijourney-api <--> V2.5 Documentation

NOTE: Maintenance of this documentation has now moved to

--> https://docs.zukijourney.com/ai

Welcome to the zukijourney api -- the largest multi-ai api of its kind! This guide provides a comprehensive overview of all essential facets of the API's operation. The documentation is generally kept 100% up-to-date and should be regarded as the definitive source of information.

You can compare us to other APIs, as provided by our other list https://github.com/zukixa/cool-ai-stuff , but it is very clear from that list that we are #1 :)

This API was developed to mirror the full capabilitie and formatting of the OpenAI API. Consequently, the OpenAI API documentation is equally valid here. For accessing our API, simply use the OpenAI client in the following way: OpenAI(base_url="https://api.zukijourney.com/v1",api_key='zu-...'). Please note, formats such as Anthropic's v1/complete are not, and will not be supported.

Upfront...

  • The API is open source! Explore our V2 codebase here: API-OSS
  • The current release, version 2.5, exhibits minor differences that are mostly imperceptible.
  • While we do not provide a ZJ-made user interface, commonly utilized interfaces include BetterGPT and LibreChat
  • The usage rates are fixed at 4 requests per minute per key per IP for the /unf/ endpoints, and 12 requests per minute per key per IP for the /v1/ endpoints. These limits are in place to prevent DDOS attacks and abuse.
  • All models are available on https://api.zukijourney.com/v1/models , and for the roleplay-models, they are over here https://api.zukijourney.com/unf/models
  • All models are courtesy of their respective owners, as listed in v1/models. We do not own, control, or have affiliations with these entities.

Everything may be fabricated and therefore not real, I am unaware of any illegal activities, documentation will not be taken as admission of guilt.

Table of Contents

Code-Samples

API Quirks & Weirdnesses

ZukiJourney's Token System

Donate for Higher Tiers

  • A reminder that you can either donate on KoFi with nearly every payment method possible, or you can join the zukijourney discord server, go to the tickets channel, and coordinate a purchase via crypto!

  • You can see the benefits you can receive here: Benefits Table

  • Remember, you also receive benefits from the zuki.gm bot, which can be seen here on the Discord Server

Obtaining Your Api-Key

  • Generate Key: To get your Api-Key, simply use the /key command with zuki.api. Below is a gif demonstrating how to do it:

    Using /key Command

  • Gamble Your Credits: Feel adventurous? You can gamble your credit amount using the /gamble command. This feature is a nod to stake.com.

Credits

Thank you to @Leander, @voidii, @perl, @sobhansajjadii, @Lukinhas, @Launchers, and @sabsterrexx for being the best people from the AI sphere. Y'all were the inspiration, and my continued motivation, for all this <3
~zukixa