Get Workflow Labels

GET /workflows/{workflow_id_or_name}/labels

Get Agent Labels

cURL

curl --request GET \
  --url https://api.promptlayer.com/workflows/{workflow_id_or_name}/labels \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api.promptlayer.com/workflows/{workflow_id_or_name}/labels"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.promptlayer.com/workflows/{workflow_id_or_name}/labels', 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/workflows/{workflow_id_or_name}/labels",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.promptlayer.com/workflows/{workflow_id_or_name}/labels"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.promptlayer.com/workflows/{workflow_id_or_name}/labels")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.promptlayer.com/workflows/{workflow_id_or_name}/labels")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

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

200

{
  "success": true,
  "release_labels": [
    {
      "release_label": "<string>",
      "release_label_id": 123,
      "workflow_version_id": 123,
      "workflow_version_number": 123
    }
  ]
}

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

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

List all release labels for a workflow. Returns each label with its name, ID, and the version it points to.

This mirrors the Get Prompt Template Labels endpoint.

Authorizations

X-API-KEY · string · header · required

Path Parameters

workflow_id_or_name · string · required

The agent ID or name.

Response

200

application/json

Labels retrieved successfully

success · boolean · required

Example:

true

release_labels · object[] · required

Show child attributes