Coleções e etiquetas

As coleções (designadas Etiquetas na aplicação) agrupam Prompts por tema, fase do funil ou campanha, para que cada métrica possa ser filtrada por elas. Um Prompt pode pertencer a várias.

GET`/dimensions/collections`

Lista as coleções (Etiquetas) pertencentes ao projeto.

GET`/dimensions/tags`

Alias de /dimensions/collections. Devolve o mesmo payload, mas designado como etiquetas para consistência com a interface.

POST`/collections`

Cria uma etiqueta (Collection) num projeto. Permite associar prompts existentes na mesma chamada. O nome da etiqueta é único por projeto, sem distinção de maiúsculas/minúsculas.

Corpo (JSON):

project_idobrigatório
nameobrigatório
descriptionopcional
prompt_idsarray opcional, tem de pertencer ao projeto

PATCH/DELETE /collections/:id

Altere o nome ou a descrição de uma etiqueta, ou elimine-a. Ao eliminar uma etiqueta, os Prompts que a integram são mantidos; apenas o agrupamento desaparece. A associação dos Prompts é gerida através de POST /prompts/assign_tags.

Corpo do PATCH: project_id (obrigatório), name e/ou description. DELETE: project_id + :id no URL.

POST`/prompts/assign_tags`

Associação em massa idempotente de etiquetas a prompts existentes. As etiquetas podem ser resolvidas por id ou por nome.

Corpo (JSON):

project_idobrigatório
prompt_idsarray obrigatório
tag_idsum de dois
tag_namesum de dois
create_missingbool opcional, cria automaticamente nomes de etiqueta desconhecidos

Exemplos de código

Download: OpenAPI Swagger Postman

Perguntar à IA: Abrir no ChatGPT Abrir no Claude Ver como Markdown

Linguagem

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/dimensions/collections?project_id=PROJECT_ID"

const response = await fetch("https://api.llmpulse.ai/api/v1/dimensions/collections?project_id=PROJECT_ID", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/dimensions/collections?project_id=PROJECT_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/dimensions/collections?project_id=PROJECT_ID",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/dimensions/collections?project_id=PROJECT_ID", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/dimensions/collections?project_id=PROJECT_ID', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/dimensions/collections?project_id=PROJECT_ID"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/dimensions/tags?project_id=PROJECT_ID"

const response = await fetch("https://api.llmpulse.ai/api/v1/dimensions/tags?project_id=PROJECT_ID", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/dimensions/tags?project_id=PROJECT_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/dimensions/tags?project_id=PROJECT_ID",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/dimensions/tags?project_id=PROJECT_ID", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/dimensions/tags?project_id=PROJECT_ID', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/dimensions/tags?project_id=PROJECT_ID"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Response

{ "project_id":4, "collections":[ { "id":7, "name":"Brand: ACME" } ], "request_id":"..." }

Request

curl -X POST -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"project_id":"PROJECT_ID","name":"Branded prompts","description":"Prompts that mention us","prompt_ids":[101,102]}' \
  "https://api.llmpulse.ai/api/v1/collections"

const response = await fetch("https://api.llmpulse.ai/api/v1/collections", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"project_id":"PROJECT_ID","name":"Branded prompts","description":"Prompts that mention us","prompt_ids":[101,102]})
});
const data = await response.json();

import requests

response = requests.post(
    "https://api.llmpulse.ai/api/v1/collections",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"project_id":"PROJECT_ID","name":"Branded prompts","description":"Prompts that mention us","prompt_ids":[101,102]}
)
data = response.json()

require 'httparty'

response = HTTParty.post(
  "https://api.llmpulse.ai/api/v1/collections",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" },
  body: {"project_id":"PROJECT_ID","name":"Branded prompts","description":"Prompts that mention us","prompt_ids":[101,102]}
)
data = response.parsed_response

req, _ := http.NewRequest("POST", "https://api.llmpulse.ai/api/v1/collections", strings.NewReader(`{"project_id":"PROJECT_ID","name":"Branded prompts","description":"Prompts that mention us","prompt_ids":[101,102]}`))
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://api.llmpulse.ai/api/v1/collections', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
    'json' => {"project_id":"PROJECT_ID","name":"Branded prompts","description":"Prompts that mention us","prompt_ids":[101,102]}
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/collections"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("{\"project_id\":\"PROJECT_ID\",\"name\":\"Branded prompts\",\"description\":\"Prompts that mention us\",\"prompt_ids\":[101,102]}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Request

curl -X POST -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"project_id":"PROJECT_ID","prompt_ids":[101,102],"tag_names":["priority"],"create_missing":true}' \
  "https://api.llmpulse.ai/api/v1/prompts/assign_tags"

const response = await fetch("https://api.llmpulse.ai/api/v1/prompts/assign_tags", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"project_id":"PROJECT_ID","prompt_ids":[101,102],"tag_names":["priority"],"create_missing":true})
});
const data = await response.json();

import requests

response = requests.post(
    "https://api.llmpulse.ai/api/v1/prompts/assign_tags",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"project_id":"PROJECT_ID","prompt_ids":[101,102],"tag_names":["priority"],"create_missing":true}
)
data = response.json()

require 'httparty'

response = HTTParty.post(
  "https://api.llmpulse.ai/api/v1/prompts/assign_tags",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" },
  body: {"project_id":"PROJECT_ID","prompt_ids":[101,102],"tag_names":["priority"],"create_missing":true}
)
data = response.parsed_response

req, _ := http.NewRequest("POST", "https://api.llmpulse.ai/api/v1/prompts/assign_tags", strings.NewReader(`{"project_id":"PROJECT_ID","prompt_ids":[101,102],"tag_names":["priority"],"create_missing":true}`))
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://api.llmpulse.ai/api/v1/prompts/assign_tags', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
    'json' => {"project_id":"PROJECT_ID","prompt_ids":[101,102],"tag_names":["priority"],"create_missing":true}
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/prompts/assign_tags"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("{\"project_id\":\"PROJECT_ID\",\"prompt_ids\":[101,102],\"tag_names\":[\"priority\"],\"create_missing\":true}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Coleções e etiquetas

GET/dimensions/collections

GET/dimensions/tags

POST/collections

PATCH/DELETE /collections/:id

POST/prompts/assign_tags

GET`/dimensions/collections`

GET`/dimensions/tags`

POST`/collections`

POST`/prompts/assign_tags`