Maxim Logo
How to/Prompt Tools

Create an API-based Prompt Tool

Maxim allows you to expose external API endpoints as prompt tools. The platform automatically generates function schemas based on the API's query parameters and payload structure.

Example

Here's how an API payload gets converted into a function schema:

  1. Original API Payload:
Zipcode API payload
{
	"check": "123333"
}
  1. Generated Schema for LLM:
Payload sent to the model while making requests
{
	"type": "function",
	"function": {
		"parameters": {
			"type": "object",
			"properties": {
				"check": {
					"type": "string"
				}
			}
		},
		"name": "clt473gri0006yzrl26rz79iu", // This is the ID of the function.
		"description": "This function accepts a zipcode and returns the corresponding location information" // This is the description of the function.
	}
}

Create a code-based Prompt Tool

Code-based Prompt Tools allow you to create custom functions directly within the editor. This guide will show you how to create and test these tools.

Create a Schema-based Prompt Tool

Schema-based prompt tools provide a structured way to define tools that ensure accurate and schema-compliant outputs. This approach is particularly useful when you need to guarantee that the LLM's responses follow a specific format.

On this page