Skip to main content
GET
/
api
/
openapi
/
v1
/
documents
Listar Documentos
curl --request GET \
  --url https://app.converza.io/api/openapi/v1/documents \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "contrato.pdf",
      "type": "pdf",
      "size": 1024000,
      "openai_id": "file-abc123",
      "file_url": "550e8400-e29b-41d4-a716-446655440000/file-abc123.pdf",
      "chars": 5000,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}

Authorizations

Authorization
string
header
required

Token JWT obtido do endpoint /api/openapi/auth/token

Query Parameters

page
integer
default:1

Número da página (começa em 1)

Required range: x >= 1
Example:

1

limit
integer
default:20

Número de itens por página

Required range: 1 <= x <= 100
Example:

20

team_id
string<uuid>

Filtrar por ID da equipe

name
string

Filtrar por nome do documento (correspondência parcial)

type
string

Filtrar por tipo de documento (pdf, txt, docx, doc)

Response

200 - application/json

Documentos recuperados com sucesso

success
boolean
Example:

true

data
object[]
meta
object