Obter Documento

Obter o detalhe do documento, o estado de processamento e a procedência do conector.

GET/api/v2/knowledge/{knowledgeBaseId}/documents/{documentId}
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

documentId*string

Identificador único do documento de knowledge base.

Tamanho1 <= length
knowledgeBaseId*string

Identificador único da knowledge base.

Tamanho1 <= length

Parâmetros de query

workspaceId*string

Workspace dono da knowledge base.

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/knowledge/string/documents/string?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "id": "b2d4f8a0-1c3e-4a5b-9d7c-2e6f0a8b4c12",
    "knowledgeBaseId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "filename": "getting-started.pdf",
    "fileSize": 248913,
    "mimeType": "application/pdf",
    "processingStatus": "completed",
    "chunkCount": 24,
    "tokenCount": 8123,
    "characterCount": 41205,
    "enabled": true,
    "createdAt": "2025-06-18T16:45:00Z",
    "tags": {
      "category": "billing",
      "priority": 2
    },
    "processingError": "string",
    "processingStartedAt": "2025-06-18T16:45:05Z",
    "processingCompletedAt": "2025-06-18T16:45:42Z",
    "connectorId": "string",
    "connectorType": "string",
    "sourceUrl": "string"
  }
}
{
  "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"
  }
}