n8n Node for GPT Maker API

This is an n8n community node that allows you to interact with the GPT Maker API. It enables you to manage workspaces, agents, chats, trainings, and more directly within your n8n workflows.

Prerequisites

• An n8n instance (version 1.0.0 or later recommended).
• A GPT Maker account and an API Key. You can obtain your API Key from your GPT Maker dashboard.

Installation

1. Go to Settings > Community Nodes in your n8n instance.
2. Click Install and enter n8n-nodes-gptmaker as the package name.
3. Click Install again.

Alternatively, if you are self-hosting n8n, you can install it via npm/yarn in your n8n custom nodes directory or by setting the NODE_FUNCTION_ALLOW_EXTERNAL environment variable.

Credentials

To use this node, you need to configure your GPT Maker API credentials:

1. In n8n, go to the Credentials section.
2. Click Add credential.
3. Search for GPT Maker API and select it.
4. Enter your API Key in the provided field.
5. Click Save.

Supported Operations

This node supports the following operations, categorized by resource type:

Workspace

• List Workspaces: Retrieves a list of all workspaces accessible with your API key.
• Get Workspace Credit Balance: Fetches the current credit balance for a specified Workspace ID.

Agents

• List Agents: Lists all agents within a specified Workspace ID.
• Create Agent: Creates a new agent within a specified Workspace ID. Requires parameters like agent name, prompt, model, etc.
• Get Agent: Retrieves details for a specific agent by its Agent ID.
• Update Agent: Updates an existing agent. You can modify its name, prompt, model, and other settings.
• Delete Agent: Deletes a specified agent by its Agent ID.
• Get Agent Credit Consumption: Retrieves the credit consumption for a specific agent.
• Activate Agent: Activates an inactive agent.
• Deactivate Agent: Deactivates an active agent.
• Chat with Agent (Stream): Initiates a streaming chat session with an agent. (Note: Streaming responses might require specific handling in n8n or might be simplified to a single response for this node version).
• Add Context to Agent: Adds a message or context to an agent, which can be used for fine-tuning or providing prior conversation history without initiating a full chat.

Agent Settings

• Get Agent Settings: Retrieves the current settings for a specific agent.
• Update Agent Settings: Modifies the settings of a specific agent.

Agent Webhooks

• Get Agent Webhooks: Retrieves the configured webhooks for a specific agent.
• Update Agent Webhooks: Updates or sets the webhook URLs for various agent events.

Trainings

• List Trainings: Lists all training items for a specific agent.
• Create Training: Adds a new training item (e.g., text, URL, QnA) to an agent.
• Update Training: Updates an existing training item (currently supports text-based trainings).
• Delete Training: Removes a training item from an agent.

Chats

• List Chats: Lists all chat sessions within a specified Workspace ID.
• Delete Chat: Deletes a specific chat session by its Chat ID.
• List Chat Messages: Retrieves all messages from a specific chat session.

(Detailed input parameters and output structures for each operation will be visible within the node in n8n.)

Example Usage

(This section would ideally include a simple workflow example, e.g., List Workspaces -> Get First Workspace ID -> List Agents in that Workspace)

Compatibility

• n8n version 1.0.0 and later.

Resources

• GPT Maker API Documentation
• n8n Community Node Documentation

License

MIT