PATCH
/
v1
/
prompt
/
{id}
curl --request PATCH \
  --url https://api.getscorecard.ai/v1/prompt/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "is_prod": true
}'
{
  "org_id": "<string>",
  "user_id": "<string>",
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "is_archived": true,
  "prompt_template": "<string>",
  "model_params": {},
  "root_id": "<string>",
  "parent_id": "<string>",
  "merge_parent_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "project_id": 1
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string
required

The id of the prompt to update.

Body

application/json

The parameters to update a prompt.

​
is_prod
boolean | null
default:
false

Response

200
application/json
Successful Response
​
org_id
string | null

The organization this resource belongs to.

​
user_id
string | null

The user this record belongs to.

​
id
string | null
​
name
string | null
​
description
string | null
​
is_archived
boolean | null
default:
false
​
prompt_template
string | null
​
model_params
object | null
​
root_id
string | null
​
parent_id
string | null
​
merge_parent_id
string | null
​
created_at
string | null
​
project_id
integer | null

The ID of the project the prompt belongs to.

Was this page helpful?

Delete Root PromptGet Prompt By Name