Definir Segredo

Criar ou substituir um segredo do workspace ou um segredo pessoal de quem faz a chamada. O valor é criptografado em repouso, é somente escrita e nunca é incluído na resposta. Uma API key de workspace é rejeitada com 403; use uma API key pessoal.

PUT/api/v2/secrets/{name}

Authorization

X-API-Key<token>

Sua API key do Studio, pessoal ou com escopo de workspace. Gere uma em Settings e depois API Keys. As operações que rejeitam API keys de workspace dizem isso na própria descrição.

Em: header

Parâmetros de path

name*string

Secret to create or replace.

Corresponde a^[A-Za-z0-9_]+$
Tamanho1 <= length <= 255

Corpo da requisição

application/json

Ownership scope and write-only value for the secret. A workspace secret may instead send description or unredacted alone, without a value.

Definições TypeScript

Use o tipo request body no TypeScript.

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://agent-studio.seeyu.ai/api/v2/secrets/string" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "scope": "workspace",    "value": "YOUR_SECRET_VALUE"  }'
{
  "data": {
    "name": "STRIPE_API_KEY",
    "scope": "workspace",
    "description": "Production billing key — rotate quarterly.",
    "unredacted": false,
    "role": "admin",
    "createdAt": "2026-06-01T09:14:00.000Z",
    "updatedAt": "2026-06-20T14:02:11.000Z"
  }
}
{
  "data": {
    "name": "STRIPE_API_KEY",
    "scope": "workspace",
    "description": "Production billing key — rotate quarterly.",
    "unredacted": false,
    "role": "admin",
    "createdAt": "2026-06-01T09:14:00.000Z",
    "updatedAt": "2026-06-20T14:02:11.000Z"
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Request body must be sent as application/json"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}
GETListar SegredosGETObter Status de Faturamento