Ativar ou Desativar Compartilhamento do File

Criar ou atualizar parcialmente um compartilhamento público tokenizado no servidor. Apenas isActive é obrigatório; cada um dos outros campos descreve o que a ativação de um modo faz com ele. Ativar qualquer modo diferente de public em um file que nunca foi compartilhado exige enviar a credencial correspondente na mesma requisição. Uma API key de workspace é rejeitada com 403; use uma API key pessoal.

PATCH/api/v2/files/{fileId}/share
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

fileId*string

Identificador do file.

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

Corpo da requisição

application/json

Estado desejado do compartilhamento público e política de acesso.

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

curl -X PATCH "https://agent-studio.seeyu.ai/api/v2/files/string/share" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "isActive": true,    "authType": "public"  }'
{
  "data": {
    "id": "shr_8Hf3kL9wQ2mNpXr6Tz1Vb",
    "token": "share-token-example",
    "url": "https://agent-studio.seeyu.ai/f/share-token-example",
    "isActive": true,
    "resourceType": "file",
    "resourceId": "wf_V1StGXR8z5jdHi6BmyT91",
    "authType": "public",
    "hasPassword": false,
    "allowedEmails": []
  }
}
{
  "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"
  }
}