LiveDoc API

LiveDoc API는 Agent가 재사용할 수 있는 workspace knowledge base를 만들기 위한 API입니다. LiveDoc 생성, file/URL ingestion, resource management, semantic retrieval, README, tasks, task records를 하나의 workspace에서 다룹니다.

인증

모든 requests는 Authorization header에 API key가 필요합니다.

Authorization: Bearer YOUR_API_KEY

핵심 흐름

1. project, client, research topic, team knowledge를 위한 LiveDoc을 만듭니다.
2. document, uploaded file, URL, PPT/page assets 같은 resources를 추가합니다.
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"}'

성공하면 short_id, name, description, icon, created_at, modified_at, is_shared를 포함한 LiveDoc object가 반환됩니다.

2. List LiveDocs

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

total, page, size, items를 포함한 paginated list를 반환합니다. 각 item에는 readme가 포함될 수 있습니다.

3. Update LiveDoc

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

Body에서 name과 description을 업데이트할 수 있습니다. Updated LiveDoc object를 반환합니다.

4. Delete LiveDoc

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

지정한 LiveDoc을 삭제합니다. 성공 시 { "deleted": true }를 반환합니다.

리소스 관리

5. 리소스 목록

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

Resource object에는 보통 resource_id, title, type, content, metadata, created_at, modified_at가 포함됩니다.

6. 단일 리소스 가져오기

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

단일 resource의 metadata와 content summary를 가져옵니다.

7. 리소스 업데이트

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

title, description, metadata 같은 resource 정보를 업데이트합니다.

8. 리소스 콘텐츠 업데이트

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

resource body를 교체합니다. Agent가 만든 notes, report draft, structured content를 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

multipart/form-data로 file을 upload하고 parsed content를 document resource로 저장합니다. PDF, DOCX, TXT, Markdown 자료에 적합합니다.

11. 파일 리소스 업로드

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

multipart/form-data로 source file을 upload하고 download 또는 retrieval용으로 보관합니다.

12. URL 리소스 추가

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

URL list를 전달합니다. Plain string 또는 url, title, description, metadata를 포함한 object를 사용할 수 있습니다. Web pages, articles, competitor research, public docs를 Agent workspace에 가져올 때 적합합니다.

13. 리소스 삭제

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

지정한 resource를 삭제합니다. 성공 시 { "deleted": true }를 반환합니다.

검색 및 라우팅

14. Retrieve(시맨틱 검색)

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

query와 가장 관련 있는 resource snippets를 반환합니다. RAG, research summary, PPT generation, report writing에 사용할 수 있습니다.

15. 리소스 라우팅

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

query에 따라 어떤 resources를 호출해야 하는지 판단합니다. Agent가 여러 sources 중 필요한 context를 자동 선택할 때 유용합니다.

16. Download Resource Source File

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

resource의 source file을 download합니다. query parameters로 format 또는 filename을 제어할 수 있습니다.

17. Get Resource Content

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

resource의 full content를 반환합니다. Agent가 deliverable을 생성하기 전에 전체 자료를 읽을 때 적합합니다.

18. PPT Page Retrieve

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

PPT pages에 retrieval을 실행하고 matched page, title, text, snippets를 반환합니다. deck Q&A, rewrite, reuse에 사용할 수 있습니다.

README

19. Get README

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

LiveDoc의 project guide를 가져옵니다. 보통 goals, scope, usage notes, 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

기존 README에 Markdown content를 추가합니다. research findings, decision log, meeting notes를 계속 기록하는 데 사용할 수 있습니다.

22. Delete README

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

현재 README를 삭제합니다.

Tasks And Collaboration

23. List Tasks

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

LiveDoc의 tasks를 list합니다. status, keyword, page, size로 query할 수 있습니다.

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}

task title, description, status, metadata를 업데이트합니다.

26. Delete Task

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

지정한 task를 삭제합니다.

27. List Task Records

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

task records, execution history, comments, Agent outputs를 확인합니다.

28. Add Task Comment

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

task에 comment 또는 collaboration note를 추가합니다. Agent가 무엇을 완료했는지, 왜 그렇게 했는지, 다음 단계가 무엇인지 추적할 수 있습니다.

오류 코드