zukixa / zukijourney-api

The Hub of the zukijourney API!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

zukijourney-api

The zukijourney API has been a rising star in the API sphere, amassing to over 400 million requests already, despite only being about 3 months old! With nearly 4k concurrent active users, the API has proven reliable, sturdy, and splendid for any AI usage! :) -- and has become the largest API of its kind!

Especially, as seen by its cloudflare statistics over the last month:

image

Zukijourney API Documentation

This documentation includes details about the zukijourney API that helps in creating and managing the API resources.

Base URL

The base URL is https://zukijourney.xyzbot.net/

Endpoints

POST /v1/audio/speech

Generates audio based on the text input provided.

Request Body: { "input": "" }

POST /v1/embeddings

Generates embeddings for the provided text.

Request Body: { "input": "" }

POST /v1/audio/transcriptions

Transcribes an audio file and returns the transcription text. Request Body: { "file": "" }

GET /v1/models

Lists all the available models with their details such as model id, endpoints, owners, and more.

GET /

Default endpoint that greets the API user.

POST /v1/chat/tokenizer

Takes a TokenizerInput object and returns the number of tokens that would be used by the model.

Request Body: { "model": "<model_name>", "messages": [<message_object>] }

POST /v1/images/generations

Generates images based on the provided text prompt.

(Some of the) Models available can be found here

Request Body: { "prompt": "", "n": "<number_of_images>", "size": "<image_size>", "model": "<model_name>" }

GET /v1/images/{image_uuid}.{ext}

Retrieves the image with the given UUID and extension.

POST /v1/chat/completions (or unf/chat/completions for roleplay.)

Generates text completions based on the provided text.

(Some of the) Models available can be found here

Request Body: { "stream": "", "model": "", "messages": "", }

Error Messages

The API uses error messages to inform the client of any issues with the request. Error messages are included in the response body in the following format:

{ "error": { "message": "<error_message>", "type": "<error_type>", "param": "<error_param>", "tip": "<error_tip>", "code": "<error_code>", } }

How to Get an API Key

Join the zukijourney server, as described below! Run the /key command with the @zuki.api bot -- and you'll be good to go!

Legal Stuff

This project is for educational purposes only, and in no mere admission of guilt of any supposed wrongdoing that this project may be accused of causing. All operations have been certified to be fully legal and legitimate, in the case that odd accusations would be provided. Any work I do may be fabricated and therefore not real, I am unaware of any illegal activities, documentation will not be taken as admission of guilt.

Note: Any details omitted here can largely be found on the zukijourney server, under discord.gg/zukijourney -- as I, and many other users, are present there & using it there.

About

The Hub of the zukijourney API!


Languages

Language:Python 99.6%Language:Shell 0.4%