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>"
}
'import requests
url = "https://api.aivra.cloud/v1/integration/prompts/{prompt_id}/set-active"
payload = {
"environment": "<string>",
"version_id": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({environment: '<string>', version_id: '<string>'})
};
fetch('https://api.aivra.cloud/v1/integration/prompts/{prompt_id}/set-active', 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.aivra.cloud/v1/integration/prompts/{prompt_id}/set-active",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'environment' => '<string>',
'version_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.aivra.cloud/v1/integration/prompts/{prompt_id}/set-active"
payload := strings.NewReader("{\n \"environment\": \"<string>\",\n \"version_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.post("https://api.aivra.cloud/v1/integration/prompts/{prompt_id}/set-active")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"environment\": \"<string>\",\n \"version_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aivra.cloud/v1/integration/prompts/{prompt_id}/set-active")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"environment\": \"<string>\",\n \"version_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"updated": true
}Integração
Criar Ambiente
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>"
}
'import requests
url = "https://api.aivra.cloud/v1/integration/prompts/{prompt_id}/set-active"
payload = {
"environment": "<string>",
"version_id": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({environment: '<string>', version_id: '<string>'})
};
fetch('https://api.aivra.cloud/v1/integration/prompts/{prompt_id}/set-active', 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.aivra.cloud/v1/integration/prompts/{prompt_id}/set-active",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'environment' => '<string>',
'version_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.aivra.cloud/v1/integration/prompts/{prompt_id}/set-active"
payload := strings.NewReader("{\n \"environment\": \"<string>\",\n \"version_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.post("https://api.aivra.cloud/v1/integration/prompts/{prompt_id}/set-active")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"environment\": \"<string>\",\n \"version_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aivra.cloud/v1/integration/prompts/{prompt_id}/set-active")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"environment\": \"<string>\",\n \"version_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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,stagingversion_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
Was this page helpful?
⌘I