Create Tool Version

POST /api/public/v2/tool-registry/{identifier}/versions

Create Tool Version

cURL

curl --request POST \
  --url https://api.promptlayer.com/api/public/v2/tool-registry/{identifier}/versions \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "tool_definition": {},
  "execution": {
    "type": "code",
    "code": "<string>"
  },
  "commit_message": "<string>"
}
'

import requests

url = "https://api.promptlayer.com/api/public/v2/tool-registry/{identifier}/versions"

payload = {
    "tool_definition": {},
    "execution": {
        "type": "code",
        "code": "<string>"
    },
    "commit_message": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tool_definition: {},
    execution: {type: 'code', code: '<string>'},
    commit_message: '<string>'
  })
};

fetch('https://api.promptlayer.com/api/public/v2/tool-registry/{identifier}/versions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.promptlayer.com/api/public/v2/tool-registry/{identifier}/versions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'tool_definition' => [
        
    ],
    'execution' => [
        'type' => 'code',
        'code' => '<string>'
    ],
    'commit_message' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.promptlayer.com/api/public/v2/tool-registry/{identifier}/versions"

	payload := strings.NewReader("{\n  \"tool_definition\": {},\n  \"execution\": {\n    \"type\": \"code\",\n    \"code\": \"<string>\"\n  },\n  \"commit_message\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.promptlayer.com/api/public/v2/tool-registry/{identifier}/versions")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tool_definition\": {},\n  \"execution\": {\n    \"type\": \"code\",\n    \"code\": \"<string>\"\n  },\n  \"commit_message\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.promptlayer.com/api/public/v2/tool-registry/{identifier}/versions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tool_definition\": {},\n  \"execution\": {\n    \"type\": \"code\",\n    \"code\": \"<string>\"\n  },\n  \"commit_message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "success": true,
  "version": {}
}

Create a new immutable version of an existing tool. Use this to update the schema or to attach an auto-execution body.

The new version is assigned the next sequential version number. Pass a commit_message to leave an audit-trail note.

If you include execution, PromptLayer will run the body in a sandbox whenever a prompt referencing this version is invoked. The code field is the function body only. The signature is generated server-side.

Authorizations

X-API-KEY · string · header · required

Headers

X-API-KEY · string · required

Path Parameters

identifier · string · required

Tool ID (numeric) or name

Body

application/json

tool_definition · object · required

Tool definition in OpenAI function-calling format

execution · object | null

Optional sandbox-executable body. When set, PromptLayer auto-runs the body between LLM turns whenever a prompt uses this version. See Auto Tool Execution.

Show child attributes

commit_message · string | null

Commit message for the new version

Response

201

application/json

Version created

success · boolean

version · object