How toPrompt 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:

Original API Payload:

Zipcode API payload

{
	"check": "123333"
}

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

Create a Schema-based Prompt Tool

Create an API-based Prompt Tool

Example

On this page