Pular para o conteúdo

Projetos, tags e compartilhamento

A biblioteca de arquivos é a fonte confiável dos recursos; projetos, tags e a pesquisa são visualizações que os organizam. Mantenha os IDs de arquivos ou documentos; não use nomes em substituição a identificadores estáveis.

GET /api/v1/projects
POST /api/v1/projects
GET /api/v1/projects/{project_id}
PATCH /api/v1/projects/{project_id}
DELETE /api/v1/projects/{project_id}
POST /api/v1/projects/{project_id}/documents
DELETE /api/v1/projects/{project_id}/documents/{document_id}

Adicionar um documento a um projeto apenas altera sua organização: o arquivo não é copiado e seu proprietário permanece o mesmo.

GET /api/v1/tags
POST /api/v1/tags
DELETE /api/v1/tags/{tag_id}
POST /api/v1/tags/documents/{document_id}
DELETE /api/v1/tags/documents/{document_id}/{tag_id}

O nome da tag é apenas para exibição; a exclusão, o desanexamento e as consultas utilizam o ID da tag.

GET /api/v1/search?q={query}&limit=20

A pesquisa retorna apenas documentos e trabalhos que a conta atual pode ler. A pesquisa é uma operação de leitura e não consome créditos.

GET /api/v1/shares
POST /api/v1/shares
GET /api/v1/shares/{token}
GET /api/v1/shares/{token}/download
DELETE /api/v1/shares/{token}

POST /shares cria um link somente leitura para um resultado de tradução; o corpo contém artifact_id e um expires_in_days opcional (1–365; sem ele, o link não expira). Qualquer pessoa com o link pode fazer o download, portanto mantenha-o fora de logs e parâmetros de análise e exclua-o quando não for mais necessário.

GET /api/v1/workspace/files
GET /api/v1/workspace/entries
GET /api/v1/workspace/apps

Esses endpoints destinam-se à criação de um espaço de trabalho unificado para uma conta OmniDoc. Os clientes devem seguir as entradas e funcionalidades nas respostas, sem construir URLs de aplicativos por conta própria.