Update a prompt (PATCH)
curl --request PATCH \
--url https://api.zerorank.ai/api/v1/prompts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "<string>",
"location": "<string>",
"tags": [
"<string>"
],
"topicId": 123,
"topicName": "<string>"
}
'import requests
url = "https://api.zerorank.ai/api/v1/prompts/{id}"
payload = {
"text": "<string>",
"location": "<string>",
"tags": ["<string>"],
"topicId": 123,
"topicName": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
text: '<string>',
location: '<string>',
tags: ['<string>'],
topicId: 123,
topicName: '<string>'
})
};
fetch('https://api.zerorank.ai/api/v1/prompts/{id}', 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.zerorank.ai/api/v1/prompts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'text' => '<string>',
'location' => '<string>',
'tags' => [
'<string>'
],
'topicId' => 123,
'topicName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.zerorank.ai/api/v1/prompts/{id}"
payload := strings.NewReader("{\n \"text\": \"<string>\",\n \"location\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"topicId\": 123,\n \"topicName\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.zerorank.ai/api/v1/prompts/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"<string>\",\n \"location\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"topicId\": 123,\n \"topicName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zerorank.ai/api/v1/prompts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"<string>\",\n \"location\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"topicId\": 123,\n \"topicName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": 101,
"text": "What is the best CRM for small teams?",
"location": "United States",
"workspaceId": 7,
"topicId": 3,
"lastScheduledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"topic": {
"id": 3,
"name": "CRM",
"workspaceId": 7,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"tags": [
{
"id": 5,
"name": "pricing",
"hexColor": "#3b82f6",
"promptCount": 8,
"workspaceId": 7,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"message": "Prompt retrieved successfully"
}{
"success": false,
"message": "Invalid, revoked, or expired API key",
"code": "API_KEY_INVALID"
}{
"success": false,
"message": "This API key is read-only; a key with the \"write\" scope is required",
"code": "INSUFFICIENT_SCOPE"
}{
"success": false,
"message": "Prompt not found"
}{
"success": false,
"message": "Validation failed",
"errors": [
{
"field": "text",
"message": "The text field is required"
}
]
}{
"success": false,
"message": "API rate limit exceeded. Please slow down.",
"code": "RATE_LIMIT_EXCEEDED",
"retryAfter": 30
}Update a prompt (PATCH)
Same as PUT /prompts/{id}. Updates a prompt’s text, status, location, tags, or topic. Needs a key with the write scope.
PATCH
/
prompts
/
{id}
Update a prompt (PATCH)
curl --request PATCH \
--url https://api.zerorank.ai/api/v1/prompts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "<string>",
"location": "<string>",
"tags": [
"<string>"
],
"topicId": 123,
"topicName": "<string>"
}
'import requests
url = "https://api.zerorank.ai/api/v1/prompts/{id}"
payload = {
"text": "<string>",
"location": "<string>",
"tags": ["<string>"],
"topicId": 123,
"topicName": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
text: '<string>',
location: '<string>',
tags: ['<string>'],
topicId: 123,
topicName: '<string>'
})
};
fetch('https://api.zerorank.ai/api/v1/prompts/{id}', 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.zerorank.ai/api/v1/prompts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'text' => '<string>',
'location' => '<string>',
'tags' => [
'<string>'
],
'topicId' => 123,
'topicName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.zerorank.ai/api/v1/prompts/{id}"
payload := strings.NewReader("{\n \"text\": \"<string>\",\n \"location\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"topicId\": 123,\n \"topicName\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.zerorank.ai/api/v1/prompts/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"<string>\",\n \"location\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"topicId\": 123,\n \"topicName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zerorank.ai/api/v1/prompts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"<string>\",\n \"location\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"topicId\": 123,\n \"topicName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": 101,
"text": "What is the best CRM for small teams?",
"location": "United States",
"workspaceId": 7,
"topicId": 3,
"lastScheduledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"topic": {
"id": 3,
"name": "CRM",
"workspaceId": 7,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"tags": [
{
"id": 5,
"name": "pricing",
"hexColor": "#3b82f6",
"promptCount": 8,
"workspaceId": 7,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"message": "Prompt retrieved successfully"
}{
"success": false,
"message": "Invalid, revoked, or expired API key",
"code": "API_KEY_INVALID"
}{
"success": false,
"message": "This API key is read-only; a key with the \"write\" scope is required",
"code": "INSUFFICIENT_SCOPE"
}{
"success": false,
"message": "Prompt not found"
}{
"success": false,
"message": "Validation failed",
"errors": [
{
"field": "text",
"message": "The text field is required"
}
]
}{
"success": false,
"message": "API rate limit exceeded. Please slow down.",
"code": "RATE_LIMIT_EXCEEDED",
"retryAfter": 30
}Authorizations
Send your workspace API key as Authorization: Bearer zr_live_….
Path Parameters
The numeric id of the item.
Body
application/json
Send only the fields you want to change.
Required string length:
1 - 5000Where a prompt is in its life: draft, active, paused, suggested (AI-proposed), or rejected.
Available options:
draft, active, paused, suggested, rejected Maximum string length:
255Tag names or tag ids. Replaces the prompt's current tags.
Maximum string length:
100Move to this topic, or null to remove the topic.
Topic name to move to (created if needed).
Maximum string length:
100⌘I