Create Api Key

POST /v2/users/api_keys

Create Api Key

cURL

curl --request POST \
  --url https://api.galileo.ai/v2/users/api_keys \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '
{
  "description": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "project_id": "<string>",
  "api_key": "<string>"
}
'

import requests

url = "https://api.galileo.ai/v2/users/api_keys"

payload = {
    "description": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "project_id": "<string>",
    "api_key": "<string>"
}
headers = {
    "Galileo-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Galileo-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    expires_at: '2023-11-07T05:31:56Z',
    project_id: '<string>',
    api_key: '<string>'
  })
};

fetch('https://api.galileo.ai/v2/users/api_keys', 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.galileo.ai/v2/users/api_keys",
  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([
    'description' => '<string>',
    'expires_at' => '2023-11-07T05:31:56Z',
    'project_id' => '<string>',
    'api_key' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Galileo-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.galileo.ai/v2/users/api_keys"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"project_id\": \"<string>\",\n  \"api_key\": \"<string>\"\n}")

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

	req.Header.Add("Galileo-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.galileo.ai/v2/users/api_keys")
  .header("Galileo-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"project_id\": \"<string>\",\n  \"api_key\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galileo.ai/v2/users/api_keys")

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

request = Net::HTTP::Post.new(url)
request["Galileo-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"project_id\": \"<string>\",\n  \"api_key\": \"<string>\"\n}"

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

200

{
  "id": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "truncated": "<string>",
  "api_key": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "last_used": "2023-11-07T05:31:56Z",
  "project_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

ClassicAPIKeyHeaderAPIKeyHeaderOAuth2PasswordBearerHTTPBasic

Galileo-API-Key · string · header · required

Body

application/json

description · string · required

expires_at · string<date-time> | null

Expiry date for the API key

project_id · string<uuid4> | null

project_role · enum<string> | null

Available options: owner, editor, annotator, viewer

api_key · string | null

Optional pre-generated API key value. If not provided, one will be generated automatically. This is used for setups where the same API key needs to exist on multiple clusters.

Response

200

application/json

Successful Response

id · string<uuid4> · required

description · string · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

created_by · string<uuid4> · required

truncated · string · required

api_key · string · required

expires_at · string<date-time> | null

last_used · string<date-time> | null

project_id · string<uuid4> | null

project_role · enum<string> | null

Available options: owner, editor, annotator, viewer