LiveDoc API

LiveDoc API помогает дать Agent reusable workspace knowledge base: создать LiveDoc, загрузить files или URLs, управлять resources, выполнять semantic retrieval, вести README, tasks и task records в одном workspace.

Аутентификация

Все requests требуют API key в Authorization header:

Authorization: Bearer YOUR_API_KEY

Основной процесс

1. Создайте LiveDoc для project, client, research topic или team knowledge.
2. Добавьте resources: document, uploaded file, URL, PPT/page assets или office materials.
3. Используйте retrieve, route и content endpoints, чтобы Agent получал нужный context.
4. Используйте README, tasks и task records для project context и collaboration history.

Управление LiveDoc

1. Create LiveDoc

POST https://openapi.felo.ai/v2/livedocs

curl -X POST 'https://openapi.felo.ai/v2/livedocs' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"AI Research Notes","description":"Collection of AI research materials"}'

Successful response returns a LiveDoc object with short_id, name, description, icon, created_at, modified_at, and is_shared.

2. List LiveDocs

GET https://openapi.felo.ai/v2/livedocs

Returns a paginated list with total, page, size, and items. Each item may include readme.

3. Update LiveDoc

PUT https://openapi.felo.ai/v2/livedocs/{short_id}

Use the body to update name and description. The endpoint returns the updated LiveDoc object.

4. Delete LiveDoc

DELETE https://openapi.felo.ai/v2/livedocs/{short_id}

Deletes the selected LiveDoc. A successful response returns { "deleted": true }.

Управление ресурсами

5. Список ресурсов

GET https://openapi.felo.ai/v2/livedocs/{short_id}/resources

A resource object usually includes resource_id, title, type, content, metadata, created_at, and modified_at.

6. Получить один ресурс

GET https://openapi.felo.ai/v2/livedocs/{short_id}/resources/{resource_id}

Returns metadata and content summary for one resource.

7. Обновить ресурс

PUT https://openapi.felo.ai/v2/livedocs/{short_id}/resources/{resource_id}

Updates title, description, metadata, and other resource details.

8. Обновить содержимое ресурса

PUT https://openapi.felo.ai/v2/livedocs/{short_id}/resources/{resource_id}/content

Replaces the resource body. Useful when an Agent writes notes, report drafts, or structured content back to LiveDoc.

9. Создать документ-ресурс

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/doc

10. Загрузить файл как документ

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/upload-doc

Upload a file with multipart/form-data and save parsed content as a document resource. Suitable for PDF, DOCX, TXT, Markdown, and similar files.

11. Загрузить файловый ресурс

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/upload

Upload a source file with multipart/form-data and keep it for later download or retrieval.

12. Добавить URL resources

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/urls

Send a URL list. Items can be plain strings or objects with url, title, description, and metadata. Useful for importing web pages, articles, competitor research, and public docs into an Agent workspace.

13. Удалить ресурс

DELETE https://openapi.felo.ai/v2/livedocs/{short_id}/resources/{resource_id}

Deletes a resource. A successful response returns { "deleted": true }.

Retrieval и routing

14. Retrieve (semantic search)

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/retrieve

Returns resource snippets most relevant to the query. Use it for RAG, research summaries, PPT generation, or report writing.

15. Route resources

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/route

Chooses which resources should be used for a query. Useful when an Agent needs to select context from multiple sources.

16. Download Resource Source File

GET https://openapi.felo.ai/v2/livedocs/{short_id}/resources/{resource_id}/download

Downloads the source file for a resource. Query parameters can control format or filename.

17. Get Resource Content

GET https://openapi.felo.ai/v2/livedocs/{short_id}/resources/{resource_id}/content

Returns full resource content, useful before the Agent generates a deliverable.

18. PPT Page Retrieve

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/ppt-retrieve

Runs retrieval across PPT pages and returns matched pages, titles, text, and snippets. Useful for deck Q&A, rewrite, and reuse.

README

19. Get README

GET https://openapi.felo.ai/v2/livedocs/{short_id}/readme

Reads the LiveDoc project guide. It usually contains goals, scope, usage notes, and summary.

20. Create or Update README

PUT https://openapi.felo.ai/v2/livedocs/{short_id}/readme

21. Append to README

POST https://openapi.felo.ai/v2/livedocs/{short_id}/readme/append

Appends Markdown content to the existing README. Useful for continuing research findings, decision logs, or meeting notes.

22. Delete README

DELETE https://openapi.felo.ai/v2/livedocs/{short_id}/readme

Deletes the current LiveDoc README.

Tasks And Collaboration

23. List Tasks

GET https://openapi.felo.ai/v2/livedocs/{short_id}/tasks

Lists tasks under a LiveDoc. Query with status, keyword, page, and size.

24. Create Task

POST https://openapi.felo.ai/v2/livedocs/{short_id}/tasks

25. Update Task

PATCH https://openapi.felo.ai/v2/livedocs/{short_id}/tasks/{task_id}

Updates task title, description, status, or metadata.

26. Delete Task

DELETE https://openapi.felo.ai/v2/livedocs/{short_id}/tasks/{task_id}

Deletes a task.

27. List Task Records

GET https://openapi.felo.ai/v2/livedocs/{short_id}/tasks/{task_id}/records

Shows task records, execution history, comments, and Agent outputs.

28. Add Task Comment

POST https://openapi.felo.ai/v2/livedocs/{short_id}/tasks/{task_id}/comments

Adds a comment or collaboration note to a task, so the team can track what the Agent completed, why it made decisions, and what comes next.

Коды ошибок