Endpoints

El proyecto cuenta con una API privada y publica con el fin de aumentar su rango de acciones y utilidades

AnteriorAPI Modulo SiguienteComplementos

Última actualización hace 1 mes

¿Te fue útil?

Get information about the AI model

Retrieve information about the AI model including the name, version, and description.

get

/home/ia/info

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/home/ia/info' \
  --header 'Authorization: Bearer JWT'

200

500

{
  "model": "GPT-3",
  "systemInstruction": "The asistent API is a RESTful API that allows you to interact with the Bot Asistent platform.",
  "url": "https://docs.hiroshi-dev.me"
}

AI model information retrieved successfully

Generate a new AI response

Generate a new AI response using the provided input text.

post

/home/ia/generate

Authorizations

Body

promptstring

The input text to generate the AI response.

Example: Hello, how are you?

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/home/ia/generate' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "prompt": "Hello, how are you?"
  }'

200

500

{
  "response": "I'm fine, thank you!"
}

AI response generated successfully

Get all roles from the Discord server

get

/home/role-list

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/home/role-list' \
  --header 'Authorization: Bearer JWT'

200

400

{
  "message": "Roles retrieved successfully",
  "roles": [
    [
      "Admin",
      "Moderator",
      "User"
    ]
  ]
}

Get all roles from the Discord server

Add animelist link to the database

Add anime link in the animelist Discord server

post

/home/nekohub/animelist

Authorizations

Body

urlstring

channelIdstring

roleIdstring

createThreadboolean

guildIdstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/home/nekohub/animelist' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "text",
    "channelId": "text",
    "roleId": "text",
    "createThread": true,
    "guildId": "text"
  }'

200

400

{
  "errors": "text",
  "data": [
    {
      "id": "text",
      "channelId": "text",
      "anilistId": "text",
      "pingRole": "text",
      "createThreads": true,
      "threadArchiveTime": "text",
      "completed": true
    }
  ]
}

Announcements will now be made

Get user data from the API.

Retrieve user data from the API using the provided JWT token.

get

/auth/{id}

Authorizations

Path parameters

idstringrequired

ID of the user to retrieve.

Example: userId123

Header parameters

Authorizationstringrequired

JWT token for authentication.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/auth/{id}' \
  --header 'Authorization: text'

200

400

{
  "id": "userId123",
  "discord": "123456789",
  "name": "John Doe",
  "createdAt": "2024-08-30T14:53:44.077Z",
  "rol": "user",
  "email": "user@example.com",
  "password": "hashed-password"
}

User data retrieved successfully.

Register a user in the API.

post

/auth/register

Body

emailstring

Example: user@example.com

passwordstring

Example: secure-password

namestring

Example: John Doe

discordstring

Example: 123456789

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/auth/register' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "user@example.com",
    "password": "secure-password",
    "name": "John Doe",
    "discord": "123456789"
  }'

200

400

{
  "id": "userId123",
  "email": "user@example.com",
  "name": "John Doe",
  "discord": "123456789"
}

User registered successfully.

Authenticate a user and return a JWT token for subsequent requests.

post

/auth/login

Body

emailstring

Example: user@example.com

passwordstring

Example: secure-password

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/auth/login' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "user@example.com",
    "password": "secure-password"
  }'

200

400

{
  "id": "userId123",
  "email": "user@example.com",
  "name": "John Doe",
  "discord": "123456789",
  "token": "jwt-token-123"
}

User logged in successfully.

Get all bots for crypto from the database

Retrieve all crypto bots from the database and return the total count and the list of bots.

get

/devs/cryptobots

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/devs/cryptobots'

200

404

{
  "data": {
    "count": 5,
    "bots": [
      {
        "id": "cld8h89qw0000pmp59ts0b89d",
        "enabled": true,
        "token": "some-unique-token",
        "coinId": "bitcoin",
        "preferred": "BTC",
        "frequency": 10,
        "symbol": "$",
        "separator": "-",
        "createdAt": "2024-12-28T12:34:56Z",
        "updatedAt": "2024-12-29T14:23:45Z"
      }
    ]
  }
}

All crypto bots from the database

Get all orders from the database

Retrieve all orders from the database and return the total count and the list of orders.

get

/devs/orders

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/devs/orders'

200

404

{
  "data": {
    "count": 10,
    "orders": [
      {
        "id": "cld8h89qw0000pmp59ts0b89d",
        "image": "https://example.com/image.jpg",
        "name": "Product Name",
        "userId": "user123",
        "number": 12345,
        "price": 2000,
        "quantity": 5,
        "metode": "Credit Card",
        "info": "Additional order information",
        "date": "2024-12-28T12:34:56Z",
        "status": "Pending"
      }
    ]
  }
}

All orders from the database

Get all sources from the database

Get all sources from the database and return the total count of sources.

get

/devs-tools/sources

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/devs-tools/sources'

200

404

{
  "data": {
    "count": 1,
    "sources": [
      {
        "id": "source123",
        "name": "Source Name"
      }
    ]
  }
}

All sources from the database

Delete an order

Delete a specific order by its ID from the database.

delete

/devs/orders/{id}

Path parameters

idstringrequired

ID of the order to delete.

Example: cld8h89qw0000pmp59ts0b89d

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/devs/orders/{id}'

200

404

500

{
  "data": {
    "message": "Order deleted",
    "order": {
      "id": "cld8h89qw0000pmp59ts0b89d",
      "image": "https://example.com/image.jpg",
      "name": "Product Name",
      "userId": "user123",
      "number": 12345,
      "price": 2000,
      "quantity": 5,
      "metode": "Credit Card",
      "info": "Additional order information",
      "date": "2024-12-28T12:34:56Z",
      "status": "Pending"
    }
  },
  "errors": null
}

Order successfully deleted.

Edit an order

Update the status of a specific order by its ID.

put

/devs/orders/{id}

Path parameters

idstringrequired

ID of the order to edit.

Example: cld8h89qw0000pmp59ts0b89d

Body

statusstring · enum

New status of the order.

Example: approved

Options: pending, approved, rejected

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/devs/orders/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "approved"
  }'

200

404

500

{
  "data": {
    "message": "Order updated",
    "order": {
      "id": "cld8h89qw0000pmp59ts0b89d",
      "image": "https://example.com/image.jpg",
      "name": "Product Name",
      "userId": "user123",
      "number": 12345,
      "price": 2000,
      "quantity": 5,
      "metode": "Credit Card",
      "info": "Additional order information",
      "date": "2024-12-28T12:34:56Z",
      "status": "Pending"
    }
  },
  "errors": null
}

Order successfully updated.

Delete a crypto bot

Delete a specific crypto bot by its token from the database.

delete

/devs/cryptobots/{token}

Path parameters

tokenstringrequired

Token of the crypto bot to delete.

Example: some-unique-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/devs/cryptobots/{token}'

200

404

500

{
  "data": {
    "message": "Bot deleted",
    "bot": {
      "id": "cld8h89qw0000pmp59ts0b89d",
      "enabled": true,
      "token": "some-unique-token",
      "coinId": "bitcoin",
      "preferred": "BTC",
      "frequency": 10,
      "symbol": "$",
      "separator": "-",
      "createdAt": "2024-12-28T12:34:56Z",
      "updatedAt": "2024-12-29T14:23:45Z"
    }
  },
  "errors": null
}

Crypto bot successfully deleted.

Edit a crypto bot

Update the enabled status of a specific crypto bot by its token.

put

/devs/cryptobots/{token}

Path parameters

tokenstringrequired

Token of the crypto bot to edit.

Example: some-unique-token

Body

enabledboolean

New enabled status of the bot.

Example: true

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/devs/cryptobots/{token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "enabled": true
  }'

200

404

500

{
  "data": {
    "message": "Bot updated",
    "bot": {
      "id": "cld8h89qw0000pmp59ts0b89d",
      "enabled": true,
      "token": "some-unique-token",
      "coinId": "bitcoin",
      "preferred": "BTC",
      "frequency": 10,
      "symbol": "$",
      "separator": "-",
      "createdAt": "2024-12-28T12:34:56Z",
      "updatedAt": "2024-12-29T14:23:45Z"
    }
  },
  "errors": null
}

Crypto bot successfully updated.

Get API statistics

Retrieve the statistics of the API including the number of requests, responses, errors, and more.

get

/devs-tools/stats

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/devs-tools/stats'

200

400

{
  "startts": 1501647865959,
  "all": {
    "requests": 7,
    "responses": 7,
    "errors": 3,
    "info": 0,
    "success": 3,
    "redirect": 1,
    "client_error": 2,
    "server_error": 1,
    "total_time": 510,
    "max_time": 502,
    "avg_time": 72.85714285714286,
    "total_req_clength": 0,
    "max_req_clength": 0,
    "avg_req_clength": 0,
    "total_res_clength": 692,
    "max_res_clength": 510,
    "avg_res_clength": 98,
    "req_rate": 1.0734549915657108,
    "err_rate": 0.4600521392424475
  },
  "sys": {
    "rss": 59768832,
    "heapTotal": 36700160,
    "heapUsed": 20081776,
    "external": 5291923,
    "cpu": 0
  },
  "name": "Bot Asistent API",
  "version": "0.0.1",
  "hostname": "localhost",
  "ip": "0.0.0.0"
}

API statistics retrieved successfully

get

/devs-tools/tasks

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/devs-tools/tasks'

200

400

{
  "count": 5,
  "tasks": [
    {
      "id": "cld8h89qw0000pmp59ts0b89d",
      "userId": "1121121121121",
      "guildId": "1121121121121",
      "taskId": 2,
      "content": "work in the hostname",
      "status": false,
      "createdAt": "2024-12-28T12:34:56Z",
      "updatedAt": "2024-12-29T14:23:45Z"
    }
  ]
}

Get tasks list from the database

post

/devs-tools/bot/reload

Body

botstring

Example: discord

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/devs-tools/bot/reload' \
  --header 'Content-Type: application/json' \
  --data '{
    "bot": "discord"
  }'

200

400

{
  "data": "Bot reloaded successfully",
  "errors": null
}

Bot reloaded successfully

View code content from the source bin

Retrieve the code content stored in the source bin using a unique ID.

get

/home/sources/{id}

Authorizations

Path parameters

idstringrequired

The unique ID of the code content

Example: 5f7b7b7b7b7b7b7b7b7b7b7b

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/home/sources/{id}' \
  --header 'Authorization: Bearer JWT'

200

500

{
  "message": "Code content retrieved successfully",
  "content": "console.log('Hello World')",
  "language": "javascript",
  "title": "Hello World"
}

Code content retrieved successfully

Add code to the source bin and get a unique ID

Add code to the source bin and get a unique ID to view the code later.

post

/home/sources

Authorizations

Body

contentstring

The code content to be added to the source bin.

Example: console.log('Hello World')

languagestring

The language of the code content.

Example: javascript

titlestring

The title of the code content.

Example: Hello World

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/home/sources' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "content": "console.log('Hello World')",
    "language": "javascript",
    "title": "Hello World"
  }'

200

500

{
  "message": "Code added successfully",
  "id": "5f7b7b7b7b7b7b7b7b7b7b7b"
}

Code added successfully

Server latency and server status

Returns a welcome message and server status including platform and port.

get

/home

Authorizations

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/home' \
  --header 'Authorization: Bearer JWT'

200

500

application/json

application/xml

{
  "message": "Welcome to the API!",
  "client": {
    "port": "3000",
    "platform": "win32",
    "ram": 100,
    "uptime": 100
  }
}

Welcome message and server status

Get information about the AI model

Generate a new AI response

Get all roles from the Discord server

Add animelist link to the database

Get user data from the API.

Register a user in the API.

Login a user in the API.

Get all bots for crypto from the database

Get all orders from the database

Get all sources from the database

Delete an order

Edit an order

Delete a crypto bot

Edit a crypto bot

Get API statistics

View code content from the source bin

Add code to the source bin and get a unique ID

Server latency and server status