Skip to main content
POST
/
v1
/
integration
/
prompts
/
{prompt_id}
/
set-active
Set active version
curl --request POST \
  --url https://api.aivra.cloud/v1/integration/prompts/{prompt_id}/set-active \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "environment": "<string>",
  "version_id": "<string>"
}
'
{
  "updated": true
}

​
Propósito

Define a versão ativa de um prompt para um ambiente.

​
Parâmetros

  • prompt_id (path, string) obrigatório
  • Corpo JSON:
    • environment (string) obrigatório. Ex.: production, staging
    • version_id (string) obrigatório

​
Dados retornados

{"updated": true} em caso de sucesso.

​
Exemplo

curl -X POST "${BASE_URL}/v1/integration/prompts/pr_1/set-active" \
  -H "X-API-Key: ak_xxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "environment": "production",
    "version_id": "ver_12"
  }'

​
Códigos de status

  • 200 Sucesso
  • 404 Prompt ou versão não encontrada
  • 403 Projeto não autorizado pela API Key

​
Casos de uso

  • Promover versão de staging para produção

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
prompt_id
string
required

Body

application/json
​
environment
string
required
​
version_id
string
required

Response

200 - application/json

OK

​
updated
boolean
required