Dokumentacja API
Tworzenie przypisania zabezpieczenia
Przypisz regułę do standardowego klucza API, członka konta lub wspólnego budżetu tagu.
Przypisz regułę do standardowego klucza API, członka konta lub wspólnego budżetu tagu.
Punkt końcowy
- Bazowy URL
https://runapi.ai- Wersja API
v1- Uwierzytelnianie
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
02
Treść JSONŻądanie
Wysyłaj wartości wyłącznie w podanej lokalizacji żądania.
Treść JSON4 pola
account_user_idstring
Opcjonalne
Prefiks ID członka konta. Ten cel wymaga uprawnień administratora konta.
api_token_idstring
Opcjonalne
Identyfikator standardowego klucza API z prefiksem. Podaj dokładnie jedno z api_token_id, account_user_id lub tag.
guardrail_idstring
Wymagane
Prefiks ID guardrail.
tagstring
Opcjonalne
Tag key:value uwzględniający wielkość liter dla wspólnego budżetu. Wymaga administratora i dodatniej reguły w trybie block. Podaj dokładnie jeden cel.
03
HTTP 201Odpowiedź sukcesu
POST /api/v1/guardrail_assignments
JSON
{
"account_user_id": null,
"api_token_id": null,
"created_at": "2026-07-27T10:00:00.000Z",
"guardrail_id": "guardrail_123",
"id": "guardrail_assignment_123",
"tag": "dept:ml"
}
04
HTTP 401Odpowiedź błędu (401)
Schemat odpowiedzi
JSON
{
"properties": {
"error": {
"description": "Czytelny dla człowieka komunikat o błędzie.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}
Przykład odpowiedzi
JSON
{
"error": "Authentication required"
}
05
HTTP 403Odpowiedź błędu (403)
Schemat odpowiedzi
JSON
{
"properties": {
"error": {
"description": "Czytelny dla człowieka komunikat o błędzie.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}
Przykład odpowiedzi
JSON
{
"error": "Management API key required"
}
06
HTTP 400Odpowiedź błędu (400)
Schemat odpowiedzi
JSON
{
"oneOf": [
{
"properties": {
"error": {
"description": "Czytelny dla człowieka komunikat o błędzie.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
},
{
"properties": {
"error": {
"description": "Czytelne dla człowieka podsumowanie walidacji.",
"type": "string"
},
"errors": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Komunikaty walidacyjne identyfikowane przez publiczne pole żądania, z tablicą czytelnych dla człowieka ciągów znaków dla każdego pola.",
"type": "object"
}
},
"required": [
"error",
"errors"
],
"type": "object",
"unevaluatedProperties": false
}
]
}
Przykład odpowiedzi
JSON
{
"error": "page must be an integer"
}
07
HTTP 403Odpowiedź błędu (403)
Schemat odpowiedzi
JSON
{
"properties": {
"error": {
"description": "Czytelny dla człowieka komunikat o błędzie.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}
Przykład odpowiedzi
JSON
{
"error": "Forbidden"
}
08
HTTP 404Odpowiedź błędu (404)
Schemat odpowiedzi
JSON
{
"properties": {
"error": {
"description": "Czytelny dla człowieka komunikat o błędzie.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}
Przykład odpowiedzi
JSON
{
"error": "Resource not found"
}
09
HTTP 422Odpowiedź błędu (422)
Schemat odpowiedzi
JSON
{
"properties": {
"error": {
"description": "Czytelne dla człowieka podsumowanie walidacji.",
"type": "string"
},
"errors": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Komunikaty walidacyjne identyfikowane przez publiczne pole żądania, z tablicą czytelnych dla człowieka ciągów znaków dla każdego pola.",
"type": "object"
}
},
"required": [
"error",
"errors"
],
"type": "object",
"unevaluatedProperties": false
}
Przykład odpowiedzi
JSON
{
"error": "Validation failed",
"errors": {
"base": [
"Validation failed"
]
}
}
10
Przykład cURL
CURL
curl -X POST https://runapi.ai/api/v1/guardrail_assignments \
-H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"guardrail_id":"guardrail_123","tag":"dept:ml"}'