Skip to main content
PATCH
/
v1
/
integration
/
prompts
/
{prompt_id}
Update prompt
curl --request PATCH \
  --url https://api.aivra.cloud/v1/integration/prompts/{prompt_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "key": "<string>",
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "project_id": "<string>",
  "key": "<string>",
  "name": "<string>",
  "description": "<string>",
  "latest_version_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

​
Propósito

Atualiza campos básicos do prompt (nome, chave, descrição).

​
Parâmetros

  • prompt_id (path, string) obrigatório
  • Corpo JSON com qualquer combinação de:
    • key (string)
    • name (string)
    • description (string)

​
Dados retornados

Objeto do prompt atualizado.

​
Exemplo

curl -X PATCH "${BASE_URL}/v1/integration/prompts/pr_1" \
  -H "X-API-Key: ak_xxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Boas-vindas v2",
    "description": "Com emojis"
  }'

​
Códigos de status

  • 200 Sucesso
  • 404 Prompt não encontrado
  • 403 Projeto não autorizado pela API Key

​
Casos de uso

  • Renomear e organizar prompts sem alterar versões

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
prompt_id
string
required

Body

application/json
​
key
string
​
name
string
​
description
string | null

Response

200 - application/json

OK

​
id
string
required
​
project_id
string
required
​
key
string
required
​
name
string
required
​
description
string | null
​
latest_version_id
string | null
​
created_at
string<date-time> | null