MVK NexuS

API Documentation

API offering several core services

Available Endpoints

This API offers several core services, categorized below. Use the search bar above to filter.

Conversions ▶

Hex Code to Color Name Conversion

Route: /color?hex=

Description: Converts a hexadecimal color code to its corresponding name in Spanish.

Required parameter: hex: The hexadecimal color code.

Request examples:

/color?hex=FF5733
/color?hex=00FF00
/color?hex=0000FF

Expected response: The color name in Spanish.

Unix Timestamp to Formatted Time Conversion

Route: /timestamp?unix=

Description: Converts a Unix timestamp to a readable format.

Required parameter: unix: The Unix timestamp in seconds.

Request examples:

/timestamp?unix=1609459200 (January 1, 2021)
/timestamp?unix=1640995200 (January 1, 2022)
/timestamp?unix=1672531200 (January 1, 2023)

Expected response: The formatted time.

Unit Conversion

Route: /convertirunidad?valor=&de=&a=

Description: Converts a quantity from one unit to another.

Required parameters: valor, de (from), and a (to).

Request examples:

/convertirunidad?valor=10&de=metros&a=pies (meters to feet)
/convertirunidad?valor=100&de=kilogramos&a=libras (kilograms to pounds)
/convertirunidad?valor=30&de=celsius&a=fahrenheit (Celsius to Fahrenheit)

Expected response: The converted quantity.

Available Units

Route: /unidades

Description: Returns a list of all available units for conversion.

Request example: /unidades

Expected response: List of units available for conversion.

Dates ▶

Day Difference Between Dates

Route: /datediff?date1=&date2=

Description: Calculates the difference in days between two dates.

Required parameters: date1 and date2 in ISO format (YYYY-MM-DD).

Request examples:

/datediff?date1=2023-01-01&date2=2024-08-21
/datediff?date1=2022-05-15&date2=2023-05-15
/datediff?date1=2024-02-29&date2=2025-02-28

Expected response: The difference in days.

Text ▶

Text to Morse Code Conversion

Route: /morse?text=

Description: Converts text into Morse code.

Required parameter: text.

Request examples:

/morse?text=Hello
/morse?text=SOS
/morse?text=MVK NexuS

Expected response: The corresponding Morse code.

Dictionary

Route: /diccionario?palabra=

Description: Returns the definition of a provided word (Spanish dictionary).

Required parameter: palabra (word): The word you want to look up.

Request examples:

/diccionario?palabra=hola (hello)
/diccionario?palabra=efímero (ephemeral)
/diccionario?palabra=serendipia (serendipity)

Expected response: The definition of the word in Spanish.

Translate Text

Route: /traducir?idioma=&texto=

Description: Automatically translates text from a detected language to the specified language.

Required parameters:

idioma (language): The target language code (e.g., 'en' for English, 'fr' for French, 'es' for Spanish).
texto (text): The text you want to translate.

Request examples:

/traducir?idioma=en&texto=Hola%20mundo (Hello world)
/traducir?idioma=fr&texto=Good%20morning (Bonjour)
/traducir?idioma=es&texto=I%20love%20programming (Amo programar)

Expected response: The translated text in the specified language.

Images ▶

QR Code Generation

Route: /qr?text=

Description: Generates a QR code based on the provided text.

Required parameter: text: The text you want to convert into a QR code.

Request examples:

/qr?text=https://www.example.com
/qr?text=Contact: John Doe, Tel: 123-456-7890
/qr?text=WiFi:NetworkName;Password:SecurePassword;

Expected response: An image of the QR code representing the provided text.

Image Search

Route: /search-images?q=

Description: Searches for images based on a provided query using Google Images.

Required parameter: q: The search query to find images.

Request examples:

/search-images?q=auroras
/search-images?q=funny+cats
/search-images?q=mountain+landscapes

Expected response: An array of image URLs matching the query.

Welcome Image Generation

Route: /welcome/welcome-image

Method: POST

Content-Type: application/json

Description: This endpoint generates a custom welcome image with a background, text, and user avatar. Requires an API Key sent via header.

Required Headers:

x-api-key: Your API key.

Required parameters (POST - JSON Body):

background: URL of the background image.
text1: First text to display on the image.
text2: Second text to display on the image.
useravatar: URL of the user's avatar.

Optional parameters (POST - JSON Body):

textColor: Text color in hexadecimal format (default: white).
bordeColor (border color): Color of the avatar border and image outline in hexadecimal format (default: white).
type (number, optional): Specifies the style of the welcome image. Valid values: 1, 2, or 3.

Example POST requests (JSON):


POST /welcome/welcome-image
Content-Type: application/json
x-api-key: your_api_key_here

{
  "background": "https://example.com/background.jpg",
  "text1": "Welcome",
  "text2": "to our server",
  "useravatar": "https://example.com/avatar.png",
  "textColor": "#FF0000",
  "bordeColor": "#0000FF",
  "type": 1
}


POST /welcome/welcome-image
Content-Type: application/json
x-api-key: your_api_key_here

{
  "background": "https://example.com/space.jpg",
  "text1": "Hello",
  "text2": "Explorer",
  "useravatar": "https://example.com/astronaut.png",
  "bordeColor": "#FFFF00",
  "type": 2
}


POST /welcome/welcome-image
Content-Type: application/json
x-api-key: your_api_key_here

{
  "background": "https://example.com/forest.jpg",
  "text1": "Welcome",
  "text2": "to the adventure",
  "useravatar": "https://example.com/explorer.png",
  "textColor": "#00FF00",
  "bordeColor": "#FF00FF",
  "type": 3
}

Expected response: The URL of the generated welcome image.

Join Discord for API Key

Rank/Level Card Generation

Route: /rank

Method: POST

Content-Type: application/json

Description: Generates a custom rank or level card for users, ideal for displaying progress in platforms or games. Offers multiple card styles via the type parameter. Requires an API Key sent via header.

Required Headers:

x-api-key: Your API key.

General Parameters (POST - JSON Body):

These parameters are generally accepted, but their exact effect or applicability might vary depending on the chosen card type (see details below).

background (string): URL or hex color for the card background (usage varies by type).
username (string): User's name to display.
level (number): User's current level.
xp (number): User's current experience points.
requiredXp (number): Experience points needed for the next level.
avatar (string): URL of the user's profile picture (avatar).
status (string, optional): User's status (e.g., "online", "idle", "dnd", "offline"). Usage varies by type, often defaults to "online".
rank (number, optional): User's position in the ranking. Displayed if provided (required for some types).
color (string, optional): Color for username text (hex format). Default and usage vary by type.
border (string/number, optional): Card/avatar border color (hex) or width (number). Usage and format vary by type.
colorBar (string, optional): Color of the progress bar (hex format). Default and usage vary by type.
textcolorBar (string, optional): Color of text inside the progress bar (hex format). Usage varies by type.
tag (string, optional): User's tag (e.g., discriminator). Usage varies by type.
type (number, optional): Specifies the style of the rank card. Valid values: 1, 2, 3, or 4. Defaults to 1 if not specified or invalid.

Rank Card Types & Specific Parameter Behavior:

The type parameter determines the card's appearance and how other parameters are used.

Type 1

Working Parameters:

background: URL or hexadecimal color for the card background.
username: Username displayed on the card.
level: User's current level.
xp: Current experience points.
requiredXp: Experience needed for the next level.
avatar: URL of the user's avatar image.
color: Color for the username text (hexadecimal format, default #FFFFFF).
status: User status (e.g., online, dnd, etc.), default online.
border: Card border color (hexadecimal format, default #000000).
colorBar: Progress bar color (hexadecimal format, default #FFFFFF).
textcolorBar: Progress bar text color (hexadecimal format, default #000000).
rank: User rank (optional, displayed if provided).

Non-Working Parameters:

tag: Not used in this generator type.

Type 2

Working Parameters:

username: Username displayed on the card.
level: User's current level (displayed as "Level X").
avatar: URL of the user's avatar image.
xp: Current experience points.
requiredXp: Experience needed for the next level (used for progress calculation).
status: User status (e.g., online, dnd, etc.).
colorBar: Progress bar color (used as color in the underlying rankcard library, default #FFFFFF). This often influences other elements too.
rank: User rank (optional, displayed if provided).

Non-Working Parameters:

background: Not compatible with this generator type.
color: Not used directly for username text; colorBar takes priority for the general color scheme.
border: Not used for defining borders in this type.
textcolorBar: Not used for the progress bar text color.
tag: Not used in this generator type.

Type 3

Working Parameters:

background: URL or hexadecimal color for the background (if URL, used as image; if color, applied to background and optionally "bubbles").
username: Username displayed on the card.
level: User's current level.
rank: User rank (required in this type).
avatar: URL of the user's avatar image.
xp: Current experience points.
requiredXp: Experience needed for the next level.
status: User status (e.g., online, dnd, etc.), default online.
border: Avatar border color (hexadecimal format, default #0CA7FF if not specified).
colorBar: Progress bar or "bubbles" color (hexadecimal format, default #0CA7FF).
textcolorBar: Default color for text (includes current/required XP, default #FFFFFF).
color: Color for the username text (hexadecimal format, default #0CA7FF).

Non-Working Parameters:

tag: Not used in this generator type.

Type 4

Working Parameters:

background: Hexadecimal color for the background (colors only, no URLs; default #23272A).
username: Username displayed on the card.
tag: User tag (optional, displayed if provided).
level: User's current level.
rank: User rank (required in this type).
avatar: URL of the user's avatar image.
xp: Current experience points.
requiredXp: Experience needed for the next level.
color: Color for username text and other text elements (hexadecimal format, default #DDA0DD).
border: Numeric width of the avatar border (in pixels, default 8 if not a valid number).
colorBar: Progress bar color (hexadecimal format, default #FF69B4).

Non-Working Parameters:

status: Not used in this generator type.
textcolorBar: Not used directly; text color is controlled by color.

Example POST requests (JSON):

Using Type 1 (default):


POST /rank
Content-Type: application/json
x-api-key: your_api_key_here

{
  "background": "https://example.com/rank_bg.png",
  "username": "UserExample",
  "color": "#FFFFFF",
  "level": 5,
  "xp": 750,
  "requiredXp": 1000,
  "status": "online",
  "border": "#00FFFF",
  "avatar": "https://example.com/user_avatar.png",
  "rank": 15,
  "colorBar": "#00FF00",
  "textcolorBar": "#FFFFFF"
}

Explicitly requesting Type 2:


POST /rank
Content-Type: application/json
x-api-key: your_api_key_here

{
  "username": "DarknessDev",
  "level": 10,
  "xp": 1500,
  "requiredXp": 2000,
  "status": "dnd",
  "avatar": "https://example.com/dark_avatar.jpg",
  "colorBar": "#FF5733",
  "rank": 3,
  "type": 2
}

Requesting Type 3 (Rank is required):


POST /rank
Content-Type: application/json
x-api-key: your_api_key_here

{
  "background": "#334455",
  "username": "BubbleMaster",
  "color": "#0CA7FF",
  "level": 20,
  "xp": 4500,
  "requiredXp": 5000,
  "status": "idle",
  "border": "#FFFF00",
  "avatar": "https://example.com/bubble_avatar.png",
  "rank": 1,
  "colorBar": "#0CA7FF",
  "textcolorBar": "#FFFFFF",
  "type": 3
}

Requesting Type 4 (Rank is required):


POST /rank
Content-Type: application/json
x-api-key: your_api_key_here

{
  "background": "#2C2F33",
  "username": "ModernUser",
  "tag": "0001",
  "color": "#DDA0DD",
  "level": 8,
  "xp": 1200,
  "requiredXp": 1500,
  "border": 10,
  "avatar": "https://example.com/modern_avatar.png",
  "rank": 25,
  "colorBar": "#FF69B4",
  "type": 4
}

Expected response (JSON):


{
  "result": "/public/1710000000000.png"
}

Error response (JSON):


{
  "error": "Error generating the card"
}

Join Discord for API Key

Level Up Card Generation

Route: /rank/level-up

Method: POST

Content-Type: application/json

Description: Generates a level-up card showing user level progression. Requires an API Key sent via header.

Required Headers:

x-api-key: Your API key.

Required parameters (POST - JSON Body):

avatar (string): URL of the user's avatar image.
backround (string): Background color (HEX) or image URL.
username (string): Username to display on the card.
levels (array or object): Previous and new level information (e.g., [10, 11] or {"old": 10, "new": 11}).

Optional parameters (POST - JSON Body):

border (string): Card border color in HEX format.
avatarBorder (string): Avatar border color in HEX format.
opacity (number): Overlay opacity value (0-1).

Example POST requests (JSON):


POST /rank/level-up
Content-Type: application/json
x-api-key: your_api_key_here

{
  "avatar": "https://example.com/imagen-avatar.png",
  "backround": "#070d19",
  "username": "JuanPerez",
  "levels": [10, 11],
  "border": "#FF0000",
  "avatarBorder": "#00FF00",
  "opacity": 0.8
}


POST /rank/level-up
Content-Type: application/json
x-api-key: your_api_key_here

{
  "avatar": "https://example.com/imagen-avatar.png",
  "backround": "https://example.com/fondo.jpg",
  "username": "JuanPerez",
  "levels": { "old": 10, "new": 11 },
  "border": "#FF0000"
}

Expected response (JSON):


{
  "result": "/public/1710000000000.png"
}

Join Discord for API Key

Tweet Image Generation

Route: /tweet

Method: POST

Content-Type: application/json

Description: Generates an image resembling a tweet. Requires an API Key sent via header.

Required Headers:

x-api-key: Your API key.

Required parameters (POST - JSON Body):

avatar (string): URL of the user's avatar.
username (string): Twitter username (without @).
name (string): Display name.
text (string): The text content of the tweet.

Example POST request (JSON):


POST /tweet
Content-Type: application/json
x-api-key: your_api_key_here

{
  "avatar": "https://example.com/avatar.png",
  "username": "TwitterUser",
  "name": "Display Name",
  "text": "This is the content of my fake tweet!"
}

Expected response: The URL of the generated tweet image.

Join Discord for API Key

Artificial Intelligence ▶

ChatGPT Interaction

Route: /chatgpt

Method: POST

Content-Type: application/json

Description: Sends text to the ChatGPT API and receives a generated response. Requires an API Key sent via header.

Required Headers:

x-api-key: Your API key.

Required parameters (POST - JSON Body):

text: The user's input text.
userID: A unique identifier for the user.

Optional parameters (POST - JSON Body):

personality: Defines the personality of the AI (e.g., "happy", "professor").
longitud (length): Desired approximate length of the response.
systemInstruction: Specific instructions for the AI's behavior or context.
model: The specific model to use. Available models: gpt-4o-mini, o3-mini. Default: gpt-4o-mini.

Example POST requests:


POST /chatgpt
Content-Type: application/json
x-api-key: your_api_key_here

{
    "text": "Hello, how are you?",
    "userID": "12345",
    "personality": "happy",
    "longitud": 500,
    "systemInstruction": "casual conversation"
}


POST /chatgpt
Content-Type: application/json
x-api-key: your_api_key_here

{
    "text": "Explain the theory of relativity",
    "userID": "67890",
    "personality": "professor",
    "longitud": 1000,
    "systemInstruction": "advanced physics class",
    "model": "o3-mini"
}


POST /chatgpt
Content-Type: application/json
x-api-key: your_api_key_here

{
    "text": "Write a poem about love",
    "userID": "13579",
    "personality": "romantic",
    "longitud": 300,
    "model": "gpt-4o-mini"
}

Expected response: The response generated by ChatGPT.

Join Discord for API Key

Gemini Interaction

Route: /gemini

Method: POST

Content-Type: application/json

Description: Sends text to the Gemini API and receives a generated response. Requires an API Key sent via header.

Required Headers:

x-api-key: Your API key.

Required parameters (POST - JSON Body):

text: The user's input text.
userID: A unique identifier for the user.

Optional parameters (POST - JSON Body):

personality: Defines the personality of the AI.
longitud (length): Desired approximate length of the response.
systemInstruction: Specific instructions for the AI's behavior.
model: The specific Gemini model to use (e.g., "gemini-1.5-flash", "gemini-pro").

Example POST requests:


POST /gemini
Content-Type: application/json
x-api-key: your_api_key_here

{
    "text": "Hello, how are you?",
    "userID": "12345",
    "personality": "happy",
    "longitud": 500,
    "systemInstruction": "casual conversation",
    "model": "gemini-1.5-flash"
}


POST /gemini
Content-Type: application/json
x-api-key: your_api_key_here

{
    "text": "Explain the theory of relativity",
    "userID": "67890",
    "personality": "professor",
    "longitud": 1000,
    "systemInstruction": "advanced physics class",
    "model": "gemini-pro"
}


POST /gemini
Content-Type: application/json
x-api-key: your_api_key_here

{
    "text": "Write a poem about love",
    "userID": "13579",
    "personality": "romantic",
    "longitud": 300,
    "model": "gemini-1.5-flash"
}

Expected response: The response generated by Gemini.

Join Discord for API Key

DeepSeek Interaction Under Maintenance

Route: /deep-ai

Method: POST

Content-Type: application/json

Description: Sends text to the DeepSeek API and receives a generated response. Requires an API Key sent via header.

Required Headers:

x-api-key: Your API key.

Required parameters (POST - JSON Body):

text: The user's input text.
userID: A unique identifier for the user.

Optional parameters (POST - JSON Body):

personality: Defines the personality of the AI.
longitud (length): Desired approximate length of the response.
context: Specific context or instructions for the AI (replaces systemInstruction).

Example POST requests:


POST /deep-ai
Content-Type: application/json
x-api-key: your_api_key_here

{
    "text": "Hello, how are you?",
    "userID": "12345",
    "personality": "happy",
    "longitud": 500,
    "context": "casual conversation"
}


POST /deep-ai
Content-Type: application/json
x-api-key: your_api_key_here

{
    "text": "Explain the theory of relativity",
    "userID": "67890",
    "personality": "professor",
    "longitud": 1000,
    "context": "advanced physics class"
}


POST /deep-ai
Content-Type: application/json
x-api-key: your_api_key_here

{
    "text": "Write a poem about love",
    "userID": "13579",
    "personality": "romantic",
    "longitud": 300
}

Expected response: The response generated by DeepSeek.

Join Discord for API Key

Meta AI Interaction

Route: /meta-ai

Method: POST

Content-Type: application/json

Description: Sends text to the Meta AI API and receives a generated response. Requires an API Key sent via header.

Required Headers:

x-api-key: Your API key.

Required parameters (POST - JSON Body):

text: The user's input text.
userID: A unique identifier for the user.

Optional parameters (POST - JSON Body):

personality: Defines the personality of the AI.
longitud (length): Desired approximate length of the response.
context: Specific context or instructions for the AI (replaces systemInstruction).

Example POST requests:


POST /meta-ai
Content-Type: application/json
x-api-key: your_api_key_here

{
    "text": "Hello, how are you?",
    "userID": "12345",
    "personality": "happy",
    "longitud": 500,
    "context": "casual conversation"
}


POST /meta-ai
Content-Type: application/json
x-api-key: your_api_key_here

{
    "text": "Explain the theory of relativity",
    "userID": "67890",
    "personality": "professor",
    "longitud": 1000,
    "context": "advanced physics class"
}


POST /meta-ai
Content-Type: application/json
x-api-key: your_api_key_here

{
    "text": "Write a poem about love",
    "userID": "13579",
    "personality": "romantic",
    "longitud": 300
}

Expected response: The response generated by Meta AI.

Join Discord for API Key

Claude AI Interaction

Route: /claude

Method: POST

Content-Type: application/json

Description: Sends text to the Claude AI API and receives a generated response. Requires an API Key sent via header.

Required Headers:

x-api-key: Your API key.

Required parameters (POST - JSON Body):

text: The user's input text.
userID: A unique identifier for the user.

Optional parameters (POST - JSON Body):

personality: Defines the personality of the AI.
longitud (length): Desired approximate length of the response.
context: Specific context or instructions for the AI.

Example POST requests:


POST /claude
Content-Type: application/json
x-api-key: your_api_key_here

{
    "text": "What are the benefits of learning Python?",
    "userID": "user777",
    "personality": "helpful assistant",
    "longitud": 600,
    "context": "programming discussion"
}

Expected response: The response generated by Claude AI.

Join Discord for API Key

AI Image Analysis (Vision)

Route: /vision

Method: POST

Content-Type: application/json

Description: This endpoint analyzes an image using artificial intelligence and provides a description based on the image content. Requires a Nexus API Key.

Required Headers:

x-api-key: Your Nexus API Key.

Required Body Parameters (JSON):

url: The URL of the image to be analyzed.
prompt: Text to guide the image analysis.
userID: A unique identifier for the user making the request.

Request examples:


POST /vision
Content-Type: application/json
x-api-key: your_nexus_api_key

{
  "url": "https://example.com/image.jpg",
  "prompt": "Describe everything you see in the image.",
  "userID": "user123"
}

Expected response: A detailed description of the image content based on AI analysis.

Join Discord for API Key

AI Image Generation

Route: /image-ai

Method: POST

Content-Type: application/x-www-form-urlencoded

Description: This endpoint generates images using artificial intelligence based on the specified prompt and model. Requires an API Key sent via header.

Required Headers:

x-api-key: Your API key. You need to join the Discord server to get one.

Required Parameters (Form Data):

prompt: The descriptive text to generate the image. Example: "Un castillo en las nubes al atardecer".

Optional Parameters (Form Data):

negative_prompt (default: ""): Elements you do not want in the image. Example: "personas, texto, desenfoque".
model (default: "flux"): The AI model to use for image generation. Example: "flux".
width (default: 1024): Width of the generated image in pixels. Example: 512.
height (default: 1024): Height of the generated image in pixels. Example: 768.
seed (default: null): Seed number for reproducible results. If not defined, generation is random. Example: 12345.
nologo (default: false): If true, attempts to generate the image without logos or watermarks.
private (default: false): If true, marks the image as private (depending on the storage system).
enhance (default: false): If true, applies quality enhancements to the image (depending on the model or API support).
safe (default: false): If true, applies filters to ensure the generated image is safe for all audiences.

Available models:

flux
turbo

Example POST requests:


POST /image-ai HTTP/1.1
Content-Type: application/x-www-form-urlencoded
x-api-key: your_api_key_here

prompt=A castle in the clouds at sunset&model=flux&width=512&height=768&seed=12345&nologo=true&private=true&enhance=true&safe=true


POST /image-ai HTTP/1.1
Content-Type: application/x-www-form-urlencoded
x-api-key: your_api_key_here

prompt=A futuristic cityscape&model=turbo&negative_prompt=people, text, blur


POST /image-ai HTTP/1.1
Content-Type: application/x-www-form-urlencoded
x-api-key: your_api_key_here

prompt=A serene landscape with mountains and a lake&model=flux&width=1024&height=1024

Expected response (JSON):


{
    "result": "/public/{UUID}.jpg"
}

Join Discord for API Key

Tools ▶

Uptime

Route: /uptime

Description: Checks the status and uptime of the API.

Request example: /uptime

Expected response: Message indicating if the API is active and its uptime.

IP Information

Route: /ip?dir=

Description: Provides information about a given IP address.

Required parameter: dir: The IP address to look up.

Request examples:

/ip?dir=8.8.8.8
/ip?dir=1.1.1.1
/ip?dir=198.51.100.0 (Example public IP)

Expected response: JSON object with detailed information about the IP address.

BDFD Functions (Bot Designer for Discord)

Route: /bdfd?funcion=

Method: GET

Description: Provides information about BDFD functions.

Required parameter: funcion (function): The name of the BDFD function.

Request examples:

/bdfd?funcion=$title[]
/bdfd?funcion=$nomention
/bdfd?funcion=$randomText[]

Expected response: Detailed information about the specified BDFD function.