Workspace-Einstellungen ändern

Update USD workspace settings

curl --request PATCH \
  --url https://api.langdock.com/billing/v1/bring-your-own-keys/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "usageRequestsEnabled": true,
  "workspaceUsageLimit": {
    "type": "limited",
    "amount": 1
  },
  "monthlyBudgetPerPlan": {
    "standard": {
      "type": "limited",
      "amount": 1
    },
    "power_user": {
      "type": "limited",
      "amount": 1
    }
  },
  "sessionLimitsEnabled": true,
  "agentLimitBehavior": {
    "fallbackModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

import requests

url = "https://api.langdock.com/billing/v1/bring-your-own-keys/settings"

payload = {
    "usageRequestsEnabled": True,
    "workspaceUsageLimit": {
        "type": "limited",
        "amount": 1
    },
    "monthlyBudgetPerPlan": {
        "standard": {
            "type": "limited",
            "amount": 1
        },
        "power_user": {
            "type": "limited",
            "amount": 1
        }
    },
    "sessionLimitsEnabled": True,
    "agentLimitBehavior": { "fallbackModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    usageRequestsEnabled: true,
    workspaceUsageLimit: {type: 'limited', amount: 1},
    monthlyBudgetPerPlan: {
      standard: {type: 'limited', amount: 1},
      power_user: {type: 'limited', amount: 1}
    },
    sessionLimitsEnabled: true,
    agentLimitBehavior: {fallbackModelId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}
  })
};

fetch('https://api.langdock.com/billing/v1/bring-your-own-keys/settings', 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.langdock.com/billing/v1/bring-your-own-keys/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'usageRequestsEnabled' => true,
    'workspaceUsageLimit' => [
        'type' => 'limited',
        'amount' => 1
    ],
    'monthlyBudgetPerPlan' => [
        'standard' => [
                'type' => 'limited',
                'amount' => 1
        ],
        'power_user' => [
                'type' => 'limited',
                'amount' => 1
        ]
    ],
    'sessionLimitsEnabled' => true,
    'agentLimitBehavior' => [
        'fallbackModelId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  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;
}

package main

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

func main() {

	url := "https://api.langdock.com/billing/v1/bring-your-own-keys/settings"

	payload := strings.NewReader("{\n  \"usageRequestsEnabled\": true,\n  \"workspaceUsageLimit\": {\n    \"type\": \"limited\",\n    \"amount\": 1\n  },\n  \"monthlyBudgetPerPlan\": {\n    \"standard\": {\n      \"type\": \"limited\",\n      \"amount\": 1\n    },\n    \"power_user\": {\n      \"type\": \"limited\",\n      \"amount\": 1\n    }\n  },\n  \"sessionLimitsEnabled\": true,\n  \"agentLimitBehavior\": {\n    \"fallbackModelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}")

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

	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.patch("https://api.langdock.com/billing/v1/bring-your-own-keys/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"usageRequestsEnabled\": true,\n  \"workspaceUsageLimit\": {\n    \"type\": \"limited\",\n    \"amount\": 1\n  },\n  \"monthlyBudgetPerPlan\": {\n    \"standard\": {\n      \"type\": \"limited\",\n      \"amount\": 1\n    },\n    \"power_user\": {\n      \"type\": \"limited\",\n      \"amount\": 1\n    }\n  },\n  \"sessionLimitsEnabled\": true,\n  \"agentLimitBehavior\": {\n    \"fallbackModelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.langdock.com/billing/v1/bring-your-own-keys/settings")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"usageRequestsEnabled\": true,\n  \"workspaceUsageLimit\": {\n    \"type\": \"limited\",\n    \"amount\": 1\n  },\n  \"monthlyBudgetPerPlan\": {\n    \"standard\": {\n      \"type\": \"limited\",\n      \"amount\": 1\n    },\n    \"power_user\": {\n      \"type\": \"limited\",\n      \"amount\": 1\n    }\n  },\n  \"sessionLimitsEnabled\": true,\n  \"agentLimitBehavior\": {\n    \"fallbackModelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}"

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

{
  "currency": "USD",
  "usageRequestsEnabled": true,
  "workspaceUsageLimit": {
    "type": "limited",
    "amount": 1
  },
  "monthlyBudgetPerPlan": {
    "standard": {
      "type": "limited",
      "amount": 1
    },
    "power_user": {
      "type": "limited",
      "amount": 1
    }
  },
  "sessionLimitsEnabled": true,
  "agentLimitBehavior": {
    "forced": "switch_model",
    "fallbackModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "weeklyBudgetPerPlan": {
    "standard": {
      "type": "limited",
      "amount": 1
    },
    "power_user": {
      "type": "limited",
      "amount": 1
    }
  },
  "sessionBudgetPerPlan": {
    "standard": {
      "type": "limited",
      "amount": 1
    },
    "power_user": {
      "type": "limited",
      "amount": 1
    }
  },
  "usagePeriod": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "usagePeriodSpend": 1
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "code": "BILLING_MODE_MISMATCH",
  "details": {
    "mode": "ai-models-included"
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

PATCH

billing

bring-your-own-keys

settings

Update USD workspace settings

curl --request PATCH \
  --url https://api.langdock.com/billing/v1/bring-your-own-keys/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "usageRequestsEnabled": true,
  "workspaceUsageLimit": {
    "type": "limited",
    "amount": 1
  },
  "monthlyBudgetPerPlan": {
    "standard": {
      "type": "limited",
      "amount": 1
    },
    "power_user": {
      "type": "limited",
      "amount": 1
    }
  },
  "sessionLimitsEnabled": true,
  "agentLimitBehavior": {
    "fallbackModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

import requests

url = "https://api.langdock.com/billing/v1/bring-your-own-keys/settings"

payload = {
    "usageRequestsEnabled": True,
    "workspaceUsageLimit": {
        "type": "limited",
        "amount": 1
    },
    "monthlyBudgetPerPlan": {
        "standard": {
            "type": "limited",
            "amount": 1
        },
        "power_user": {
            "type": "limited",
            "amount": 1
        }
    },
    "sessionLimitsEnabled": True,
    "agentLimitBehavior": { "fallbackModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    usageRequestsEnabled: true,
    workspaceUsageLimit: {type: 'limited', amount: 1},
    monthlyBudgetPerPlan: {
      standard: {type: 'limited', amount: 1},
      power_user: {type: 'limited', amount: 1}
    },
    sessionLimitsEnabled: true,
    agentLimitBehavior: {fallbackModelId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}
  })
};

fetch('https://api.langdock.com/billing/v1/bring-your-own-keys/settings', 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.langdock.com/billing/v1/bring-your-own-keys/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'usageRequestsEnabled' => true,
    'workspaceUsageLimit' => [
        'type' => 'limited',
        'amount' => 1
    ],
    'monthlyBudgetPerPlan' => [
        'standard' => [
                'type' => 'limited',
                'amount' => 1
        ],
        'power_user' => [
                'type' => 'limited',
                'amount' => 1
        ]
    ],
    'sessionLimitsEnabled' => true,
    'agentLimitBehavior' => [
        'fallbackModelId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  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;
}

package main

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

func main() {

	url := "https://api.langdock.com/billing/v1/bring-your-own-keys/settings"

	payload := strings.NewReader("{\n  \"usageRequestsEnabled\": true,\n  \"workspaceUsageLimit\": {\n    \"type\": \"limited\",\n    \"amount\": 1\n  },\n  \"monthlyBudgetPerPlan\": {\n    \"standard\": {\n      \"type\": \"limited\",\n      \"amount\": 1\n    },\n    \"power_user\": {\n      \"type\": \"limited\",\n      \"amount\": 1\n    }\n  },\n  \"sessionLimitsEnabled\": true,\n  \"agentLimitBehavior\": {\n    \"fallbackModelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}")

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

	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.patch("https://api.langdock.com/billing/v1/bring-your-own-keys/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"usageRequestsEnabled\": true,\n  \"workspaceUsageLimit\": {\n    \"type\": \"limited\",\n    \"amount\": 1\n  },\n  \"monthlyBudgetPerPlan\": {\n    \"standard\": {\n      \"type\": \"limited\",\n      \"amount\": 1\n    },\n    \"power_user\": {\n      \"type\": \"limited\",\n      \"amount\": 1\n    }\n  },\n  \"sessionLimitsEnabled\": true,\n  \"agentLimitBehavior\": {\n    \"fallbackModelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.langdock.com/billing/v1/bring-your-own-keys/settings")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"usageRequestsEnabled\": true,\n  \"workspaceUsageLimit\": {\n    \"type\": \"limited\",\n    \"amount\": 1\n  },\n  \"monthlyBudgetPerPlan\": {\n    \"standard\": {\n      \"type\": \"limited\",\n      \"amount\": 1\n    },\n    \"power_user\": {\n      \"type\": \"limited\",\n      \"amount\": 1\n    }\n  },\n  \"sessionLimitsEnabled\": true,\n  \"agentLimitBehavior\": {\n    \"fallbackModelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}"

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

{
  "currency": "USD",
  "usageRequestsEnabled": true,
  "workspaceUsageLimit": {
    "type": "limited",
    "amount": 1
  },
  "monthlyBudgetPerPlan": {
    "standard": {
      "type": "limited",
      "amount": 1
    },
    "power_user": {
      "type": "limited",
      "amount": 1
    }
  },
  "sessionLimitsEnabled": true,
  "agentLimitBehavior": {
    "forced": "switch_model",
    "fallbackModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "weeklyBudgetPerPlan": {
    "standard": {
      "type": "limited",
      "amount": 1
    },
    "power_user": {
      "type": "limited",
      "amount": 1
    }
  },
  "sessionBudgetPerPlan": {
    "standard": {
      "type": "limited",
      "amount": 1
    },
    "power_user": {
      "type": "limited",
      "amount": 1
    }
  },
  "usagePeriod": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "usagePeriodSpend": 1
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "code": "BILLING_MODE_MISMATCH",
  "details": {
    "mode": "ai-models-included"
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

Lies und ändere die Workspace-Limits und Planbudgets für den Modus bring-your-own-keys. Beträge sind US-Dollar. Der Aufruf läuft über den BILLING_API Scope des Workspace-API-Schlüssels. Schreibzugriffe laufen als der Service Account, dem der Schlüssel gehört.

Basis-URL

https://api.langdock.com/billing/v1/bring-your-own-keys/settings

Dedicated DeploymentsErsetze api.langdock.com durch <your-deployment-url>/api/public in allen Anfragen.

Voraussetzungen

API-Schlüssel mit dem Scope BILLING_API
Der Besitzer ist ein Service Account, der nicht gelöscht ist und eine aktive Admin-Mitgliedschaft hat

Einstellungen ändern

PATCH akzeptiert usageRequestsEnabled, workspaceUsageLimit, monthlyBudgetPerPlan, sessionLimitsEnabled und agentLimitBehavior. Schick mindestens eines davon. Ein Plan, den du in monthlyBudgetPerPlan weglässt, behält sein Budget. Verschachtelte Felder, die du in agentLimitBehavior weglässt, bleiben.

curl -X PATCH https://api.langdock.com/billing/v1/bring-your-own-keys/settings \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"monthlyBudgetPerPlan":{"power_user":{"type":"limited","amount":120}}}'

Die Antwort entspricht GET, mit usagePeriodSpend auf null. Lies die Einstellungen erneut, um die Ausgaben zu bekommen. Ein begrenztes workspaceUsageLimit muss größer als null sein. Ein begrenztes Planbudget darf null sein.

Langdock blockiert bewusst Browser-basierte Anfragen, um deinen API-Schlüssel zu schützen und die Sicherheit deiner Anwendungen zu gewährleisten. Weitere Informationen findest du in unserem Guide zu Best Practices für API-Schlüssel.

Autorisierungen

Authorization

string

header

erforderlich

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Body

application/json

usageRequestsEnabled

boolean

workspaceUsageLimit

object

Option 1
Option 2

Show child attributes

monthlyBudgetPerPlan

object

Omitted plans keep their current values.

Show child attributes

sessionLimitsEnabled

boolean

agentLimitBehavior

object

Omitted fields keep their current values. The resulting switch_model configuration must have a valid fallback model.

Show child attributes

Antwort

Updated resource. Spending is null; GET retrieves spending.

USD included and extra chat/agent usage; excludes workflow, API, and backbone-model usage. Weekly budgets are monthly / 4; session budgets are weekly / 3 and null when disabled. PATCH returns null spending; GET retrieves spending.

currency

enum<string>

erforderlich

Verfügbare Optionen:

USD

usageRequestsEnabled

boolean

erforderlich

workspaceUsageLimit

object

erforderlich

Option 1
Option 2

Show child attributes

monthlyBudgetPerPlan

object

erforderlich

Show child attributes

sessionLimitsEnabled

boolean

erforderlich

agentLimitBehavior

object

erforderlich

Forcing switch_model requires a valid fallback model. null forced uses each agent setting. fallbackModelId is the configured override; null uses the workspace backbone fallback.

Show child attributes

weeklyBudgetPerPlan

object

erforderlich

Show child attributes

sessionBudgetPerPlan

object | null

erforderlich

Show child attributes

usagePeriod

object

erforderlich

Show child attributes

usagePeriodSpend

number | null

erforderlich

Erforderlicher Bereich: x >= 0

Überblick

Completion API

Embedding API

Agents API

Integrations API

Skills API

Knowledge Folder API

Prompt Library API

Usage Export API

Workflow API

Scheduled Tasks API

User Management API

Billing API

Audit Logs API

Compliance API

Workspace-Einstellungen ändern

Basis-URL

Voraussetzungen

Einstellungen ändern

Autorisierungen

Body

Antwort

​Basis-URL

​Voraussetzungen

​Einstellungen ändern

Autorisierungen

Body

Antwort

Basis-URL

Voraussetzungen

Einstellungen ändern