Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hypha-docs.plinqx.app/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through setting up Plinqx and exposing your first tool to AI clients.

​
Prerequisites

  • A Plinqx account (sign up here)
  • An API you want to connect (or use our demo endpoint)

​
Step 1: Create Your First Collection

Collections are how you organize and expose tools to AI clients.
1

Navigate to Collections

From the dashboard, click Collections in the sidebar.
2

Create a new Collection

Click Create Collection and give it a name like “My First Collection”.

​
Step 2: Add a Custom Tool

Let’s create a simple weather tool using a public API.
1

Navigate to Custom Tools

Click Custom Tools in the sidebar, then Create Custom Tool.
2

Configure Basic Info

  • Name: get_weather
  • Display Name: Get Weather
  • Description: Get current weather for a city
3

Configure Endpoint

  • Method: GET
  • Base URL: https://api.weatherapi.com/v1
  • Path: /current.json
  • Auth Type: API Key (Query Parameter)
4

Define Parameters

Add a q parameter for the city name:
  • Name: q
  • Type: string
  • Required: Yes
  • Description: City name to get weather for
5

Save and Publish

Click Save then Publish to make the tool available.
Your tool is now ready to be added to a Collection!

​
Step 3: Add Tool to Collection

1

Open your Collection

Go back to Collections and click on your collection.
2

Add the tool

Click Add Tools, find your weather tool, and add it.

​
Step 4: Generate an API Key

1

Navigate to API Keys

Click API Keys in the sidebar, then Create API Key.
2

Configure the key

  • Name: My First API Key
  • Collections: Select your collection
3

Copy the key

Copy your API key now - you won’t be able to see it again!

​
Step 5: Test in Playground

1

Open Playground

Navigate to Playground in the sidebar.
2

Select your Collection

Choose your collection from the dropdown.
3

Call the tool

Select get_weather, enter a city name, and click Execute.
Congratulations! You’ve successfully set up your first tool in Plinqx.

​
Next Steps

Connect to ChatGPT

Expose your tools to ChatGPT

Add Salesforce

Connect your Salesforce org

Build Workflows

Create multi-step automations

Set Up Policies

Add rate limiting and approvals