Chaves de API

Liste as suas chaves de API, crie uma chave limitada a alguns dos seus projetos, por exemplo, uma por cada projeto de cliente, e revogue uma delas. Estes endpoints exigem uma chave com acesso a toda a conta e com o âmbito read_write.

GET`/api_keys`

As suas chaves de API, da mais recente para a mais antiga, incluindo as revogadas, com name, o prefix visível, scope, project_ids (vazio numa chave com acesso a toda a conta), last_used_at e revoked_at. O token secreto nunca é devolvido. Também disponível em planos inferiores ao Scale, para que continue a ser possível revogar as chaves antigas.

Parâmetros:

page
per_pagepredefinido 20, máximo 100

POST`/api_keys`

Cria uma chave limitada aos projetos indicados em project_ids, pertencente ao utilizador da chave que faz a chamada. O token secreto da nova chave só é devolvido nesta resposta, por isso guarde-o. A chave nunca vê outros projetos e este endpoint nunca cria uma chave com acesso a toda a conta. Se indicar um projeto a que não tem acesso, o pedido devolve ERR_PROJECT_NOT_FOUND; quando já tiver 500 chaves ativas, devolve ERR_LIMIT_REACHED até revogar uma. Requer o plano Scale ou superior.

Corpo (JSON):

nameobrigatório, até 100 caracteres
project_idsobrigatório, pelo menos um id de projeto
scoperead por predefinição, ou read_write

DELETE`/api_keys/:id`

Revoga uma das suas chaves: deixa de funcionar de imediato e não pode ser restaurada. Voltar a revogá-la não tem qualquer efeito. Também disponível em planos inferiores ao Scale.

Caminho:

:idid da chave devolvido por GET /api_keys

Devolve ERR_NOT_FOUND para uma chave que pertença a outro utilizador.

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/api_keys?per_page=20"

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/api_keys?per_page=20",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

package main

import "net/http"

func main() {
	req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/api_keys?per_page=20", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

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

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.llmpulse.ai/api/v1/api_keys?per_page=20"))
            .header("Authorization", "Bearer YOUR_API_KEY")
            .GET()
            .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 '{"name":"Client A","project_ids":["PROJECT_ID"],"scope":"read"}' \
  "https://api.llmpulse.ai/api/v1/api_keys"

const response = await fetch("https://api.llmpulse.ai/api/v1/api_keys", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"name":"Client A","project_ids":["PROJECT_ID"],"scope":"read"})
});
const data = await response.json();

import requests

response = requests.post(
    "https://api.llmpulse.ai/api/v1/api_keys",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"name": "Client A", "project_ids": ["PROJECT_ID"], "scope": "read"}
)
data = response.json()

require 'httparty'
require 'json'

response = HTTParty.post(
  "https://api.llmpulse.ai/api/v1/api_keys",
  headers: {
    "Authorization" => "Bearer YOUR_API_KEY",
    "Content-Type" => "application/json"
  },
  body: { "name" => "Client A", "project_ids" => ["PROJECT_ID"], "scope" => "read" }.to_json
)
data = response.parsed_response

package main

import (
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.llmpulse.ai/api/v1/api_keys", strings.NewReader(`{"name":"Client A","project_ids":["PROJECT_ID"],"scope":"read"}`))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")
	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://api.llmpulse.ai/api/v1/api_keys', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
    'json' => ['name' => 'Client A', 'project_ids' => ['PROJECT_ID'], 'scope' => 'read']
]);
$data = json_decode($response->getBody(), true);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.llmpulse.ai/api/v1/api_keys"))
            .header("Authorization", "Bearer YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString("{\"name\":\"Client A\",\"project_ids\":[\"PROJECT_ID\"],\"scope\":\"read\"}"))
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    }
}

Request

curl -X DELETE -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/api_keys/123"

const response = await fetch("https://api.llmpulse.ai/api/v1/api_keys/123", {
  method: "DELETE",
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

package main

import "net/http"

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.llmpulse.ai/api/v1/api_keys/123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

$client = new GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://api.llmpulse.ai/api/v1/api_keys/123', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.llmpulse.ai/api/v1/api_keys/123"))
            .header("Authorization", "Bearer YOUR_API_KEY")
            .DELETE()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    }
}

Chaves de API

GET/api_keys

POST/api_keys

DELETE/api_keys/:id

GET`/api_keys`

POST`/api_keys`

DELETE`/api_keys/:id`