Skip to main content
POST
/
specifications
/
batch
Create multiple specifications
curl --request POST \
  --url https://api.galtea.ai/specifications/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "specifications": [
    {
      "id": "spec_123",
      "productId": "prod_123",
      "userId": "user_123",
      "description": "Product must respond accurately to user queries",
      "type": "CAPABILITY",
      "testType": "QUALITY",
      "testVariant": "rag",
      "useForTestAlignment": true,
      "metricIds": [
        "metric_123"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
'
import requests

url = "https://api.galtea.ai/specifications/batch"

payload = { "specifications": [
        {
            "id": "spec_123",
            "productId": "prod_123",
            "userId": "user_123",
            "description": "Product must respond accurately to user queries",
            "type": "CAPABILITY",
            "testType": "QUALITY",
            "testVariant": "rag",
            "useForTestAlignment": True,
            "metricIds": ["metric_123"],
            "createdAt": "2023-11-07T05:31:56Z",
            "deletedAt": "2023-11-07T05:31:56Z"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    specifications: [
      {
        id: 'spec_123',
        productId: 'prod_123',
        userId: 'user_123',
        description: 'Product must respond accurately to user queries',
        type: 'CAPABILITY',
        testType: 'QUALITY',
        testVariant: 'rag',
        useForTestAlignment: true,
        metricIds: ['metric_123'],
        createdAt: '2023-11-07T05:31:56Z',
        deletedAt: '2023-11-07T05:31:56Z'
      }
    ]
  })
};

fetch('https://api.galtea.ai/specifications/batch', 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.galtea.ai/specifications/batch",
  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([
    'specifications' => [
        [
                'id' => 'spec_123',
                'productId' => 'prod_123',
                'userId' => 'user_123',
                'description' => 'Product must respond accurately to user queries',
                'type' => 'CAPABILITY',
                'testType' => 'QUALITY',
                'testVariant' => 'rag',
                'useForTestAlignment' => true,
                'metricIds' => [
                                'metric_123'
                ],
                'createdAt' => '2023-11-07T05:31:56Z',
                'deletedAt' => '2023-11-07T05:31:56Z'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.galtea.ai/specifications/batch"

	payload := strings.NewReader("{\n  \"specifications\": [\n    {\n      \"id\": \"spec_123\",\n      \"productId\": \"prod_123\",\n      \"userId\": \"user_123\",\n      \"description\": \"Product must respond accurately to user queries\",\n      \"type\": \"CAPABILITY\",\n      \"testType\": \"QUALITY\",\n      \"testVariant\": \"rag\",\n      \"useForTestAlignment\": true,\n      \"metricIds\": [\n        \"metric_123\"\n      ],\n      \"createdAt\": \"2023-11-07T05:31:56Z\",\n      \"deletedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.galtea.ai/specifications/batch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"specifications\": [\n    {\n      \"id\": \"spec_123\",\n      \"productId\": \"prod_123\",\n      \"userId\": \"user_123\",\n      \"description\": \"Product must respond accurately to user queries\",\n      \"type\": \"CAPABILITY\",\n      \"testType\": \"QUALITY\",\n      \"testVariant\": \"rag\",\n      \"useForTestAlignment\": true,\n      \"metricIds\": [\n        \"metric_123\"\n      ],\n      \"createdAt\": \"2023-11-07T05:31:56Z\",\n      \"deletedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.galtea.ai/specifications/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"specifications\": [\n    {\n      \"id\": \"spec_123\",\n      \"productId\": \"prod_123\",\n      \"userId\": \"user_123\",\n      \"description\": \"Product must respond accurately to user queries\",\n      \"type\": \"CAPABILITY\",\n      \"testType\": \"QUALITY\",\n      \"testVariant\": \"rag\",\n      \"useForTestAlignment\": true,\n      \"metricIds\": [\n        \"metric_123\"\n      ],\n      \"createdAt\": \"2023-11-07T05:31:56Z\",\n      \"deletedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
[
  {
    "id": "spec_123",
    "productId": "prod_123",
    "userId": "user_123",
    "description": "Product must respond accurately to user queries",
    "type": "CAPABILITY",
    "testType": "QUALITY",
    "testVariant": "rag",
    "useForTestAlignment": true,
    "metricIds": [
      "metric_123"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  }
]
{
  "error": "Error type",
  "message": "Error message description"
}
{
  "error": "Error type",
  "message": "Error message description"
}

Authorizations

​
Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Body

application/json
​
specifications
object[]
required

Response

Specifications created successfully

​
id
string
Example:

"spec_123"

​
productId
string
Example:

"prod_123"

​
userId
string | null
Example:

"user_123"

​
description
string
Example:

"Product must respond accurately to user queries"

​
type
enum<string>
Available options:
CAPABILITY,
INABILITY,
POLICY
Example:

"CAPABILITY"

​
testType
enum<string> | null

Only applicable for POLICY specifications. Must be null for CAPABILITY and INABILITY.

Available options:
QUALITY,
RED_TEAMING,
SCENARIOS
Example:

"QUALITY"

​
testVariant
string | null

Only applicable for POLICY specifications. QUALITY: rag, entity_extraction, summarization, classification, translation, correction, other. RED_TEAMING: data_leakage, financial_attacks, illegal_activities, misuse, toxicity, custom.

Example:

"rag"

​
useForTestAlignment
boolean
Example:

true

​
metricIds
string[]
Example:
["metric_123"]
​
createdAt
string<date-time>
​
deletedAt
string<date-time> | null