Delete Folder Entities

DELETE /api/public/v2/folders/entities

Delete Folder Entities

cURL

curl --request DELETE \
  --url https://api.promptlayer.com/api/public/v2/folders/entities \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "entities": [
    {
      "id": 123
    }
  ],
  "cascade": false,
  "workspace_id": 123
}
'

import requests

url = "https://api.promptlayer.com/api/public/v2/folders/entities"

payload = {
    "entities": [{ "id": 123 }],
    "cascade": False,
    "workspace_id": 123
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({entities: [{id: 123}], cascade: false, workspace_id: 123})
};

fetch('https://api.promptlayer.com/api/public/v2/folders/entities', 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/folders/entities",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'entities' => [
        [
                'id' => 123
        ]
    ],
    'cascade' => false,
    'workspace_id' => 123
  ]),
  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/folders/entities"

	payload := strings.NewReader("{\n  \"entities\": [\n    {\n      \"id\": 123\n    }\n  ],\n  \"cascade\": false,\n  \"workspace_id\": 123\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://api.promptlayer.com/api/public/v2/folders/entities")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entities\": [\n    {\n      \"id\": 123\n    }\n  ],\n  \"cascade\": false,\n  \"workspace_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.promptlayer.com/api/public/v2/folders/entities")

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

request = Net::HTTP::Delete.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entities\": [\n    {\n      \"id\": 123\n    }\n  ],\n  \"cascade\": false,\n  \"workspace_id\": 123\n}"

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

200

{
  "moved_count": 123
}

{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}

Deletes one or more entities from the workspace. Supports deleting folders, prompts, snippets, workflows, datasets, evaluations, AB tests, and input variable sets. Use cascade=true to recursively delete all contents of a folder. Without cascade, deleting a non-empty folder returns an error. Entities are soft-deleted where applicable.

Authorizations

X-API-KEY · string · header · required

Body

application/json

entities · EntityReference · object[] · required

List of entities to delete.

Show child attributes

cascade · boolean · default: false

When true, recursively deletes all contents of any folders in the entities list. When false, attempting to delete a non-empty folder returns an error.

workspace_id · integer

The ID of the workspace.

Response

200

application/json

Entities deleted successfully

moved_count · integer

The number of entities affected by the operation.