Skip to main content
PATCH
/
reports
/
{report_id}
/
rename
Rename Evaluation Pipeline
curl --request PATCH \
  --url https://api.promptlayer.com/reports/{report_id}/rename \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "name": "<string>",
  "tags": [
    "<string>"
  ]
}
'
{
  "success": true,
  "report": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.promptlayer.com/llms.txt

Use this file to discover all available pages before exploring further.

Rename or retag an evaluation pipeline. Provide name, tags, or both. Use this instead of recreating a misnamed pipeline.

​
Request Body

At least one of name or tags must be provided.
FieldTypeRequiredDescription
namestringNoNew name for the pipeline. 1–255 characters.
tagsstring[]NoReplacement tags. Pass an empty array to clear all tags.

​
Example

import requests

response = requests.patch(
    "https://api.promptlayer.com/reports/456/rename",
    headers={"X-API-KEY": "your-api-key"},
    json={
        "name": "Customer support — production blueprint",
        "tags": ["production", "support"],
    },
)

​
Error Responses

StatusError
400Neither name nor tags was provided
404Report not found or not accessible

Headers

​
X-API-KEY
string
required

Your PromptLayer API key.

Path Parameters

​
report_id
integer
required

ID of the evaluation pipeline to rename.

Body

application/json

At least one of name or tags must be provided.

​
name
string

New name for the evaluation pipeline.

Required string length: 1 - 255
​
tags
string[]

Replacement tags. Pass an empty array to clear all tags.

Response

Pipeline renamed successfully

​
success
boolean
​
report
object

The updated report