Create prompt
curl --request POST \
--url https://api.aivra.cloud/v1/integration/prompts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"project_id": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.aivra.cloud/v1/integration/prompts"
payload = {
"project_id": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<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({
project_id: '<string>',
key: '<string>',
name: '<string>',
description: '<string>'
})
};
fetch('https://api.aivra.cloud/v1/integration/prompts', 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",
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([
'project_id' => '<string>',
'key' => '<string>',
'name' => '<string>',
'description' => '<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"
payload := strings.NewReader("{\n \"project_id\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<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")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aivra.cloud/v1/integration/prompts")
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 \"project_id\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"project_id": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"latest_version_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}Integração
Criar prompt
POST
/
v1
/
integration
/
prompts
Create prompt
curl --request POST \
--url https://api.aivra.cloud/v1/integration/prompts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"project_id": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.aivra.cloud/v1/integration/prompts"
payload = {
"project_id": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<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({
project_id: '<string>',
key: '<string>',
name: '<string>',
description: '<string>'
})
};
fetch('https://api.aivra.cloud/v1/integration/prompts', 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",
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([
'project_id' => '<string>',
'key' => '<string>',
'name' => '<string>',
'description' => '<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"
payload := strings.NewReader("{\n \"project_id\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<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")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aivra.cloud/v1/integration/prompts")
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 \"project_id\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"project_id": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"latest_version_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}Propósito
Cria um novo prompt dentro de um projeto.Parâmetros
Corpo JSON:project_id(string) obrigatóriokey(string) obrigatórioname(string) obrigatóriodescription(string) opcional
Dados retornados
Objeto do prompt recém-criado comid, project_id, key, name, description, latest_version_id, created_at.
Exemplo
curl -X POST "${BASE_URL}/v1/integration/prompts" \
-H "X-API-Key: ak_xxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"project_id": "proj_abc",
"key": "onboarding",
"name": "Onboarding",
"description": "Fluxo inicial"
}'
Códigos de status
- 200 Sucesso
- 404 Projeto não encontrado ou não pertence ao workspace
- 403 Projeto não autorizado pela API Key
Casos de uso
- Provisionar prompts a partir de pipelines de integração
Authorizations
Body
application/json
Was this page helpful?
⌘I