Admin
Get all tools with pagination
Search tools by name
""Tool type: native, custom, or mcp
Type of tool.
110Sort order enum.
ascPossible values: Successful Response
Validation Error
Internal Server Error
Get all tools
Search tools by name or description
""Tool type: native, custom, or mcp
Type of tool.
Successful Response
Validation Error
Internal Server Error
Get MCP tools with pagination. Supports search filtering and pagination.
Search tools by name or description
""110Sort order enum.
ascPossible values: Successful Response
Validation Error
Internal Server Error
Creates a new MCP tool configuration in AIP service and stores metadata locally. Validates MCP server configuration including authentication and connection details.
MCP tool configuration including server URL, transport type, and authentication details
The name of the MCP tool.
The description of the MCP tool.
Transport protocol ('SSE' or 'HTTP').
Valid HTTP/HTTPS URL of the MCP server.
Authentication configuration.
Successful Response
Bad Request
Conflict
Unprocessable Entity
Get all MCP tools
Search tools by name or description
""Successful Response
Validation Error
Internal Server Error
Upload a custom tool to the server
The plugin file to upload
Successful Response
Unprocessable Entity
Internal Server Error
Update a custom tool
The plugin file to upload
Successful Response
Unprocessable Entity
Internal Server Error
Get a custom tool
Successful Response
Not Found
Validation Error
Internal Server Error
Delete a custom tool
Successful Response
Custom tool successfully deleted from both AIP service and local metadata
Not Found
Validation Error
Internal Server Error
No content
Get an MCP details including tools available from the server
UUID of the MCP tool to retrieve
Successful Response
Not Found
Validation Error
Internal Server Error
Updates an existing MCP tool configuration in AIP service and syncs metadata locally. Supports partial updates and validates new configuration before applying changes.
UUID of the MCP tool to update
Updated MCP tool configuration (supports partial updates)
The name of the MCP tool.
The description of the MCP tool.
Transport protocol ('SSE' or 'HTTP').
Type of transport.
Valid HTTP/HTTPS URL of the MCP server.
Authentication configuration.
Successful Response
Bad Request
Not Found
Conflict
Validation Error
Deletes an existing MCP tool configuration from AIP service and removes local metadata. The tool is first deleted from AIP service, and only if successful, the local metadata is cleaned up to maintain consistency.
UUID of the MCP tool to delete
Successful Response
MCP tool successfully deleted from both AIP service and local metadata
Not Found
Validation Error
Internal Server Error
No content
Tests the connection to an MCP server and returns available tools. Validates server configuration, authentication, and retrieves tool definitions. This is a direct proxy to AIP service with no local storage.
MCP server connection configuration to test including URL, transport type, and authentication
The name of the MCP tool.
Transport protocol ('sse' or 'http').
Valid HTTP/HTTPS URL of the MCP server.
Authentication configuration.
Successful Response
Bad Request
Unprocessable Entity
Get MCP tools
UUID of the MCP tool to get tools from
Successful Response
Not Found
Validation Error
Internal Server Error
Fetches a remote agent card from a given URL.
The URL of the remote agent card.
Successful Response
Remote agent card not found
Validation Error
Internal server error
Create a new remote agent with configuration for external A2A agent integration.
Request model for creating a remote agent.
Attributes: name (str): The name/identifier of the remote agent. url (str): The base URL of the remote agent. display_name (str): The display name of the remote agent. description (str): Description of the remote agent. version (str): Version of the remote agent. auth_type (str): Chosen authentication type (e.g., apiKey, oauth2). client_id (str | None): OAuth2 client ID (required if auth_type is oauth2). client_secret (str | None): OAuth2 client secret (required if auth_type is oauth2). api_key (str | None): API key for apiKey authentication (required if auth_type is apiKey). agent_id (str): The ID of the base agent, only have value after agent is created. svg_icon (str): The SVG icon of the remote agent. ignore_pii (bool): Flag indicating whether to ignore PII. Defaults to False. chat_history_limit (int): Maximum number of chat history messages to retain for this agent. Defaults to 20.
Example: { "name": "a2a-remote-chatbot", "url": "https://a2aremote.com", "display_name": "A2A Remote Chatbot", "description": "Remote chatbot for A2A integration", "version": "1.0.0", "auth_type": "apiKey", "client_id": "oauth_client_123", "client_secret": "oauth_secret_456", "api_key": "api_key_789", "svg_icon": "...", "agent_id": "agent-123", "ignore_pii": false, "chat_history_limit": 20 }
The name/identifier of the remote agent
The base URL of the remote agent
The display name of the remote agent
Description of the remote agent
Version of the remote agent
Chosen authentication type (e.g., apiKey, oauth2)
OAuth2 client ID (required if auth_type is oauth2)
OAuth2 client secret (required if auth_type is oauth2)
API key for apiKey authentication (required if auth_type is apiKey)
The SVG icon of the remote agent
The ID of the base agent, only have value after agent is created
Flag indicating whether to ignore PII. Defaults to False.
falseMaximum number of chat history messages to retain for this agent.
20Successful Response
Created
Invalid request data or AIP service validation error
Validation Error
Internal server error or AIP service error
Retrieve a single remote agent by ID with its configuration details.
Successful Response
Invalid agent type or AIP service error
Remote agent not found
Validation Error
Internal server error
Update an existing remote agent with new configuration details.
Request model for updating a remote agent.
Attributes: name (str): The name/identifier of the remote agent. url (str): The base URL of the remote agent. display_name (str): The display name of the remote agent. description (str): Description of the remote agent. version (str): Version of the remote agent. auth_type (str | None): Chosen authentication type (e.g., apiKey, oauth2). client_id (str | None): OAuth2 client ID (required if auth_type is oauth2). client_secret (str | None): OAuth2 client secret (required if auth_type is oauth2). api_key (str | None): API key for apiKey authentication (required if auth_type is apiKey). svg_icon (str | None): The SVG icon of the remote agent. ignore_pii (bool | None): Flag indicating whether to ignore PII. chat_history_limit (int | None): Maximum number of chat history messages to retain for this agent.
The name/identifier of the remote agent
The base URL of the remote agent
The display name of the remote agent
Description of the remote agent
Version of the remote agent
Chosen authentication type (e.g., apiKey, oauth2)
OAuth2 client ID (required if auth_type is oauth2)
OAuth2 client secret (required if auth_type is oauth2)
API key for apiKey authentication (required if auth_type is apiKey)
The SVG icon of the remote agent
Flag indicating whether to ignore PII
Maximum number of chat history messages to retain for this agent
Successful Response
Invalid request data or AIP service error
Remote agent not found
Validation Error
Internal server error
Delete a remote agent and its configuration from the database.
Successful Response
Remote agent successfully deleted
Invalid agent type or AIP service error
Remote agent not found
Validation Error
Internal server error
No content
Get audit log for Hitl
110Sort order enum.
ascPossible values: Audit log for Hitl
Validation Error
Get audit log for Hitl by request ID
Audit log for Hitl by request ID
Audit log for Hitl by request ID not found
Validation Error
Fetch a list of agents from both AIP service and database with optional filters and pagination. Returns agent summaries including basic information.
Search query for agent name or description
""If True, show all agents including hidden ones
falseFilter by agent type (native/custom/langflow)
Enumeration of supported agent types.
110Sort order enum.
ascPossible values: Successful Response
Invalid agent type filter
Validation Error
Internal server error or AIP service error
Create a new agent in both AIP service and database. Returns the created agent details including configuration and metadata. Supports tool_configs for configuring tool-specific parameters.
Model for creating an agent.
Attributes: name (str): The name of the agent. version (str | None): Semantic version of the agent. Defaults to '1.0.0'. display_name (str): The display name of the agent. description (str): A brief description of the agent. model (str | None): The LLM model to use for this agent. language_model_id (str | None): ID of the language model from supported-models API (preferred). tools (list[str] | None): List of tool IDs. sub_agent_ids (list[str] | None): List of sub-agent IDs. mcps (list[str] | None): List of MCP IDs. timeout (int): The timeout value for the agent. chat_history_limit (int): Maximum number of chat history messages to retain for this agent. Defaults to 20. instructions (str): Instructions for the agent. ignore_pii (bool): Flag indicating whether to ignore PII. Defaults to False. svg_icon (str): The SVG string for the agent icon. created_by (str | None): The user who created the agent. tool_configs (dict[str, dict[str, Any]] | None): Configuration for each tool by tool ID. enable_memory (bool): Flag indicating whether to enable memory for the agent. mcp_configs (dict[str, dict[str, Any]] | None): MCP-level overrides such as allowed tool lists. tool_output_sharing (bool): Flag indicating whether to enable tool output sharing for the agent. Defaults to False. planning (bool): Flag indicating whether to enable planning for the agent. Defaults to False.
The name of the agent.
Semantic version of the agent.
The display name of the agent.
A brief description of the agent.
The LLM model to use for this agent.
ID of the language model from supported-models API.
List of tool IDs.
List of sub-agent IDs.
List of MCP IDs.
The timeout value for the agent.
60Maximum number of chat history messages to retain for this agent.
20Instructions for the agent.
Flag indicating whether to ignore PII.
falseThe SVG string for the agent icon.
The user who created the agent.
Configuration for each tool by tool ID.
Flag indicating whether to enable memory for the agent.
falseConfiguration overrides for each MCP ID.
Flag indicating whether to enable tool output sharing for the agent.
falseFlag indicating whether to enable planning for the agent.
falseSuccessful Response
Created
Invalid request data or AIP service validation error
Validation Error
Internal server error or AIP service error
Fetch a list of agents from both AIP service and database with optional filters. Returns agent summaries including basic information. Use cache=true to only fetch from database without calling AIP service.
Search query for agent name or description
""If True, show all agents including hidden ones
falseFilter by agent type (native/custom/langflow). Custom includes A2A agents.
Enumeration of supported agent types.
Successful Response
Invalid agent type filter
Validation Error
Internal server error or AIP service error
Get a list of supported language models from AIP service with model_id and model_name. This endpoint fetches the latest available models from the AIP service instead of using hardcoded values.
Successful Response
Validation Error
Internal server error or AIP service error
Fetch a single agent by ID from both AIP service and database. Returns detailed agent information including configuration and metadata.
Successful Response
Redirect to Langflow flow for langflow agents
Agent not found
Validation Error
Internal server error or AIP service error
Update an existing agent in the database. Returns the updated agent details including configuration and metadata. Supports tool_configs for configuring tool-specific parameters.
Model for updating an agent.
Attributes: name (str | None): The name of the agent. version (str | None): Semantic version of the agent. Defaults to '1.0.0'. display_name (str | None): The display name of the agent. description (str | None): A brief description of the agent. model (str | None): The LLM model to use for this agent. language_model_id (str | None): ID of the language model from supported-models API (preferred). tools (list[str] | None): List of tool IDs. sub_agent_ids (list[str] | None): List of sub-agent IDs. mcps (list[str] | None): List of MCP IDs. timeout (int | None): The timeout value for the agent. chat_history_limit (int | None): Maximum number of chat history messages to retain for this agent. Defaults 20. instructions (str | None): Instructions for the agent. ignore_pii (bool | None): Flag indicating whether to ignore PII. Defaults to False. svg_icon (str | None): The SVG string for the agent icon. tool_configs (dict[str, dict[str, Any]] | None): Configuration for each tool by tool ID. enable_memory (bool | None): Flag indicating whether to enable memory for the agent. mcp_configs (dict[str, dict[str, Any]] | None): MCP-level overrides such as allowed tool lists. tool_output_sharing (bool): Flag indicating whether to enable tool output sharing for the agent. planning (bool): Flag indicating whether to enable planning for the agent. Defaults to False.
The name of the agent.
Semantic version of the agent.
The display name of the agent.
A brief description of the agent.
The LLM model to use for this agent.
ID of the language model from supported-models API.
List of tool IDs.
List of sub-agent IDs.
List of MCP IDs.
The timeout value for the agent.
Maximum number of chat history messages to retain for this agent.
Instructions for the agent.
Flag indicating whether to ignore PII.
The SVG string for the agent icon.
Configuration for each tool by tool ID.
Flag indicating whether to enable memory for the agent.
Configuration overrides for each MCP ID.
Flag indicating whether to enable tool output sharing for the agent.
falseFlag indicating whether to enable planning for the agent.
falseSuccessful Response
Invalid request data or AIP service error
Agent not found
Validation Error
Internal server error or AIP service error
Delete an agent from both AIP service and local database. The agent is first deleted from the AIP service, and only if successful, it is then deleted from the local database.
Successful Response
Agent successfully deleted from both AIP service and local database
Agent not found
Validation Error
Internal server error or AIP service error
No content
Get a paginated list of chatbots with optional search filtering by name.
Search query for chatbot names
110Sort order enum.
ascPossible values: Successful Response
Validation Error
Create a new chatbot with the provided configuration data including catalogs and user assignments.
""[]Level type enum for catalogs.
Level type enum for catalogs.
falseEnum for question library source.
Enum for display type.
Enum for click behaviour.
Successful Response
Validation Error
Get a complete list of all chatbots in the system without pagination.
Successful Response
Validation Error
Get a paginated list of all chatbots along with their user counts.
Search query for chatbot names
110Sort order enum.
ascPossible values: Successful Response
Validation Error
Get details for a specific chatbot by its unique identifier.
The ID of the chatbot to retrieve
Successful Response
Validation Error
Delete a chatbot by its unique identifier.
The ID of the chatbot to delete
Successful Response
Validation Error
No content
Update an existing chatbot with the provided configuration data.
The ID of the chatbot to update
[]Level type enum for catalogs.
Level type enum for catalogs.
falseEnum for question library source.
Enum for display type.
Enum for click behaviour.
Successful Response
Validation Error
Assign additional users to a chatbot while preserving existing user assignments.
The ID of the chatbot to add users to
Request model for adding users to a chatbot.
This model represents the data required to assign users and domains to a specific chatbot for access control and management.
Attributes: user_ids (list[str]): List of user IDs that should be directly assigned to the chatbot. domain_ids (list[str]): List of domain IDs that should be assigned to the chatbot.
List of user IDs that should be directly assigned to the chatbot.
[]List of domain IDs that should be assigned to the chatbot.
[]Successful Response
Validation Error
Get a paginated list of users directly assigned to a specific chatbot.
The ID of the chatbot to retrieve users for
Search query for user names
110Sort order enum.
ascPossible values: Successful Response
Validation Error
Get all users that are not currently assigned to the specified chatbot.
The ID of the chatbot to retrieve users for
Search query for user names
Successful Response
Validation Error
Remove a specific user's access assignment from a chatbot.
The ID of the chatbot to delete users for
The ID of the user to delete
Successful Response
Validation Error
No content
Get a paginated list of domains associated with a specific chatbot.
The ID of the chatbot to retrieve domains for
Search query for domain names
110Sort order enum.
ascPossible values: Successful Response
Validation Error
Remove a specific domain's access assignment from a chatbot.
The ID of the chatbot to delete domains for
The ID of the domain to delete
Successful Response
Validation Error
No content
Get all domains that are not currently assigned to the specified chatbot.
The ID of the chatbot to retrieve domains for
Search query for domain names
Successful Response
Validation Error
Get all organizations slugs
Successful Response
Validation Error
Get organization by tenant id header
Successful Response
Validation Error
Create organization
Organization name
Organization slug (URL-friendly identifier)
^[a-z0-9\-]+$Support contact email
Primary color in hex code (e.g., #000000) or an empty string
^(#([0-9a-fA-F]{6}))?$Secondary color in hex code (e.g., #000000) or an empty string
^(#([0-9a-fA-F]{6}))?$Accent color in hex code (e.g., #000000) or an empty string
^(#([0-9a-fA-F]{6}))?$Light logo file
Dark logo file
Light icon file
Dark icon file
Light logo URL
Dark logo URL
Light icon URL
Dark icon URL
Email domains, e.g. ['example.com', 'gdplabs.id']
Feedback URL
User guide URL
Admin guide URL
Successful Response
Validation Error
Update organization name, main color, secondary color, accent color, logo, and icon.
Organization name
Organization slug (URL-friendly identifier)
Support contact email
Primary color in hex code (e.g., #000000) or an empty string
""Pattern: ^(#([0-9a-fA-F]{6}))?$Secondary color in hex code (e.g., #000000) or an empty string
""Pattern: ^(#([0-9a-fA-F]{6}))?$Accent color in hex code (e.g., #000000) or an empty string
""Pattern: ^(#([0-9a-fA-F]{6}))?$Light logo file
Dark logo file
Light icon file
Dark icon file
Email domains, e.g. ['example.com', 'gdplabs.id']
Feedback URL
User guide URL
Admin guide URL
Successful Response
Validation Error
Enqueue background task to decrypt all messages for the current tenant.
Encryption job request schema.
1000Successful Response
Validation Error
No content
Enqueue background task to encrypt all messages for the current tenant.
Encryption job request schema.
1000Successful Response
Validation Error
No content
Get organization by slug
Successful Response
Validation Error
Get organization by name
Successful Response
Validation Error
Delete organization
Successful Response
Validation Error
No content
Create a new component with the provided configuration data.
Create component request schema.
Successful Response
Validation Error
Get details for a specific component by its unique identifier.
The ID of the component
Successful Response
Validation Error
Update an existing component with the provided configuration data.
The ID of the component to update
Update component request schema.
Successful Response
Validation Error
Delete a specific component by its unique identifier.
The ID of the component to delete
Successful Response
Validation Error
No content
Get configuration fields associated with specified component IDs.
List of component IDs
Successful Response
Validation Error
Create a new configuration field with the provided configuration data.
Create config field request schema.
Successful Response
Validation Error
Get dropdown-type configuration fields from the specified source for UI rendering.
The source of the dropdown config fields
Successful Response
Validation Error
Get details for a specific configuration field by its unique identifier.
The ID of the config field
Successful Response
Validation Error
Update an existing configuration field with the provided configuration data.
The ID of the config field to update
Update config field request schema.
Successful Response
Validation Error
Delete a specific configuration field by its unique identifier.
The ID of the config field to delete
Successful Response
Validation Error
No content
Create new connector
Connector create request schema.
Attributes: name (str): Connector name. display_name (str): Connector display name. description (str | None, optional): Connector description. Defaults to None. icon (str | None, optional): Connector icon. Defaults to None. is_active (bool): Whether the connector is active. knowledge_source (bool): Whether the connector is a knowledge source.
Connector name.
Connector display name.
Connector description.
Connector icon.
Whether the connector is active.
falseWhether the connector will be shown in Option dropdown and user connector list
falseSuccessful Response
Validation Error
Get list of connectors for connector management page
Successful Response
Validation Error
Get available connectors from BOSA
Successful Response
Validation Error
Get list of connectors for dropdown chatbot connector form
Successful Response
Validation Error
Get connector by name
Successful Response
Validation Error
Delete connector
Successful Response
Validation Error
No content
Update connector is_active
Connector update request schema.
Attributes: display_name (str | None, optional): Connector display name. Defaults to None. description (str | None, optional): Connector description. Defaults to None. icon (str | None, optional): Connector icon. Defaults to None. is_active (bool | None, optional): Whether the connector is active. Defaults to None. knowledge_source (bool | None, optional): Whether the connector will be shown in Option dropdown and user connector list. Defaults to None.
Connector display name.
Connector description.
Connector icon.
Whether the connector is active.
Whether the connector will be shown in Option dropdown and user connector list
Successful Response
Validation Error
Connect admin to connector
Successful Response
Validation Error
Get admin integrations for connector
Successful Response
Validation Error
Remove admin integration from connector
Successful Response
Validation Error
No content
Get a paginated list of environment variables with optional search filtering by name.
Filter keys by name (partial match)
110Sort order enum.
ascPossible values: Successful Response
Validation Error
Create a new environment variable with encrypted storage.
The environment variable creation request
Environment variable name
^[a-zA-Z0-9_\-]+$Environment variable value
Environment variable type
KEYPossible values: The organization ID
Successful Response
Validation Error
Get all default config environment variables.
Successful Response
Validation Error
Get environment variable details including the decrypted value.
The ID of the environment variable
Successful Response
Validation Error
Update an existing environment variable.
The ID of the environment variable to update
The environment variable update request
Environment variable name
^[a-zA-Z0-9_\-]+$Environment variable value
Successful Response
Validation Error
Delete an environment variable.
The ID of the environment variable to delete
Successful Response
Validation Error
No content
Create multiple environment variables in batch for an organization.
Batch create environment variables request
Successful Response
Validation Error
Get a paginated list of knowledge bases with optional search filtering by name.
Search query for knowledge base names
110Sort order enum.
ascPossible values: Successful Response
Validation Error
Create a new knowledge base with the provided configuration data.
Create knowledge base request schema.
Attributes: knowledge_base_id (str): Knowledge base ID (1-100 characters). knowledge_base_name (str): Knowledge base name (0-100 characters). knowledge_base_description (str | None, optional): Knowledge base description. Defaults to None. index_name (str): Index name (1-100 characters). dpo_preset_id (str): DPO preset ID (36 characters). ttl (int, optional): Time to live. Defaults to 120. max_faq (int, optional): Maximum FAQ. Defaults to 50. is_processing_answer (bool, optional): Whether processing answer is enabled. Defaults to False. user (CurrentUser | None, optional): Current user information. Defaults to None.
12050falseSuccessful Response
Validation Error
Get a complete list of all knowledge bases in the system.
Successful Response
Validation Error
Get details for a specific knowledge base by its unique identifier.
The ID of the knowledge base to retrieve
Successful Response
Validation Error
Update an existing knowledge base with the provided configuration data.
The ID of the knowledge base to update
Update knowledge base request schema.
Attributes: knowledge_base_id (str | None, optional): Knowledge base ID (1-100 characters). Defaults to None. knowledge_base_name (str | None, optional): Knowledge base name (1-100 characters). Defaults to None. knowledge_base_description (str | None, optional): Knowledge base description. Defaults to None. index_name (str | None, optional): Index name (1-100 characters). Defaults to None. dpo_preset_id (str | None, optional): DPO preset ID (36 characters). Defaults to None. ttl (int | None, optional): Time to live. Defaults to None. max_faq (int | None, optional): Maximum FAQ. Defaults to None. is_processing_answer (bool | None, optional): Whether processing answer is enabled. Defaults to None. user (CurrentUser | None, optional): Current user information. Defaults to None.
Successful Response
Validation Error
Delete a specific knowledge base by its unique identifier.
The ID of the knowledge base to delete
Successful Response
Validation Error
No content
Register an existing knowledge base with smart search external service.
The ID of the knowledge base to register with smart search
Successful Response
Validation Error
Unregister an existing knowledge base from smart search external service.
The ID of the knowledge base to unregister from smart search
Successful Response
Validation Error
Get all distinct documents (file_id and file_name)where conversation_id is null from the vector database.
The index name to query documents from
Successful Response
Validation Error
Get a complete list of all LMRP catalogs in the system.
Successful Response
Validation Error
Get a specific LMRP catalog associated with the provided pipeline ID.
The ID of the pipeline to retrieve
Successful Response
Validation Error
Create a new LMRP catalog with the provided configuration data.
Create LMRP catalog request schema.
Attributes: name (str): The name of the LMRP catalog. description (str | None): The description of the LMRP catalog. is_override (bool): Whether the LMRP catalog is an override of CHATBOT catalog. level (CatalogLevelType): The level of the LMRP catalog. level_entity_id (str | None): The ID of the entity that the LMRP catalog belongs to.
falseLevel type enum for catalogs.
Successful Response
Validation Error
Get details for a specific LMRP catalog by its unique identifier.
The ID of the LMRP catalog to retrieve
Successful Response
Validation Error
Update an existing LMRP catalog with the provided configuration data.
The ID of the LMRP catalog to update
Update LMRP catalog request schema.
Attributes: name (str | None): The name of the LMRP catalog. description (str | None): The description of the LMRP catalog. is_override (bool | None): Whether the LMRP catalog is an override of CHATBOT catalog. level (CatalogLevelType | None): The level of the LMRP catalog. level_entity_id (str | None): The ID of the entity that the LMRP catalog belongs to.
Level type enum for catalogs.
Successful Response
Validation Error
Delete a specific LMRP catalog by its unique identifier.
The ID of the LMRP catalog to delete
Successful Response
Validation Error
No content
Get details for a specific LMRP catalog entry by its unique identifier.
The ID of the LMRP catalog entry to retrieve
Successful Response
Validation Error
Update an existing LMRP catalog entry with the provided configuration data.
The ID of the LMRP catalog entry to update
Update LMRP catalog entry request schema.
Attributes: name (str | None): The name of the LMRP catalog entry. scope (str | None): The scope of the LMRP catalog entry. prompt_builder_type (str | None): The type of the prompt builder. prompt_builder_kwargs (str | None): The kwargs of the prompt builder. prompt_builder_system_template (str | None): The system template of the prompt builder. prompt_builder_user_template (str | None): The user template of the prompt builder. model_id (str | None): The ID of the model. output_parser_type (str | None): The type of the output parser. output_parser_kwargs (str | None): The kwargs of the output parser. user (CurrentUser | None): The current user for audit tracking. Defaults to None.
Successful Response
Validation Error
Delete a specific LMRP catalog entry by its unique identifier.
The ID of the LMRP catalog entry to delete
Successful Response
Validation Error
No content
Create a new LMRP catalog entry with the provided configuration data.
Create LMRP catalog entry request schema.
Attributes: name (str): The name of the LMRP catalog entry. lmrp_catalog_id (str | None): The ID of the LMRP catalog. scope (str | None): The scope of the LMRP catalog entry. prompt_builder_type (str): The type of the prompt builder. prompt_builder_kwargs (str | None): The kwargs of the prompt builder. prompt_builder_system_template (str | None): The system template of the prompt builder. prompt_builder_user_template (str | None): The user template of the prompt builder. model_id (str | None): The ID of the model. output_parser_type (str | None): The type of the output parser. output_parser_kwargs (str | None): The kwargs of the output parser.
Successful Response
Validation Error
Get a paginated list of midnight FAQs with optional filtering by search, status, and date ranges.
Knowledge base ID to filter FAQs
Search query for FAQ questions or answers
Filter by FAQ status
Enumeration of possible FAQ statuses.
Filter FAQs created or updated from this date (ISO format)
Filter FAQs created or updated up to this date (ISO format)
110Sort order enum.
ascPossible values: Successful Response
Validation Error
Create a new midnight FAQ with the provided configuration data.
Midnight FAQ configuration data
""""Enumeration of possible FAQ statuses.
Successful Response
Validation Error
Get a specific midnight FAQ by its unique identifier.
The ID of the midnight FAQ to retrieve
Successful Response
Validation Error
Update an existing midnight FAQ with the provided configuration data.
The ID of the midnight FAQ to update
Updated midnight FAQ configuration data
Enumeration of possible FAQ statuses.
Successful Response
Validation Error
Delete a specific midnight FAQ by its unique identifier (soft delete).
The ID of the midnight FAQ to delete
Successful Response
Validation Error
No content
Get midnight FAQs associated with a specific knowledge base with optional filtering by status and date ranges.
The ID of the knowledge base
Filter by FAQ status
Enumeration of possible FAQ statuses.
Filter FAQs created or updated from this date (ISO format)
Filter FAQs created or updated up to this date (ISO format)
Successful Response
Validation Error
Get midnight FAQs associated with a specific model.
The ID of the model
Successful Response
Validation Error
Get midnight FAQs filtered by category.
The category name
Successful Response
Validation Error
Get midnight FAQs filtered by status.
The status value
Successful Response
Validation Error
Bulk update status of multiple midnight FAQs.
Bulk update status request data
Enumeration of possible FAQ statuses.
Successful Response
Validation Error
Bulk delete multiple midnight FAQs (soft delete).
Bulk delete request data
Successful Response
Validation Error
Generate an answer for a given question using optional source documents.
Generate answer request data
The question to generate an answer for
Optional source files id to use for answer generation
The knowledge base ID to use for answer generation
Successful Response
Validation Error
Get a complete list of all available models in the system.
Search query for model names
Filter by model type (LLM or LMRP)
Model type enum for models.
110Sort order enum.
ascPossible values: Successful Response
Validation Error
Create a new model with the provided configuration data.
Model creation request schema.
Attributes: name (str): Unique identifier for the model. display_name (str | None, optional): Display name for the model. Defaults to None. description (str | None, optional): Description of the model. Defaults to None. icon (str | None, optional): Icon for the model. Defaults to None. supported_attachments (dict[str, list[str]], optional): Supported attachments configuration. Defaults to {}. is_active (bool, optional): Is the model active. Defaults to True. provider_id (str): Provider ID for the model. model_kwargs (str | None, optional): Model kwargs. Defaults to None. model_env_kwargs (str | None, optional): Model env kwargs. Defaults to None. prompt_template_group_id (str | None, optional): Prompt template group ID for the model. Defaults to None. type (ModelType, optional): Model type (LLM or LMRP). Defaults to ModelType.LLM. user (CurrentUser | None, optional): Current user information. Defaults to None.
Unique identifier for the model
Display name for the model
Description of the model
Icon for the model
Is the model active
trueProvider ID for the model
Model kwargs
Model env kwargs
Prompt template group ID for the model
Model type (LLM or LMRP)
LLMPossible values: Successful Response
Validation Error
Get details for a specific model by its unique identifier.
The ID of the model to retrieve
Successful Response
Validation Error
Update an existing model with the provided configuration data.
The ID of the model to update
Model update request schema.
Attributes: name (str | None, optional): Unique identifier for the model. Defaults to None. display_name (str | None, optional): Display name for the model. Defaults to None. description (str | None, optional): Description of the model. Defaults to None. icon (str | None, optional): Icon for the model. Defaults to None. supported_attachments (dict[str, list[str]], optional): Supported attachments configuration. Defaults to {}. is_active (bool | None, optional): Is the model active. Defaults to None. provider_id (str | None, optional): Provider ID for the model. Defaults to None. model_kwargs (str | None, optional): Model kwargs. Defaults to None. model_env_kwargs (str | None, optional): Model env kwargs. Defaults to None. prompt_template_group_id (str | None, optional): Prompt template group ID for the model. Defaults to None. type (ModelType | None, optional): Model type (LLM or LMRP). Defaults to None. user (CurrentUser | None, optional): Current user information. Defaults to None.
Unique identifier for the model
Display name for the model
Description of the model
Icon for the model
Is the model active
Provider ID for the model
Model kwargs
Model env kwargs
Prompt template group ID for the model
Model type (LLM or LMRP)
Model type enum for models.
Successful Response
Validation Error
Delete a specific model by its unique identifier.
The ID of the model to delete
Successful Response
Validation Error
No content
Get a list of pipelines, optionally filtered by type (RAGO or DPO).
The types of pipeline (optional)
The type of pipeline (optional) (TODO: will be removed in the future)
Successful Response
Validation Error
Create a new pipeline with the provided configuration data.
Create pipeline request schema.
The type of pipeline.
Values: RAGO. DPO. CSV.
trueSuccessful Response
Validation Error
Get details for a specific pipeline by its unique identifier.
The ID of the pipeline
Successful Response
Validation Error
Update an existing pipeline with the provided configuration data.
The ID of the pipeline to update
Update pipeline request schema.
Successful Response
Validation Error
Delete a specific pipeline by its unique identifier.
The ID of the pipeline to delete
Successful Response
Validation Error
No content
Get all pipeline components associated with a specific pipeline ID.
The ID of the pipeline to get components for
Successful Response
Validation Error
Create a new pipeline component with the provided configuration data.
Create pipeline component request schema.
Successful Response
Validation Error
Get details for a specific pipeline component by its unique identifier.
The ID of the pipeline component
Successful Response
Validation Error
Update an existing pipeline component with the provided configuration data.
The ID of the pipeline component to update
Update pipeline component request schema.
Successful Response
Validation Error
Delete a specific pipeline component by its unique identifier.
The ID of the pipeline component to delete
Successful Response
Validation Error
No content
Load value from csv file
CSV file to load values from
Successful Response
Validation Error
Get a list of presets, optionally filtered by pipeline ID.
Optional: The ID of the pipeline to get presets for
Successful Response
Validation Error
Create a new preset with the provided configuration data.
Create preset with config fields request schema.
Attributes: pipeline_id (str): Pipeline ID (36 characters). pipeline_preset_id (str): Pipeline preset ID (1-100 characters). config_payload (list[ConfigPayload]): List of config payloads. user (CurrentUser | None, optional): Current user information. Defaults to None.
Successful Response
Validation Error
Get details for a specific preset by its unique identifier.
The ID of the preset
Successful Response
Validation Error
Update an existing preset with the provided configuration data.
The ID of the preset to update
Update preset request schema.
Attributes: pipeline_preset_id (str | None, optional): Pipeline preset ID (1-100 characters). Defaults to None. config_payload (list[ConfigPayload] | None, optional): List of config payloads. Defaults to None. user (CurrentUser | None, optional): Current user information. Defaults to None.
Successful Response
Validation Error
Delete a specific preset by its unique identifier.
The ID of the preset to delete
Successful Response
Validation Error
No content
Get all RAG (Retrieval-Augmented Generation) presets associated with a specific pipeline.
The ID of the pipeline
The search query
Successful Response
Validation Error
Get all DPO (Document Processing Orchestrator) presets associated with a specific pipeline.
The ID of the pipeline
The search query
Successful Response
Validation Error
Get a complete list of all prompt builder catalogs in the system.
Successful Response
Validation Error
Get a prompt builder catalog associated with a specific pipeline ID.
The ID of the pipeline to retrieve
Successful Response
Validation Error
Get details for a specific prompt builder catalog by its unique identifier.
The ID of the prompt builder catalog to retrieve
Successful Response
Validation Error
Update an existing prompt builder catalog with the provided configuration data.
The ID of the prompt builder catalog to update
Update prompt builder catalog request schema.
Attributes: name (str | None): The name of the prompt builder catalog. description (str | None): The description of the prompt builder catalog. is_override (bool | None): Whether the prompt builder catalog is an override of CHATBOT catalog. level (CatalogLevelType | None): The level of the prompt builder catalog. level_entity_id (str | None): The ID of the entity that the prompt builder catalog belongs to.
Level type enum for catalogs.
Successful Response
Validation Error
Create a new prompt builder catalog with the provided configuration data.
Create prompt builder catalog request schema.
Attributes: name (str): The name of the prompt builder catalog. description (str | None): The description of the prompt builder catalog. is_override (bool): Whether the prompt builder catalog is an override of CHATBOT catalog. level (CatalogLevelType): The level of the prompt builder catalog. level_entity_id (str | None): The ID of the entity that the prompt builder catalog belongs to.
falseLevel type enum for catalogs.
Successful Response
Validation Error
Get details for a specific prompt builder catalog entry by its unique identifier.
The ID of the prompt builder catalog entry to retrieve
Successful Response
Validation Error
Update an existing prompt builder catalog entry with the provided configuration data.
The ID of the prompt builder catalog entry to update
Update prompt builder catalog entry request schema.
Successful Response
Validation Error
Delete a specific prompt builder catalog entry by its unique identifier.
The ID of the prompt builder catalog entry to delete
Successful Response
Validation Error
No content
Create a new prompt builder catalog entry with the provided configuration data.
Create prompt builder catalog entry request schema.
prompt_builderSuccessful Response
Validation Error
Get a complete list of all prompt template groups in the system.
Successful Response
Validation Error
Get details for a specific prompt template group by its unique identifier.
The ID of the prompt template group to retrieve
Successful Response
Validation Error
Update an existing prompt template group with the provided configuration data.
The ID of the prompt template group to update
Update prompt template group request schema.
Successful Response
Validation Error
Delete a specific prompt template group by its unique identifier.
The ID of the prompt template group to delete
Successful Response
Validation Error
No content
Create a new prompt template group with the provided configuration data.
Create prompt template group request schema.
Successful Response
Validation Error
Get a complete list of all prompt template group entries in the system.
Successful Response
Validation Error
Get details for a specific prompt template group entry by its unique identifier.
The ID of the prompt template group entry to retrieve
Successful Response
Validation Error
Update an existing prompt template group entry with the provided configuration data.
The ID of the prompt template group entry to update
Update prompt template group entry request schema.
Successful Response
Validation Error
Delete a specific prompt template group entry by its unique identifier.
The ID of the prompt template group entry to delete
Successful Response
Validation Error
No content
Get all prompt template group entries associated with a specific model ID.
The ID of the model to retrieve entries for
Successful Response
Validation Error
Create a new prompt template group entry with the provided configuration data.
Create prompt template group entry request schema.
Successful Response
Validation Error
Get a complete list of all available providers in the system.
Search query for provider names
110Sort order enum.
ascPossible values: Successful Response
Validation Error
Create a new provider with the provided configuration data.
Provider creation request schema.
Attributes: name (str): Unique identifier for the provider. display_name (str | None, optional): Display name for the provider. Defaults to None. icon (str | None, optional): Icon for the provider. Defaults to None. lm_invoker_type (str | None, optional): LM invoker type for the provider. Defaults to None. provider_kwargs (str | None, optional): Provider kwargs for the provider. Defaults to None. provider_env_kwargs (str | None, optional): Provider env kwargs for the provider. Defaults to None. is_active (bool, optional): Is the provider active. Defaults to True. user (CurrentUser | None, optional): Current user information. Defaults to None.
Unique identifier for the provider
Display name for the provider
Icon for the provider
LM invoker type for the provider
Provider kwargs for the provider
Provider env kwargs for the provider
Is the provider active
trueSuccessful Response
Validation Error
Get a complete list of all available providers in the system.
Successful Response
Validation Error
Get details for a specific provider by its unique identifier.
The ID of the provider to retrieve
Successful Response
Validation Error
Update an existing provider with the provided configuration data.
The ID of the provider to update
Provider update request schema.
Attributes: name (str | None, optional): Unique identifier for the provider. Defaults to None. display_name (str | None, optional): Display name for the provider. Defaults to None. icon (str | None, optional): Icon for the provider. Defaults to None. lm_invoker_type (str | None, optional): LM invoker type for the provider. Defaults to None. provider_kwargs (str | None, optional): Provider kwargs for the provider. Defaults to None. provider_env_kwargs (str | None, optional): Provider env kwargs for the provider. Defaults to None. is_active (bool | None, optional): Is the provider active. Defaults to None. user (CurrentUser | None, optional): Current user information. Defaults to None.
Unique identifier for the provider
Display name for the provider
Icon for the provider
LM invoker type for the provider
Provider kwargs for the provider
Provider env kwargs for the provider
Is the provider active
Successful Response
Validation Error
Delete a specific provider by its unique identifier.
The ID of the provider to delete
Successful Response
Validation Error
No content
Update multiple resource quota values
Successful Response
Validation Error
Update resource quota value
Enum for quota names.
Request schema for updating resource quota.
Attributes: value (int): The new quota value (0-1M).
New quota value (0-1M)
Successful Response
Validation Error
Get a complete list of all roles available in the system.This endpoint is deprecated and will be removed in the future.
Successful Response
Validation Error
Get all subscriptions
Search query for subscription names
110Sort order enum.
ascPossible values: Successful Response
Validation Error
Get a subscription by current tenant
Successful Response
Validation Error
Get a subscription by id
Successful Response
Validation Error
Get a list of system settings.
Filter by public settings
Successful Response
Validation Error
Get a system setting by its key.
The key of the system setting
Successful Response
Validation Error
Get a system setting by its ID.
The ID of the system setting
Successful Response
Validation Error
Update an existing system setting.
The ID of the system setting to update
Update system setting request schema.
Successful Response
Validation Error
Get a paginated list of users
The username to search for
110Sort order enum.
ascPossible values: Successful Response
Validation Error
Create a new user
User create model.
Admin user provider.
falsetrueRoles for the user
Successful Response
Validation Error
Get a user by ID
User ID
Successful Response
Validation Error
Update a user by ID
User ID
User update model.
trueRoles for the user
Successful Response
Validation Error
Delete a user by ID
User ID
Successful Response
Validation Error
No content
Bulk update user status for multiple users
Bulk user update status model.
Successful Response
Validation Error
Get a paginated list of all user accounts with optional search filtering by username.
The username to search for
110Sort order enum.
ascPossible values: Successful Response
Validation Error
Create a new user account with the provided configuration data.
User account create model revamp.
User account provider.
trueRoles for the user
Successful Response
Validation Error
Update the status of multiple user accounts in a single operation.
Bulk user account update status model.
Successful Response
Validation Error
Get a complete list of all user accounts in the system.
Successful Response
Validation Error
Get details for a specific user account by its unique identifier.
Successful Response
Validation Error
Update an existing user account with the provided configuration data.
User account update model revamp.
trueRoles for the user
Successful Response
Validation Error
Delete a specific user account by its unique identifier.
Successful Response
Validation Error
Get a complete list of all user domains in the system.
Successful Response
Validation Error
Get details for a specific user domain by its unique identifier.
The ID of the user domain to retrieve
Successful Response
Validation Error
Update an existing user domain with the provided data.
The ID of the user domain to update
Update User Domain request model.
Successful Response
Validation Error
Delete a specific user domain by its unique identifier.
The ID of the user domain to delete
Successful Response
Validation Error
No content
Create a new user domain with the provided data.
Create User Domain request model.
Successful Response
Validation Error
Get a complete list of all vector stores in the system.
Successful Response
Validation Error
Create a new vector store with the provided configuration data.
Create vector store request schema.
Successful Response
Validation Error
Get details for a specific vector store by its unique identifier.
The ID of the vector store to retrieve
Successful Response
Validation Error
Update an existing vector store with the provided configuration data.
The ID of the vector store to update
Update vector store request schema.
Successful Response
Validation Error
Delete a specific vector store by its unique identifier.
The ID of the vector store to delete
Successful Response
Validation Error
No content
Get provider configurations
The provider type (qiscus or twilio)
Successful Response
Validation Error
Configure a WhatsApp provider
The provider type (qiscus or twilio)
The configuration request
Successful Response
Validation Error
Add a phone number to a WhatsApp provider
The provider type (qiscus or twilio)
Request schema for adding a phone number.
Attributes: phone_number (str): The phone number in E.164 format. display_name (str | None): Optional display name for the phone number. provider_metadata (dict[str, Any] | None): Provider-specific metadata.
Phone number in E.164 format
^\+[1-9]\d{1,14}$Optional display name for the phone number
Provider-specific metadata (e.g., channel_id for Qiscus)
Successful Response
Validation Error
Get phone numbers with optional filtering
Filter by provider type
Provider type enumeration.
Filter by active status
Include associated chatbots
falseSearch query for phone number
Successful Response
Validation Error
Get a phone number by ID
The phone number ID
Successful Response
Validation Error
Update a phone number
The phone number ID
Request schema for updating a phone number.
Attributes: phone_number (str): The phone number in E.164 format. display_name (str | None): Optional display name for the phone number. is_active (bool | None): Whether the phone number is active. provider_metadata (dict[str, Any] | None): Provider-specific metadata.
Phone number in E.164 format
^\+[1-9]\d{1,14}$Optional display name for the phone number
Whether the phone number is active
Provider-specific metadata (e.g., channel_id for Qiscus)
Successful Response
Validation Error
Remove a phone number
The phone number ID
Successful Response
Validation Error
No content
Assign a phone number to a chatbot
The chatbot ID
Request schema for assigning a phone number to a chatbot.
Attributes: phone_number_id (str | None): The phone number ID. Defaults to None.
Successful Response
Validation Error
Last updated