Saltearse al contenido

Proyectos, etiquetas y uso compartido

La biblioteca de archivos es la fuente de verdad para los recursos; los proyectos, las etiquetas y la búsqueda son vistas que los organizan. Mantenga los identificadores de archivo o documento; no utilice nombres en lugar de identificadores estables.

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}

Agregar un documento a un proyecto solo modifica su organización: el archivo no se copia y su propietario no cambia.

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}

El nombre de la etiqueta es solo para visualización; al eliminar, desvincular y consultar se utiliza el ID de la etiqueta.

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

La búsqueda devuelve únicamente los documentos y trabajos que la cuenta actual puede leer. La búsqueda es una operación de lectura y no consume 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 crea un enlace de solo lectura al resultado de la traducción; el cuerpo contiene artifact_id y un expires_in_days opcional (de 1 a 365; sin él, el enlace no caduca). Cualquier persona que posea el enlace puede descargarlo, así que manténgalo fuera de los registros y de los parámetros de análisis, y elimínelo cuando ya no sea necesario.

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

Estos puntos finales están diseñados para crear un espacio de trabajo unificado para una cuenta OmniDoc. Los clientes deben seguir las entradas y capacidades incluidas en las respuestas y no generar direcciones URL de aplicaciones por su cuenta.