Create a ModelCredential
curl --request POST \
--url https://api.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-version: <checkfu-version>' \
--data '
{
"key": "<string>",
"provider_key": "<string>",
"api_key": "<string>",
"display_name": "<string>",
"base_url": "<string>",
"custody_policy": "workspace_vault"
}
'import requests
url = "https://api.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials"
payload = {
"key": "<string>",
"provider_key": "<string>",
"api_key": "<string>",
"display_name": "<string>",
"base_url": "<string>",
"custody_policy": "workspace_vault"
}
headers = {
"checkfu-version": "<checkfu-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'checkfu-version': '<checkfu-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
key: '<string>',
provider_key: '<string>',
api_key: '<string>',
display_name: '<string>',
base_url: '<string>',
custody_policy: 'workspace_vault'
})
};
fetch('https://api.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials', 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.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials",
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([
'key' => '<string>',
'provider_key' => '<string>',
'api_key' => '<string>',
'display_name' => '<string>',
'base_url' => '<string>',
'custody_policy' => 'workspace_vault'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"checkfu-version: <checkfu-version>"
],
]);
$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.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"provider_key\": \"<string>\",\n \"api_key\": \"<string>\",\n \"display_name\": \"<string>\",\n \"base_url\": \"<string>\",\n \"custody_policy\": \"workspace_vault\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("checkfu-version", "<checkfu-version>")
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://api.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials")
.header("checkfu-version", "<checkfu-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"provider_key\": \"<string>\",\n \"api_key\": \"<string>\",\n \"display_name\": \"<string>\",\n \"base_url\": \"<string>\",\n \"custody_policy\": \"workspace_vault\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"<string>\",\n \"provider_key\": \"<string>\",\n \"api_key\": \"<string>\",\n \"display_name\": \"<string>\",\n \"base_url\": \"<string>\",\n \"custody_policy\": \"workspace_vault\"\n}"
response = http.request(request)
puts response.read_body{
"credential": {
"id": "<string>",
"workspace_id": "<string>",
"key": "<string>",
"display_name": "<string>",
"provider_key": "<string>",
"base_url": "<string>",
"custody_policy": "workspace_vault",
"status": "active",
"health_status": "unknown",
"active_generation_number": 1,
"resource_version": 1,
"created_at": "<string>",
"updated_at": "<string>",
"revoked_at": "<string>"
},
"generation": {
"id": "<string>",
"model_credential_id": "<string>",
"generation_number": 1,
"status": "active",
"configured_at": "<string>",
"last_verified_at": "<string>",
"rejected_at": "<string>",
"revoked_at": "<string>"
}
}{
"error": {
"type": "validation.malformed",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-malformed"
}
}{
"error": {
"type": "auth.invalid_key",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
}
}{
"error": {
"type": "auth.disabled_tenancy",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
}
}{
"error": {
"type": "validation.not_found",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-not-found"
}
}{
"error": {
"type": "validation.conflict",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-conflict"
}
}{
"error": {
"type": "budget.exceeded",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
}
}{
"error": {
"type": "runtime.internal",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#runtime-internal"
}
}Create a ModelCredential
Creates a stable provider credential and its first immutable generation. Secret input is write-only and never returned.
Checkfu support posture: alpha; hosted. Required evidence journey: runtime-design. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.
POST
/
v1
/
organizations
/
workspaces
/
{workspace_id}
/
model-credentials
Create a ModelCredential
curl --request POST \
--url https://api.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-version: <checkfu-version>' \
--data '
{
"key": "<string>",
"provider_key": "<string>",
"api_key": "<string>",
"display_name": "<string>",
"base_url": "<string>",
"custody_policy": "workspace_vault"
}
'import requests
url = "https://api.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials"
payload = {
"key": "<string>",
"provider_key": "<string>",
"api_key": "<string>",
"display_name": "<string>",
"base_url": "<string>",
"custody_policy": "workspace_vault"
}
headers = {
"checkfu-version": "<checkfu-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'checkfu-version': '<checkfu-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
key: '<string>',
provider_key: '<string>',
api_key: '<string>',
display_name: '<string>',
base_url: '<string>',
custody_policy: 'workspace_vault'
})
};
fetch('https://api.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials', 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.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials",
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([
'key' => '<string>',
'provider_key' => '<string>',
'api_key' => '<string>',
'display_name' => '<string>',
'base_url' => '<string>',
'custody_policy' => 'workspace_vault'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"checkfu-version: <checkfu-version>"
],
]);
$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.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"provider_key\": \"<string>\",\n \"api_key\": \"<string>\",\n \"display_name\": \"<string>\",\n \"base_url\": \"<string>\",\n \"custody_policy\": \"workspace_vault\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("checkfu-version", "<checkfu-version>")
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://api.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials")
.header("checkfu-version", "<checkfu-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"provider_key\": \"<string>\",\n \"api_key\": \"<string>\",\n \"display_name\": \"<string>\",\n \"base_url\": \"<string>\",\n \"custody_policy\": \"workspace_vault\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/organizations/workspaces/{workspace_id}/model-credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"<string>\",\n \"provider_key\": \"<string>\",\n \"api_key\": \"<string>\",\n \"display_name\": \"<string>\",\n \"base_url\": \"<string>\",\n \"custody_policy\": \"workspace_vault\"\n}"
response = http.request(request)
puts response.read_body{
"credential": {
"id": "<string>",
"workspace_id": "<string>",
"key": "<string>",
"display_name": "<string>",
"provider_key": "<string>",
"base_url": "<string>",
"custody_policy": "workspace_vault",
"status": "active",
"health_status": "unknown",
"active_generation_number": 1,
"resource_version": 1,
"created_at": "<string>",
"updated_at": "<string>",
"revoked_at": "<string>"
},
"generation": {
"id": "<string>",
"model_credential_id": "<string>",
"generation_number": 1,
"status": "active",
"configured_at": "<string>",
"last_verified_at": "<string>",
"rejected_at": "<string>",
"revoked_at": "<string>"
}
}{
"error": {
"type": "validation.malformed",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-malformed"
}
}{
"error": {
"type": "auth.invalid_key",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
}
}{
"error": {
"type": "auth.disabled_tenancy",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
}
}{
"error": {
"type": "validation.not_found",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-not-found"
}
}{
"error": {
"type": "validation.conflict",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-conflict"
}
}{
"error": {
"type": "budget.exceeded",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
}
}{
"error": {
"type": "runtime.internal",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#runtime-internal"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Available options:
2026-08-27 Maximum string length:
255Path Parameters
Pattern:
^wrkspc_[0-9a-f]{32}$Body
application/json
Pattern:
^[a-z0-9](?:[a-z0-9._-]{0,93})$Pattern:
^[a-z0-9](?:[a-z0-9._-]{0,93})$Required string length:
1 - 16384Required string length:
1 - 255Maximum string length:
2048Available options:
workspace_vault