Listar Segredos

Listar os metadados dos segredos do workspace e dos segredos pessoais de quem faz a chamada, com paginação por cursor opaco. Apenas nomes, escopo, papel e timestamps são retornados; os valores dos segredos nunca são retornados. Uma API key de workspace é rejeitada com 403; use uma API key pessoal.

GET/api/v2/secrets

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 query

workspaceId*string

Workspace cujos metadados de segredo devem ser listados.

Tamanho1 <= length <= 128
scope?string

Restringir os resultados a um único escopo de propriedade.

Valor em"workspace" | "personal"
search?string

Correspondência de substring com o nome do segredo, sem diferenciar maiúsculas de minúsculas.

Tamanho1 <= length <= 200
sortBy?string

Campo usado para ordenar o resultado. A ordenação por name diferencia maiúsculas de minúsculas e segue a collation do armazenamento, então não conte com uma ordem que ignore maiúsculas e minúsculas.

Padrão"name"
Valor em"name" | "createdAt" | "updatedAt"
sortOrder?string

Direção da ordenação.

Padrão"asc"
Valor em"asc" | "desc"
limit?integer

Máximo de segredos a retornar por página. Deve ser um número inteiro de 1 a 100. O padrão é 50.

Padrão50
Intervalo1 <= value <= 100
cursor?string

Cursor opaco da página anterior. Devolva-o com a mesma ordenação e os mesmos filtros; apenas limit pode mudar. Altere qualquer outra coisa e a paginação precisa recomeçar sem cursor.

Tamanho1 <= length

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://agent-studio.seeyu.ai/api/v2/secrets?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "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"
    },
    {
      "name": "STAGING_BASE_URL",
      "scope": "workspace",
      "description": "Staging environment base URL.",
      "unredacted": true,
      "role": "member",
      "createdAt": "2026-06-03T11:30:00.000Z",
      "updatedAt": "2026-06-21T08:45:09.000Z",
      "value": "https://staging.example.com"
    }
  ],
  "nextCursor": null
}
{
  "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": "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"
  }
}
DELETEExcluir SegredoPUTDefinir Segredo