Skip to main content
POST
/
v2
/
workspace
/
apikeyconfig
/
get
Get API Key Config
curl --request POST \
  --url https://api.velt.dev/v2/workspace/apikeyconfig/get \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>'
import requests

url = "https://api.velt.dev/v2/workspace/apikeyconfig/get"

headers = {
    "x-velt-api-key": "<x-velt-api-key>",
    "x-velt-auth-token": "<x-velt-auth-token>"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'x-velt-api-key': '<x-velt-api-key>',
    'x-velt-auth-token': '<x-velt-auth-token>'
  }
};

fetch('https://api.velt.dev/v2/workspace/apikeyconfig/get', 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.velt.dev/v2/workspace/apikeyconfig/get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "x-velt-api-key: <x-velt-api-key>",
    "x-velt-auth-token: <x-velt-auth-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.velt.dev/v2/workspace/apikeyconfig/get"

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

	req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
	req.Header.Add("x-velt-auth-token", "<x-velt-auth-token>")

	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.velt.dev/v2/workspace/apikeyconfig/get")
  .header("x-velt-api-key", "<x-velt-api-key>")
  .header("x-velt-auth-token", "<x-velt-auth-token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.velt.dev/v2/workspace/apikeyconfig/get")

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

request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'

response = http.request(request)
puts response.read_body
{
  "result": {
    "status": "success",
    "message": "API key metadata retrieved successfully.",
    "data": {
      "ownerEmail": "owner@example.com",
      "planInfo": {
        "type": "sdk test"
      },
      "defaultDocumentAccessType": "public",
      "isPrivateCommentsEnabled": false,
      "requireJwtToken": false,
      "requireAutoOrgUser": false,
      "aiModelsConfig": {
        "openai": {
          "displayText": "sk-...XyZ"
        }
      }
    }
  }
}
Use this API to retrieve the app configuration for a workspace API key: owner email, plan info, default document access type, the private-comments flag, the JWT / auto-org-user toggles, and the configured AI model keys (masked).
This endpoint uses API-key-level auth: pass x-velt-api-key and x-velt-auth-token as headers. You can obtain these from the Get Auth Tokens endpoint.

​
Endpoint

POST https://api.velt.dev/v2/workspace/apikeyconfig/get

​
Headers

​
x-velt-api-key
string
required
Your API key.
​
x-velt-auth-token
string
required
Your Auth Token.

​
Body

This endpoint does not require a request body.

​
Example Request

{
  "data": {}
}

​
Example Response

​
Success Response

{
  "result": {
    "status": "success",
    "message": "API key metadata retrieved successfully.",
    "data": {
      "ownerEmail": "owner@example.com",
      "planInfo": {
        "type": "sdk test"
      },
      "defaultDocumentAccessType": "public",
      "isPrivateCommentsEnabled": false,
      "requireJwtToken": false,
      "requireAutoOrgUser": false,
      "aiModelsConfig": {
        "openai": {
          "displayText": "sk-...XyZ"
        }
      }
    }
  }
}
aiModelsConfig is a map of provider -> { displayText } and is masked — the raw or encrypted AI model key is never returned. It is absent when no AI keys are configured. defaultDocumentAccessType is one of public, restricted, or organizationPrivate (defaults to public).

​
Failure Response

{
  "error": {
    "status": "PERMISSION_DENIED",
    "message": "Invalid API key."
  }
}

{
  "result": {
    "status": "success",
    "message": "API key metadata retrieved successfully.",
    "data": {
      "ownerEmail": "owner@example.com",
      "planInfo": {
        "type": "sdk test"
      },
      "defaultDocumentAccessType": "public",
      "isPrivateCommentsEnabled": false,
      "requireJwtToken": false,
      "requireAutoOrgUser": false,
      "aiModelsConfig": {
        "openai": {
          "displayText": "sk-...XyZ"
        }
      }
    }
  }
}