Create inference API key

This endpoint creates a new API key for everywhere inference. It returs api key’s actual secret only once after creation.

POST /cloud/v3/inference/{project_id}/api_keys

Create inference API key

cURL

curl --request POST \
  --url https://api.gcore.com/cloud/v3/inference/{project_id}/api_keys \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-api-key",
  "description": "This key is used for accessing the inference service.",
  "expires_at": "2024-10-01T12:00:00Z"
}
'

import requests

url = "https://api.gcore.com/cloud/v3/inference/{project_id}/api_keys"

payload = {
    "name": "my-api-key",
    "description": "This key is used for accessing the inference service.",
    "expires_at": "2024-10-01T12:00:00Z"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'my-api-key',
    description: 'This key is used for accessing the inference service.',
    expires_at: '2024-10-01T12:00:00Z'
  })
};

fetch('https://api.gcore.com/cloud/v3/inference/{project_id}/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.gcore.com/cloud/v3/inference/{project_id}/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([
    'name' => 'my-api-key',
    'description' => 'This key is used for accessing the inference service.',
    'expires_at' => '2024-10-01T12:00:00Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.gcore.com/cloud/v3/inference/{project_id}/api_keys"

	payload := strings.NewReader("{\n  \"name\": \"my-api-key\",\n  \"description\": \"This key is used for accessing the inference service.\",\n  \"expires_at\": \"2024-10-01T12:00:00Z\"\n}")

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

	req.Header.Add("Authorization", "<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.gcore.com/cloud/v3/inference/{project_id}/api_keys")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"my-api-key\",\n  \"description\": \"This key is used for accessing the inference service.\",\n  \"expires_at\": \"2024-10-01T12:00:00Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v3/inference/{project_id}/api_keys")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"my-api-key\",\n  \"description\": \"This key is used for accessing the inference service.\",\n  \"expires_at\": \"2024-10-01T12:00:00Z\"\n}"

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

200

{
  "created_at": "2023-10-01T12:00:00Z",
  "deployment_names": [
    "inference-1",
    "inference-2"
  ],
  "description": "This key is used for accessing the inference service.",
  "expires_at": "2024-10-01T12:00:00Z",
  "name": "my-api-key",
  "secret": "qLyjWDarjtT1zdp7dc"
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id · integer · required

Project ID

Example:

1

Body

application/json

name · string · required

Name of the API Key.

Required string length: 4 - 63

Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

Example:

"my-api-key"

description · string

Description of the API Key.

Maximum string length: 300

Example:

"This key is used for accessing the inference service."

expires_at · string

Expiration date of the API Key in ISO 8601 format.

Example:

"2024-10-01T12:00:00Z"

Response

200 - application/json

OK

created_at · string · required

Timestamp when the API Key was created.

Example:

"2023-10-01T12:00:00Z"

deployment_names · string[] · required

List of inference deployment names to which this API Key has been attached.

Example:

["inference-1", "inference-2"]

description · string | null · required

Description of the API Key.

Example:

"This key is used for accessing the inference service."

expires_at · string | null · required

Timestamp when the API Key will expire.

Example:

"2024-10-01T12:00:00Z"

name · string · required

API Key name.

Example:

"my-api-key"

secret · string · required

The actual API Key secret.

Example:

"qLyjWDarjtT1zdp7dc"