Definir configuração de uso

Defina ou remova limites de créditos adicionais por usuário, com a possibilidade de aplicá-los a uma equipe, grupo ou usuário individual para gerenciar o faturamento do Enterprise.

POST /api/v1/UsageConfig

Definir configuração de uso

cURL

curl --request POST \
  --url https://server.codeium.com/api/v1/UsageConfig \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "clear_add_on_credit_cap": true,
  "set_add_on_credit_cap": 123,
  "team_level": true,
  "group_id": "<string>",
  "user_email": "<string>"
}
'

import requests

url = "https://server.codeium.com/api/v1/UsageConfig"

payload = {
    "service_key": "<string>",
    "clear_add_on_credit_cap": True,
    "set_add_on_credit_cap": 123,
    "team_level": True,
    "group_id": "<string>",
    "user_email": "<string>"
}
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({
    service_key: '<string>',
    clear_add_on_credit_cap: true,
    set_add_on_credit_cap: 123,
    team_level: true,
    group_id: '<string>',
    user_email: '<string>'
  })
};

fetch('https://server.codeium.com/api/v1/UsageConfig', 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://server.codeium.com/api/v1/UsageConfig",
  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([
    'service_key' => '<string>',
    'clear_add_on_credit_cap' => true,
    'set_add_on_credit_cap' => 123,
    'team_level' => true,
    'group_id' => '<string>',
    'user_email' => '<string>'
  ]),
  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://server.codeium.com/api/v1/UsageConfig"

	payload := strings.NewReader("{\n  \"service_key\": \"<string>\",\n  \"clear_add_on_credit_cap\": true,\n  \"set_add_on_credit_cap\": 123,\n  \"team_level\": true,\n  \"group_id\": \"<string>\",\n  \"user_email\": \"<string>\"\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://server.codeium.com/api/v1/UsageConfig")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"service_key\": \"<string>\",\n  \"clear_add_on_credit_cap\": true,\n  \"set_add_on_credit_cap\": 123,\n  \"team_level\": true,\n  \"group_id\": \"<string>\",\n  \"user_email\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.codeium.com/api/v1/UsageConfig")

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  \"service_key\": \"<string>\",\n  \"clear_add_on_credit_cap\": true,\n  \"set_add_on_credit_cap\": 123,\n  \"team_level\": true,\n  \"group_id\": \"<string>\",\n  \"user_email\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

​

Visão geral

Defina ou remova limites de uso por usuário para créditos adicionais da sua organização. Os limites são sempre aplicados por usuário. Quando você especifica um escopo de equipe ou grupo, o limite é aplicado individualmente a cada usuário dessa equipe ou grupo — ele não estabelece um limite compartilhado para toda a equipe ou grupo.

​

Requisição

service_key · string · obrigatório

Sua chave de serviço com a permissão “Billing Write”

​

Configuração do limite de créditos adicionais (Escolha uma opção)

clear_add_on_credit_cap · boolean

Defina como true para remover o limite atual de créditos adicionais

set_add_on_credit_cap · integer

Defina um novo limite de créditos adicionais (valor inteiro)

É necessário fornecer clear_add_on_credit_cap ou set_add_on_credit_cap, mas não ambos.

​

Configuração do escopo (escolha uma)

team_level · boolean

Defina como true para aplicar o limite por usuário a todos os usuários do Team

group_id · string

Aplique o limite por usuário a todos os usuários de um grupo específico informando o ID do grupo

user_email · string

Aplique a configuração a um usuário específico informando seu endereço de e-mail

Você deve informar um de team_level, group_id ou user_email para definir o escopo.

​

Exemplo de requisição - Definir o limite de crédito adicional por usuário para todos os usuários da equipe

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "set_add_on_credit_cap": 10000,
  "team_level": true
}' \
https://server.codeium.com/api/v1/UsageConfig

​

Exemplo de requisição - Definir limite de crédito adicional por usuário para todos os usuários de um grupo

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "set_add_on_credit_cap": 5000,
  "group_id": "engineering_team"
}' \
https://server.codeium.com/api/v1/UsageConfig

​

Exemplo de requisição - Definir limite de crédito adicional de um usuário

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "set_add_on_credit_cap": 1000,
  "user_email": "[e-mail]"
}' \
https://server.codeium.com/api/v1/UsageConfig

​

Exemplo de Requisição - Remover o Limite de Crédito Adicional

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "clear_add_on_credit_cap": true,
  "team_level": true
}' \
https://server.codeium.com/api/v1/UsageConfig

​

Resposta

O corpo da resposta está vazio. Um código de status 200 indica que a operação foi bem-sucedida.

​

Respostas de erro

Cenários de erro comuns:

• Chave de serviço inválida ou permissões insuficientes
• Os dois parâmetros clear_add_on_credit_cap e set_add_on_credit_cap foram fornecidos
• Nem clear_add_on_credit_cap nem set_add_on_credit_cap foram fornecidos
• Foram fornecidos vários parâmetros de escopo
• Nenhum parâmetro de escopo foi fornecido
• ID do grupo ou e-mail do usuário inválido
• Limite de requisições excedido