Envistudios API Documentation (2.0)

Download OpenAPI specification:Download

About

The Envistudios API is a RESTful service that allows developers to interact with the Envistudios platform programmatically. It provides endpoints for user authentication, token management, health checks, and various other functionalities related to user management, boards, documents, reports, and more.

The API is designed to be secure, scalable, and easy to use. It follows RESTful principles and uses JSON for data exchange.

Learn more about Envistudios.

Authentication and Authorization

The Envistudios API uses Bearer Token authentication for securing endpoints. To authenticate, you need to include the Authorization header in your requests with the value Bearer <token>, where <token> is the access token obtained from the /login or /refresh-token endpoints.

Steps to Authenticate:

  1. Login: Use the /login endpoint to obtain an access token and refresh token.
  2. Refresh Token: Use the /refresh-token endpoint to refresh your access token when it expires.
  3. Include Token: Include the access token in the Authorization header for all subsequent requests.

Note: Some endpoints may require specific roles or permissions to access.

REST API Standards

The Envistudios API follows RESTful principles and uses standard HTTP methods (GET, POST, PUT, PATCH, DELETE) to perform operations on resources. Below are the key standards:

  • Base URL: All API requests should be made to the base URL https://api.envistudios.com/v1.
  • Content-Type: The API uses application/json for both request and response bodies.
  • Authentication: Use Bearer Token authentication for all secured endpoints.
  • Error Handling: The API returns standard HTTP status codes to indicate success or failure. In case of errors, a detailed error message is returned in the response body.
  • Pagination: For endpoints that return lists of resources, pagination is supported using limit and page query parameters.

User Service

The User Service handles user-related operations such as authentication, profile management, and password recovery.

Documente Service

The Documente Service manages document-related operations such as document upload, retrieval, and processing. It provides endpoints for handling documents, including text extraction, document tagging, and document search.

Infomente Service

The Infomente Service provides intelligent data processing and analytics capabilities. It includes endpoints for text-to-SQL conversion, data visualization, and generating insights from structured and unstructured data.

Health Check

Check Service Health

This endpoint is used to verify the operational status of the service. It returns a simple success status indicating the health of the API.

Use Case:

  • Monitor system uptime for automated health checks.
  • Ensure the service is running properly.
Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "success": true
}

User

Refresh User Token

This endpoint allows the client to refresh the user's authentication token. A valid refresh token must be provided, and upon success, new access and refresh tokens are issued.

Use Case:

  • Maintain user sessions without requiring re-login.
  • Extend the lifecycle of user sessions securely.
Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "status": 0
}

Retrieve User Details

This endpoint retrieves detailed information about a user based on their session or authentication token. Developers can use this to fetch profile data, including the user's role, email, and security group.

Use Case:

  • Fetch user details to personalize dashboard experiences.
  • Retrieve user information for display in profile settings.
  • Validate user role and permissions for feature access.
Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "User detail",
  • "status": 0
}

Update User Details

This endpoint allows partial updates to user information. Developers can update specific user attributes (e.g., name, role, email) without overwriting the entire user profile. A JsonPatch payload must be provided to specify the changes.

Use Case:

  • Update user profile information (e.g., name change or email update).
  • Modify user role or security group for role-based access control.
  • Enable user self-service to edit their account details.
Authorizations:
Bearer
Request Body schema: application/json
first_name
string
last_name
string
user_name
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "user_name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "User details updated"
}

User login

Authenticates a user and returns an access token, refresh token, and user details.

Authorizations:
Bearer
Request Body schema: application/json
email
required
string <email>
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string"
}

Forgot Password API

Initiates the password reset process by sending a reset link to the registered email.

Authorizations:
Bearer
Request Body schema: application/json
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Set New Password

Allows users to set a new password after resetting it.

Authorizations:
Bearer
Request Body schema: application/json
password
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Change Password API

Allows users to change their password by providing the old and new password.

Authorizations:
Bearer
Request Body schema: application/json
current_password
required
string
new_password
required
string

Responses

Request samples

Content type
application/json
{
  • "current_password": "string",
  • "new_password": "string"
}

Add user in the org

This endpoint allows an admin to add a new user to the organization. Only admins can add users.

Authorizations:
Bearer
Request Body schema: application/json
email
string <email>
first_name
string
last_name
string
role
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "New user created",
  • "status": 0
}

Token

Get user ID from access token

This endpoint retrieves user information by verifying the provided access token. The response includes the user's ID, role, and other attributes.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "status": 0
}

google_auth

Google Authentication API

Authenticate users via Google OAuth. Returns an access and refresh token upon success.

Authorizations:
Bearer
Request Body schema: application/json
access_token
required
string

Responses

Request samples

Content type
application/json
{
  • "access_token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "User logged in successfully",
  • "status": 0
}

GoogleDrive

Generate Google authentication URL

Returns an authorization URL to initiate Google OAuth flow.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "status": 0
}

upload google drive doc

Authorizations:
Bearer
path Parameters
board_id
required
integer
Request Body schema: application/json
file_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "file_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "string",
  • "status": 0
}

Security group

Retrieve security group and activity data for a user

This endpoint retrieves the security group and its associated activity data, including usage statistics like users, boards, documents, reports, and more.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "security grp data",
  • "status": 0
}

Users

Get all users

This endpoint retrieves a list of all users in the system. Filters can be applied to search by keyword, active status, and pagination options.

Authorizations:
Bearer
query Parameters
keyword
string

Filter users by keyword (name, email, or username)

is_active
string
Enum: "true" "false"

Filter users by active status

limit
integer
Default: 10

Number of users per page

page
integer
Default: 1

Page number for pagination

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Users fetched successfully",
  • "status": 0
}

Update user's active/blocked state

This endpoint allows an admin to update the active or blocked state of a user. Only admins can perform this action.

Authorizations:
Bearer
path Parameters
user_id
required
integer <int64>

The ID of the user to update

Request Body schema: application/json
email
string <email>
role
string
first_name
string
last_name
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "role": "string",
  • "first_name": "string",
  • "last_name": "string"
}

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "User updated successfully",
  • "status": 0
}

LLM

Retrieve all supported LLM models

This endpoint returns a list of all supported LLM (Large Language Models) along with their capabilities, such as support for text, image, and video processing.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "string",
  • "status": 0
}

Workspace

Get all the workspace of the user

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "list of all the workspaces of user",
  • "status": 0
}

Feature

Get all the features

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "list of all the features",
  • "status": 0
}

Board

Retrieve all boards for the user

This endpoint retrieves all boards associated with the authenticated user. Boards are linked to the user's workspace and can represent projects or categories.

Use Case:

  • Display a list of all user boards on a dashboard.
  • Fetch all user boards for navigation and management.
Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "List of boards retrieved",
  • "status": 0
}

Create a new board

Creates a new board for the authenticated user within a workspace.

Use Case:

  • Users can create boards to manage tasks, projects, or organize resources.
Authorizations:
Bearer
Request Body schema: application/json
workspace_id
integer
name
string
context
string
feature_id
integer
board_type
string
Default: "APP"
Enum: "PLUGIN" "APP"
agent_id
integer

Responses

Request samples

Content type
application/json
{
  • "workspace_id": 0,
  • "name": "string",
  • "context": "string",
  • "feature_id": 0,
  • "board_type": "PLUGIN",
  • "agent_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Board created",
  • "status": 0
}

Update an existing board

Updates the details of a specific user board. The user can modify the name, context, or associated features.

Use Case:

  • Update the name or context of a board after creation.
Authorizations:
Bearer
Request Body schema: application/json
board_id
integer
name
string
context
string

Responses

Request samples

Content type
application/json
{
  • "board_id": 0,
  • "name": "string",
  • "context": "string"
}

Get board details by ID

Retrieves details of a specific board by providing the board ID.

Use Case:

  • View board details for editing or reviewing project status.
Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

Responses

Delete a board

Deletes a board for the user by specifying the board ID.

Use Case:

  • Users can delete obsolete or completed boards to maintain workspace clarity.
Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board to delete

Responses

Reset a board.

This endpoint resets a specific board, clearing all associated data.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "Board reset successfully",
  • "status": 200
}

Conversation

Retrieve all messages from a conversation

This endpoint fetches all messages from a specific conversation within a board.

Use Case:

  • View conversation history to track past interactions and messages.
  • Display chat logs or messages for collaboration.
Authorizations:
Bearer
path Parameters
board_id
required
string

ID of the board

conversation_id
required
string

ID of the conversation

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "List of messages retrieved",
  • "status": 0
}

Create a new message in a conversation

Allows users to create and send a message in an existing board conversation.

Use Case:

  • Users can collaborate by adding messages to board-related conversations.
  • Ideal for tracking project communication and collaboration.
Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

Request Body schema: application/json
conversation_id
string
title
string
message
string
document_ids
Array of integers

Responses

Request samples

Content type
application/json
{
  • "conversation_id": "string",
  • "title": "string",
  • "message": "string",
  • "document_ids": [
    ]
}

Retrieve all conversations for a board

Fetches all conversations linked to a specific board.

Use Case:

  • Retrieve all board conversations for project tracking and collaboration.
  • Display active conversations in board management interfaces.
Authorizations:
Bearer
path Parameters
board_id
required
string

ID of the board

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "List of conversations retrieved",
  • "status": 0
}

Board Access

Get user IDs with access to a board

Retrieves the user IDs with access to the specified board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Emails fetched successfully",
  • "status": 0
}

Share a board with users

Shares the specified board with the provided user IDs.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

Request Body schema: application/json

JSON object containing 'user_ids'

user_ids
Array of integers

Responses

Request samples

Content type
application/json
{
  • "user_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Board shared",
  • "status": 0
}

Revoke access to a board for users

Revokes access to the specified board for the provided user IDs.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

query Parameters
user_ids
required
string

Comma-separated list of user IDs

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Access revoked successfully",
  • "status": 0
}

Send Widget Data

Retrieve widget data

Retrieves widget data based on the specified user, board, and conversation message.

Authorizations:
Bearer
path Parameters
user_id
required
integer

ID of the user

board_id
required
integer

ID of the board

message_id
required
string

ID of the conversation message

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Widget data retrieved successfully",
  • "status": 0
}

Patch Message

Update message object

Updates a message object associated with a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

message_id
required
string

ID of the message

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Message object updated successfully",
  • "status": 0
}

Report QA

Fetch question and answer data for a report

Fetches question and answer data for a report associated with a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

report_id
required
integer

ID of the report

query Parameters
execution_id
integer

ID of the execution (optional)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Successfully fetched question and answer data.",
  • "status": 0
}

Report

Get a specific report

Fetches details of a specific report associated with a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

report_id
required
integer

ID of the report

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Report data fetched successfully",
  • "status": 0
}

Delete a specific report

Deletes a specific report associated with a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

report_id
required
integer

ID of the report

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Report deleted successfully",
  • "status": 0
}

Update a specific report

Updates details of a specific report associated with a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

report_id
required
integer

ID of the report

Request Body schema: application/json

JSON object containing updated report details

object (boardboard_idreportreport_id_data)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Report Updated",
  • "status": 0
}

Get all reports for a board

Fetches all reports associated with a specific board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "All reports fetched successfully",
  • "status": 0
}

Create a new report for a board

Creates a new report associated with a specific board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

Request Body schema: application/json

JSON object containing report details

name
string
documents
Array of integers
report_type
string
Default: "comprehensive"
Enum: "per_doc" "comprehensive"
description
string
questions
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "documents": [
    ],
  • "report_type": "per_doc",
  • "description": "string",
  • "questions": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Report created successfully",
  • "status": 0
}

Report Question

Fetch questions for a report

Fetches questions for a specific report associated with a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

report_id
required
integer

ID of the report

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "fetched all the questions for report",
  • "status": 0
}

Create questions for a report

Creates new questions for a specific report associated with a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

report_id
required
integer

ID of the report

Request Body schema: application/json

JSON object containing 'questions'

questions
Array of strings

Responses

Request samples

Content type
application/json
{
  • "questions": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Question Stored",
  • "status": 0
}

Update questions for a report

Updates questions for a specific report associated with a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

report_id
required
integer

ID of the report

Request Body schema: application/json

JSON object containing 'remove_question' and 'add_question'

remove_question
Array of integers
add_question
Array of strings

Responses

Request samples

Content type
application/json
{
  • "remove_question": [
    ],
  • "add_question": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Questions updated successfully",
  • "status": 0
}

Report Execution

Initiate execution of a report

Initiates the execution of a report and returns the execution ID.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

report_id
required
integer

ID of the report

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Creating Report",
  • "status": 0
}

Retrieve execution history of a report

Retrieves the execution history of a report.

Authorizations:
Bearer
path Parameters
board_id
required
integer

ID of the board

report_id
required
integer

ID of the report

query Parameters
limit
integer

Number of items per page

page
integer

Page number

execution_id
integer

ID of the execution

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Fetched all report excutions",
  • "status": 0
}

Action

get action list

get action list

Authorizations:
Bearer
path Parameters
board_id
required
integer

board id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "string",
  • "status": 0
}

create action

create action

Authorizations:
Bearer
path Parameters
board_id
required
integer

board_id

Request Body schema: application/json

request body

name
string
prompt
string
icon
string
suggest_title
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "prompt": "string",
  • "icon": "string",
  • "suggest_title": true
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "status": 0
}

action details

action details

Authorizations:
Bearer
path Parameters
board_id
required
integer

board_id

action_id
required
integer

action_id

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "status": 0
}

action delete

action delete

Authorizations:
Bearer
path Parameters
board_id
required
integer

board_id

action_id
required
integer

action_id

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "string",
  • "status": 0
}

update action

update action

Authorizations:
Bearer
path Parameters
board_id
required
integer
action_id
required
integer
Request Body schema: application/json
name
string
prompt
string
icon
string
suggest_title
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "prompt": "string",
  • "icon": "string",
  • "suggest_title": true
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "action updated",
  • "status": 0
}

get action's arguments

get action's arguments

Authorizations:
Bearer
path Parameters
board_id
required
integer
action_id
required
integer
Request Body schema: application/json
document_ids
Array of any
user_query
string

Responses

Request samples

Content type
application/json
{
  • "document_ids": [
    ],
  • "user_query": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "string",
  • "status": 0
}

get action's arguments

get action's arguments

Authorizations:
Bearer
path Parameters
board_id
required
integer
action_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "status": 0
}

get action's arguments

get action's arguments

Authorizations:
Bearer
path Parameters
board_id
required
integer
action_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "status": 0
}

Argument

get action's arguments

get action's arguments

Authorizations:
Bearer
path Parameters
board_id
required
integer
action_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "string",
  • "status": 0
}

creat action's arguments

creat action's arguments

Authorizations:
Bearer
path Parameters
board_id
required
integer
action_id
required
integer
Request Body schema: application/json
attributes
Array of any

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "string",
  • "status": 0
}

delete action's arguments

delete action's arguments

Authorizations:
Bearer
path Parameters
board_id
required
integer
action_id
required
integer
argument_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": "string",
  • "message": "argument deleted successfully",
  • "status": 0
}

update action's arguments

update action's arguments

Authorizations:
Bearer
path Parameters
board_id
required
integer
action_id
required
integer
argument_id
required
integer
Request Body schema: application/json
name
string
description
string
generate_colour
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "generate_colour": true
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "argument updated",
  • "status": 0
}

Text

Add text content in board

Authorizations:
Bearer
path Parameters
board_id
required
integer
Request Body schema: application/json
title
string
content
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Content saved successfully",
  • "status": 0
}

Questions

API for returning question for the select document

Authorizations:
Bearer
path Parameters
board_id
required
integer
Request Body schema: application/json
documents
Array of integers

Responses

Request samples

Content type
application/json
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "list of all the questions for the given document",
  • "status": 0
}

Tag

API for sending text content

Authorizations:
Bearer
path Parameters
board_id
required
integer
Request Body schema: application/json
tags
Array of strings <csv>

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "List of documents related to the tags {tags}",
  • "status": 0
}

Document

get all docs and groups

Authorizations:
Bearer
path Parameters
board_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "list of all the documents of the user",
  • "status": 0
}

File upload

Authorizations:
Bearer
path Parameters
board_id
required
integer
Request Body schema: multipart/form-data
file
string <binary>

The file to upload.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Content saved successfully",
  • "status": 0
}

document details API

Authorizations:
Bearer
path Parameters
board_id
required
integer
document_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "list of all the documents of the user",
  • "status": 0
}

get all docs and groups

Authorizations:
Bearer
path Parameters
board_id
required
integer
document_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Document deleted successfully",
  • "status": 0
}

Reprocess document and delete from Weaviate.

Authorizations:
Bearer
path Parameters
board_id
required
integer
document_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "File reprocessing started",
  • "status": 0
}

View a document associated with a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer
document_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "board not found",
  • "status": 0
}

generate thumbnails and reels for video

Authorizations:
Bearer
path Parameters
board_id
required
integer
document_id
required
integer
Request Body schema: application/json
user_prompt
string
feature_type
boolean
conversation_id
string
document_file_id
integer

Responses

Request samples

Content type
application/json
{
  • "user_prompt": "string",
  • "feature_type": true,
  • "conversation_id": "string",
  • "document_file_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "status": 0
}

Get process status

Authorizations:
Bearer
path Parameters
board_id
required
integer
process_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "status": 0
}

get all thumbnails and reels for a video

Authorizations:
Bearer
path Parameters
board_id
required
integer
document_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "status": 0
}

Connector

get authorization for supported connectors (confluence)

Authorizations:
Bearer
path Parameters
connector
required
string
Default: "atlassian"

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "status": 0
}

Extract accesss token from supported connetor (confluence)

Authorizations:
Bearer
path Parameters
connector
required
string
Default: "atlassian"
Request Body schema: application/json
code
string

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "status": 0
}

Group

get all groups present in a board

Authorizations:
Bearer
path Parameters
board_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "status": 0
}

delete group

Authorizations:
Bearer
path Parameters
board_id
required
integer
group_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "board not found",
  • "status": 0
}

Chat Bot

Chat bot for text to SQL

This endpoint allows users to interact with a chat bot that converts natural language prompts into SQL queries.

Authorizations:
Bearer
Request Body schema: application/json
prompt
string

The natural language prompt to convert into SQL.

board_id
integer

The ID of the board associated with the query.

Responses

Request samples

Content type
application/json
{
  • "prompt": "string",
  • "board_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "success": 200
}

Database

Create a new database connection for a board.

This endpoint establishes a connection to a database and stores the connection details for a specific board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

Request Body schema: application/json
db_type
string

The type of database (e.g., MySQL, PostgreSQL).

host
string

The database host.

port
integer

The database port.

user
string

The database user.

password
string

The database password.

db_name
string

The database name.

Responses

Request samples

Content type
application/json
{
  • "db_type": "string",
  • "host": "string",
  • "port": 0,
  • "user": "string",
  • "password": "string",
  • "db_name": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": null,
  • "status": 200
}

Retrieve database credentials for a specific board.

This endpoint retrieves the database credentials for a specific board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": null,
  • "status": 200
}

Retrieve a list of supported databases.

This endpoint retrieves a list of databases supported by the API.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": null,
  • "status": 200
}

Dashboard

Create a new dashboard for a board.

This endpoint creates a new dashboard for a specific board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

Request Body schema: application/json
db_type
string

The type of database (e.g., MySQL, PostgreSQL).

host
string

The database host.

port
integer

The database port.

user
string

The database user.

password
string

The database password.

db_name
string

The database name.

Responses

Request samples

Content type
application/json
{
  • "db_type": "string",
  • "host": "string",
  • "port": 0,
  • "user": "string",
  • "password": "string",
  • "db_name": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": null,
  • "status": 200
}

Get list of dashboards for a board.

This endpoint retrieves a list of dashboards for a specific board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

query Parameters
dashboard_type
string

The type of dashboard.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": null,
  • "status": 200
}

Get dashboard details.

This endpoint retrieves details of a specific dashboard for a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

dashboard_id
required
integer

The ID of the dashboard.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": null,
  • "status": 200
}

Update dashboard details.

This endpoint updates the details of a specific dashboard for a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

dashboard_id
required
integer

The ID of the dashboard.

Request Body schema: application/json
name
string

The new name of the dashboard.

insight_category
Array of strings

The updated insight categories.

dashboard_type
string

The updated dashboard type.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "insight_category": [
    ],
  • "dashboard_type": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": null,
  • "status": 200
}

Delete a dashboard.

This endpoint deletes a specific dashboard for a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

dashboard_id
required
integer

The ID of the dashboard.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "Dashboard deleted successfully",
  • "status": 200
}

Add a widget to a dashboard.

This endpoint adds a widget to a specific dashboard for a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

dashboard_id
required
integer

The ID of the dashboard.

Request Body schema: application/json
widget_ids
Array of integers

The IDs of the widgets to add.

Responses

Request samples

Content type
application/json
{
  • "widget_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "Widget added successfully",
  • "status": 200
}

Execute dashboard widgets.

This endpoint executes the widgets on a specific dashboard for a board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

dashboard_id
required
integer

The ID of the dashboard.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "Widgets executed successfully",
  • "status": 200
}

SQL

Execute an SQL query on a board's database.

This endpoint executes an SQL query on the database associated with a specific board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

Request Body schema: application/json
sql_query
string

The SQL query to execute.

Responses

Request samples

Content type
application/json
{
  • "sql_query": "string"
}

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "SQL query executed successfully",
  • "status": 200
}

Widget

Fetch all widgets for a specific board.

This endpoint retrieves all widgets associated with a specific board.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": null,
  • "status": 200
}

Update a widget.

This endpoint updates the details of a specific widget.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

widget_id
required
integer

The ID of the widget.

Request Body schema: application/json
widget_name
string

The new name of the widget.

widget_type
string

The new type of the widget.

widget_description
string

The new description of the widget.

Responses

Request samples

Content type
application/json
{
  • "widget_name": "string",
  • "widget_type": "string",
  • "widget_description": "string"
}

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "Widget updated successfully",
  • "status": 200
}

Dashboard Widget

Fetch all widgets for a specific dashboard.

This endpoint retrieves all widgets associated with a specific dashboard.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

dashboard_id
required
integer

The ID of the dashboard.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": null,
  • "status": 200
}

Add a new widget to a specific dashboard.

This endpoint adds a new widget to a specific dashboard.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

dashboard_id
required
integer

The ID of the dashboard.

Request Body schema: application/json
widget_name
string

The name of the widget.

widget_type
string

The type of the widget.

widget_description
string

The description of the widget.

Responses

Request samples

Content type
application/json
{
  • "widget_name": "string",
  • "widget_type": "string",
  • "widget_description": "string"
}

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "Widget added successfully",
  • "status": 200
}

Delete a widget from a specific dashboard.

This endpoint deletes a specific widget from a dashboard.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

dashboard_id
required
integer

The ID of the dashboard.

widget_id
required
integer

The ID of the widget.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "Widget deleted successfully",
  • "status": 200
}

Chat Widget

Add a chat widget to a specific dashboard.

This endpoint adds a chat widget to a specific dashboard.

Authorizations:
Bearer
path Parameters
board_id
required
integer

The ID of the board.

dashboard_id
required
integer

The ID of the dashboard.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "Chat widget added successfully",
  • "status": 200
}