Create an Org API Key - Barndoor Documentation

Create an org API key

cURL

curl --request POST \
  --url https://app.barndoor.ai/api/llm-gateway/admin/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_email": "<string>",
  "scopes": [
    "<string>"
  ],
  "group_name": "<string>", 
  "expires_at": "2023-11-07T05:31:56Z"
}
'

Python

import requests

url = "https://app.barndoor.ai/api/llm-gateway/admin/api-keys"

payload = {
    "name": "<string>",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_email": "<string>",
    "scopes": ["<string>"],
    "group_name": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    user_email: '<string>',
    scopes: ['<string>'],
    group_name: '<string>',
    expires_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://app.barndoor.ai/api/llm-gateway/admin/api-keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.barndoor.ai/api/llm-gateway/admin/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' => '<string>',
    'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'user_email' => '<string>',
    'scopes' => [
        '<string>'
    ],
    'group_name' => '<string>',
    'expires_at' => '2023-11-07T05:31:56Z'
  ]),
  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;
}
?>

Response

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "key_prefix": "<string>",
  "key": "bd-abcd1234ef56...",
  "scopes": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "group_name": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

Error Response

{
  "error": "BadRequest",
  "message": "request_timeout_secs must be between 1 and 3600"
}

Creates an organization-managed bd-… API key for the LLM Gateway runtime.

Example: a CI service-account key

curl -X POST https://app.barndoor.ai/api/llm-gateway/admin/api-keys \
  -H "Authorization: Bearer $BARNDOOR_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "GitHub Actions runner",
    "group_name": "ci",
    "expires_at": "2026-12-31T23:59:59Z"
  }'

Authorizations

Authorization string header required

JWT obtained through Barndoor's authentication flow. Pass the token verbatim in Authorization: Bearer <token>. Use the Barndoor SDK's loginInteractive() helper to obtain a token in scripts and notebooks.

Body

Response