Felo API PlatformFelo API Platform

Felo APIs

LiveDoc API

Vytvářejte znalostní báze, spravujte zdroje a spouštějte sémantické vyhledávání a směrování.

POST/v2/livedocs

Ověřování

Bearer API key

Typ obsahu

application/json or multipart/form-data

Poznámky k limitům

Mohou platit limity pro jednotlivé endpointy.

LiveDoc API poskytuje kompletní CRUD operace pro LiveDocs a jejich zdroje, včetně vytváření dokumentů, nahrávání souborů, importu URL a sémantického načítání.

Ověřování

Všechny požadavky vyžadují API klíč v hlavičce Authorization:

Authorization: Bearer YOUR_API_KEY

Použití s AI agenty

Nainstalujte kompletní balíček felo-ai, abyste agentovi zpřístupnili podporu LiveDoc a všechny ostatní dostupné Felo Skills. Instalátor dynamicky objevuje každý adresář balíčku obsahující SKILL.md, včetně budoucích přírůstků balíčku. Nainstalujte všechny objevené Skills do nativního adresáře agenta: Codex ~/.codex/skills, Claude Code ~/.claude/skills, OpenClaw ~/.agents/skills nebo Hermes Agent ~/.hermes/skills. Příručka k ručnímu nastavení AI agenta popisuje specifické kroky pro API klíč a ověření u každé platformy.


1. Vytvoření LiveDocu

Endpoint

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

Tělo požadavku

ParametrTypPovinnéPopis
namestringAnoNázev LiveDocu
descriptionstringNePopis LiveDocu
iconstringNeIkona LiveDocu

Příklad

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"
  }'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "short_id": "PvyKouzJirXjFdst4uKRK3",
    "name": "AI Research Notes",
    "description": "Collection of AI research materials",
    "icon": null,
    "created_at": "2026-03-09T10:00:00Z",
    "modified_at": "2026-03-09T10:00:00Z"
  }
}

Pole odpovědi

PoleTypPopis
short_idstringID LiveDocu
namestringNázev LiveDocu
descriptionstringPopis LiveDocu
iconstringIkona LiveDocu
created_atstringČasové razítko vytvoření (ISO 8601)
modified_atstringČasové razítko poslední úpravy (ISO 8601)
is_sharedbooleanZda je tento LiveDoc sdílen s aktuálním uživatelem (nevlastní ho)

2. Seznam LiveDoců

Endpoint

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

Parametry dotazu

ParametrTypPovinnéPopis
keywordstringNeFiltrovat podle klíčového slova
pageintegerNeČíslo stránky (od 1)
sizeintegerNeVelikost stránky

Příklad

curl 'https://openapi.felo.ai/v2/livedocs?keyword=AI&page=1&size=20' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "total": 2,
    "page": 1,
    "size": 20,
    "items": [
      {
        "short_id": "PvyKouzJirXjFdst4uKRK3",
        "name": "AI Research Notes",
        "description": "Collection of AI research materials",
        "icon": null,
        "created_at": "2026-03-09T10:00:00Z",
        "modified_at": "2026-03-09T10:05:00Z",
        "is_shared": false,
        "readme": {
          "summary": "AI research notes and papers collection",
          "content": "# AI Research Notes\n\nThis LiveDoc contains..."
        }
      }
    ]
  }
}

Pole odpovědi

Každá položka v items obsahuje stejná pole jako odpověď na vytvoření LiveDocu, navíc:

PoleTypPopis
readmeobject | nullInformace o README. null, pokud README neexistuje.
readme.summarystring | nullJednořádkový popis projektu
readme.contentstring | nullObsah README (Markdown)

Endpoint

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

Tělo požadavku

ParametrTypPovinnéPopis
namestringNeNový název LiveDocu
descriptionstringNeNový popis LiveDocu

Příklad

curl -X PUT 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated Research Notes"
  }'

Úspěšná odpověď (200)

Vrací aktualizovaný objekt LiveDocu (stejná struktura jako při vytvoření).


4. Smazání LiveDocu

Endpoint

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

Příklad

curl -X DELETE 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": null
}

5. Seznam zdrojů

Endpoint

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

Parametry dotazu

ParametrTypPovinnéPopis
resource_typesstring[]NeFiltrovat podle typů zdrojů
pageintegerNeČíslo stránky (od 1)
sizeintegerNeVelikost stránky

Příklad

curl 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources?page=1&size=20' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "total": 2,
    "page": 1,
    "size": 20,
    "items": [
      {
        "id": "res_001",
        "title": "OpenAI Blog Post",
        "link": "https://openai.com/blog/...",
        "snippet": "Summary of the article...",
        "thumbnail": null,
        "resource_type": "web",
        "resource_key": "key_001",
        "status": "completed",
        "source": "url",
        "created_at": "2026-03-09T10:00:10Z",
        "modified_at": "2026-03-09T10:00:15Z"
      }
    ]
  }
}

Pole odpovědi zdroje

PoleTypPopis
idstringID zdroje
titlestringNázev zdroje
linkstringOdkaz/URL zdroje
snippetstringShrnutí zdroje
thumbnailstringURL náhledového obrázku
resource_typestringTyp zdroje (např. web, ai_doc, file)
resource_keystringKlíč přidružení zdroje
statusstringStav zdroje
sourcestringPůvod zdroje
created_atstringČasové razítko vytvoření (ISO 8601)
modified_atstringČasové razítko poslední úpravy (ISO 8601)

6. Získání jednoho zdroje

Endpoint

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

Příklad

curl 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/res_001' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Úspěšná odpověď (200)

Vrací jeden objekt zdroje (stejná struktura jako položky v seznamu zdrojů).


7. Aktualizace zdroje

Aktualizujte title, snippet nebo thumbnail zdroje. Aktualizují se pouze poskytnutá pole; vynechaná pole si zachovají aktuální hodnoty.

Endpoint

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

Tělo požadavku

Všechna pole jsou volitelná.

ParametrTypPovinnéPopis
titlestringNeNový název zdroje (max. 500 znaků)
snippetstringNeNové shrnutí zdroje (max. 2000 znaků)
thumbnailstringNeNová URL náhledového obrázku (max. 2000 znaků)

Příklad

curl -X PUT 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/res_001' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Updated Title",
    "snippet": "Updated summary of the resource."
  }'

Úspěšná odpověď (200)

Vrací aktualizovaný objekt zdroje (stejná struktura jako položky v seznamu zdrojů).


8. Aktualizace obsahu zdroje

Aktualizujte obsah Markdown zdroje typu ai_doc. Podporováno pouze pro zdroje s resource_type == ai_doc. Pole snippet se automaticky aktualizuje z prvních 2000 bajtů nového obsahu.

Endpoint

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

Tělo požadavku

ParametrTypPovinnéPopis
contentstringAnoNový obsah Markdown pro zdroj

Příklad

curl -X PUT 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/res_001/content' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "content": "# Updated Document\n\nThis is the new content."
  }'

Úspěšná odpověď (200)

Vrací aktualizovaný objekt zdroje (stejná struktura jako položky v seznamu zdrojů).


9. Vytvoření zdroje dokumentu

Endpoint

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

Tělo požadavku

ParametrTypPovinnéPopis
titlestringNeNázev dokumentu (výchozí je "New Document")
contentstringAnoObsah dokumentu

Příklad

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/doc' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "My Research Notes",
    "content": "Key findings from the AI research paper..."
  }'

Úspěšná odpověď (200)

Vrací vytvořený objekt zdroje.


10. Nahrání souboru jako dokumentu

Nahrajte soubor a převeďte ho na zdroj typu dokument (ai_doc).

Endpoint

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

Content-Type

multipart/form-data

Části požadavku

ParametrTypPovinnéPopis
filefileAnoSoubor k nahrání
titlestringNeNázev dokumentu

Příklad

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/upload-doc' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -F '[email protected]' \
  -F 'title=My PDF Document'

Úspěšná odpověď (200)

Vrací vytvořený objekt zdroje.


11. Nahrání souboru jako zdroje

Nahrajte soubor a zachovejte jeho původní formát.

Endpoint

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

Content-Type

multipart/form-data

Části požadavku

ParametrTypPovinnéPopis
filefileAnoSoubor k nahrání

Příklad

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/upload' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -F '[email protected]'

Úspěšná odpověď (200)

Vrací vytvořený objekt zdroje.


12. Přidání zdrojů URL

Přidejte do LiveDocu jednu nebo více URL jako zdroje.

Endpoint

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

Tělo požadavku

ParametrTypPovinnéPopis
urlsarrayAnoSeznam položek URL k přidání (1-10). Každá položka může být prostý řetězec nebo objekt s url a volitelným title.

Formáty položek URL

Každá položka v urls může být buď:

  • Prostý řetězec: "https://example.com/article"
  • Objekt: {"url": "https://example.com/article", "title": "Custom Title"}
PoleTypPovinnéPopis
urlstringAnoURL k přidání (5-2000 znaků)
titlestringNeVlastní název zdroje (max. 1000 znaků). Pokud je vynechán, název se vygeneruje automaticky ze stránky.

Příklad

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/urls' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "urls": [
      "https://example.com/article-1",
      {"url": "https://example.com/article-2", "title": "My Custom Title"}
    ]
  }'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": [
    {
      "url": "https://example.com/article-1",
      "status": "success",
      "fail_reason": null,
      "resource_id": "res_003"
    },
    {
      "url": "https://example.com/article-2",
      "status": "existed",
      "fail_reason": null,
      "resource_id": "res_004"
    }
  ]
}

Pole výsledku URL

PoleTypPopis
urlstringZpracovaná URL
statusstringStav výsledku: success, failed nebo existed
fail_reasonstringDůvod selhání (null při úspěchu)
resource_idstringID vytvořeného zdroje

13. Smazání zdroje

Endpoint

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

Příklad

curl -X DELETE 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/res_001' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": null
}

14. Načtení (sémantické vyhledávání)

Proveďte sémantické načtení vůči zdrojům v LiveDocu.

Endpoint

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

Tělo požadavku

ParametrTypPovinnéPopis
querystringAnoObsah dotazu pro sémantické vyhledávání
resource_idsstring[]NeKonkrétní ID zdrojů, v nichž se má hledat (1-50). Pokud jsou vynechána, relevantní zdroje se směrují automaticky podle dotazu

Příklad

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/retrieve' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "latest developments in large language models",
    "resource_ids": ["res_001", "res_002"]
  }'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": [
    {
      "id": "res_001",
      "title": "LLM Research Paper",
      "content": "Relevant content excerpt...",
      "score": 0.92,
      "metadata": {}
    }
  ]
}

Pole výsledku načtení

PoleTypPopis
idstringID zdroje
titlestringNázev zdroje
contentstringOdpovídající obsah
scorenumberSkóre relevance
metadataobjectDoplňující metadata

15. Směrování zdrojů

Směrujte relevantní zdroje z LiveDocu na základě dotazu. Vrací seznam ID zdrojů, která lze předat endpointu načtení.

Endpoint

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

Tělo požadavku

ParametrTypPovinnéPopis
querystringAnoObsah dotazu pro směrování
max_resourcesintegerNeMaximální počet ID zdrojů, která se mají vrátit

Příklad

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/route' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "latest developments in large language models",
    "max_resources": 5
  }'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": ["res_001", "res_003", "res_007"]
}

16. Stažení zdrojového souboru zdroje

Získejte zdrojový soubor zdroje. Vrací přesměrování 302 na předem podepsanou URL pro stažení.

Podporováno pouze pro zdroje, které mají přidružený zdrojový soubor (např. nahrané dokumenty).

Endpoint

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

Parametry dotazu

ParametrTypPovinnéPopis
expires_inintegerNePlatnost URL v sekundách (výchozí: 3600)

Příklad

curl -L 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/res_001/download' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Odpověď

Vrací 302 Found s hlavičkou Location odkazující na předem podepsanou URL pro stažení z S3. Klienti HTTP s podporou přesměrování (např. curl -L) přesměrování následují a stáhnou soubor přímo.


17. Získání obsahu zdroje

Načtěte extrahovaný textový obsah zdroje. Podporováno pro většinu typů zdrojů (dokument, web, video, ai_doc, ai_ppt, text, voice, mindmap atd.). Pro nepodporované typy, jako je image, se vrací 400.

Endpoint

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

Příklad

curl 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/res_001/content' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "title": "Q4 Financial Report",
    "type": "document",
    "content": "Full extracted text content of the resource..."
  }
}

Pole odpovědi

PoleTypPopis
titlestringNázev zdroje
typestringTyp zdroje
contentstringExtrahovaný textový obsah

18. Načtení stránky PPT

Proveďte hluboké načtení obsahu na konkrétní stránce zdroje PPT. Seškrábe stránku snímku a vrací seřazené části obsahu. Formát odpovědi je shodný s endpointem Načtení.

Endpoint

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

Tělo požadavku

ParametrTypPovinnéPopis
resource_idstringAnoID zdroje PPT
page_numberintegerAnoČíslo stránky k načtení (počínaje 1)
querystringAnoObsah dotazu popisující, co hledat
max_chunkintegerNeMaximální počet částí, které se mají vrátit (výchozí: 3)

Příklad

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/ppt-retrieve' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "resource_id": "res_001",
    "page_number": 3,
    "query": "product pricing information",
    "max_chunk": 3
  }'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": [
    {
      "id": "res_001_page_3_chunk_1",
      "title": "Q4 Product Deck",
      "content": "Relevant slide content excerpt...",
      "score": null,
      "metadata": {
        "resource_id": "res_001",
        "page_number": 3,
        "index": 1
      }
    }
  ]
}

Pole odpovědi

Stejná jako pole výsledku načtení.


Kódy chyb

KódStav HTTPPopis
UNAUTHORIZED401API klíč je neplatný nebo zrušený
LIVEDOC_CREATE_FAILED502Vytvoření LiveDocu selhalo
LIVEDOC_UPDATE_FAILED502Aktualizace LiveDocu selhala
LIVEDOC_DELETE_FAILED502Smazání LiveDocu selhalo
LIVEDOC_NOT_FOUND404LiveDoc nebyl nalezen
LIVEDOC_LIST_FAILED502Seznam LiveDoců se nepodařilo načíst
LIVEDOC_RESOURCE_CREATE_FAILED502Vytvoření zdroje selhalo
LIVEDOC_RESOURCE_UPLOAD_FAILED502Nahrání zdroje selhalo
LIVEDOC_RESOURCE_DELETE_FAILED502Smazání zdroje selhalo
LIVEDOC_RESOURCE_NOT_FOUND404Zdroj nebyl nalezen
LIVEDOC_RESOURCE_LIST_FAILED502Seznam zdrojů se nepodařilo načíst
LIVEDOC_RESOURCE_RETRIEVE_FAILED502Načtení zdrojů selhalo
LIVEDOC_RESOURCE_ADD_URLS_FAILED502Přidání zdrojů URL selhalo

19. Získání README

Získejte obsah README LiveDocu. Pokud README nebylo nastaveno, vrací prázdný řetězec.

Endpoint

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

Příklad

curl 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/readme' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "summary": "A brief one-line description of the project.",
    "content": "# My LiveDoc\n\nThis is the README content in Markdown."
  }
}

Pole odpovědi

PoleTypPopis
summarystring | nullJednořádkový popis projektu. Max. 2000 znaků.
contentstringObsah README (Markdown). Prázdný řetězec, pokud není nastaven.

20. Vytvoření nebo aktualizace README

Vytvořte nebo aktualizujte README LiveDocu (sémantika upsert).

Endpoint

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

Tělo požadavku

ParametrTypPovinnéPopis
summarystringNeJednořádkový popis projektu (max. 2000 znaků)
contentstringNeObsah README (Markdown)

Poznámka: Musí být poskytnuto alespoň jedno z polí summary nebo content.

Příklad

curl -X PUT 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/readme' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "summary": "A brief one-line description of the project.",
    "content": "# My LiveDoc\n\nThis is the README content in Markdown."
  }'

Úspěšná odpověď (200)

Vrací aktualizovaný objekt README (stejná struktura jako při získání README).


21. Připojení k README

Připojte obsah na konec existujícího README. Pokud README neexistuje, vytvoří se nové s poskytnutým obsahem.

Endpoint

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

Tělo požadavku

ParametrTypPovinnéPopis
contentstringAnoObsah k připojení (Markdown)

Příklad

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/readme/append' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "content": "\n\n## New Section\n\nAdditional content appended to README."
  }'

Úspěšná odpověď (200)

Po připojení vrací kompletní objekt README (stejná struktura jako při získání README).


22. Smazání README

Smažte README LiveDocu.

Endpoint

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

Příklad

curl -X DELETE 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/readme' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": null
}

23. Seznam úloh

Získejte stránkovaný seznam úloh v LiveDocu. Výsledky jsou seřazeny podle sort vzestupně, status vzestupně, created_at sestupně.

Endpoint

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

Parametry dotazu

ParametrTypPovinnéPopis
statusintegerNeFiltrovat podle stavu: 0=TODO, 1=IN_PROGRESS, 2=DONE
labelsstring[]NeFiltrovat podle štítků (úlohy musí obsahovat všechny zadané štítky)
pageintegerNeČíslo stránky (od 1)
sizeintegerNeVelikost stránky

Příklad

curl 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/tasks?status=0&page=1&size=20' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "total": 1,
    "page": 1,
    "size": 20,
    "items": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "title": "Write documentation",
        "description": "Write API documentation for the new endpoints",
        "status": 0,
        "sort": 0,
        "labels": ["docs", "priority-high"],
        "created_at": "2026-03-19T10:00:00Z",
        "modified_at": "2026-03-19T10:00:00Z"
      }
    ]
  }
}

Pole odpovědi úlohy

PoleTypPopis
idstringID úlohy (UUID)
titlestringNázev úlohy
descriptionstringPopis úlohy
statusintegerStav úlohy: 0=TODO, 1=IN_PROGRESS, 2=DONE
sortintegerPořadí řazení (nezáporné)
labelsstring[]Seznam štítků
operated_bystringPodpis operátora, např. claude-code, openclaw
created_atstringČasové razítko vytvoření (ISO 8601)
modified_atstringČasové razítko poslední úpravy (ISO 8601)

24. Vytvoření úlohy

Vytvořte v LiveDocu novou úlohu.

Endpoint

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

Tělo požadavku

ParametrTypPovinnéPopis
titlestringAnoNázev úlohy
descriptionstringNePopis úlohy
statusintegerAnoStav úlohy: 0=TODO, 1=IN_PROGRESS, 2=DONE
sortintegerAnoPořadí řazení (nezáporné celé číslo)
labelsstring[]NeSeznam štítků (max. 10, každý max. 50 znaků)
operated_bystringNePodpis operátora, např. claude-code, openclaw (max. 100 znaků)

Příklad

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/tasks' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Write documentation",
    "description": "Write API documentation for the new endpoints",
    "status": 0,
    "sort": 0,
    "labels": ["docs", "priority-high"]
  }'

Úspěšná odpověď (200)

Vrací vytvořený objekt úlohy (stejná struktura jako položky v seznamu úloh).


25. Aktualizace úlohy

Částečně aktualizujte úlohu. Aktualizují se pouze poskytnutá pole; vynechaná pole si zachovají aktuální hodnoty.

Endpoint

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

Tělo požadavku

Všechna pole jsou volitelná.

ParametrTypPovinnéPopis
titlestringNeNový název úlohy
descriptionstringNeNový popis úlohy
statusintegerNeNový stav: 0=TODO, 1=IN_PROGRESS, 2=DONE
sortintegerNeNové pořadí řazení (nezáporné)
labelsstring[]NeNový seznam štítků (max. 10, každý max. 50 znaků)
operated_bystringNePodpis operátora, např. claude-code, openclaw (max. 100 znaků)

Příklad

curl -X PATCH 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/tasks/550e8400-e29b-41d4-a716-446655440000' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": 1
  }'

Úspěšná odpověď (200)

Vrací aktualizovaný objekt úlohy (stejná struktura jako položky v seznamu úloh).


26. Smazání úlohy

Proveďte měkké smazání úlohy.

Endpoint

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

Příklad

curl -X DELETE 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/tasks/550e8400-e29b-41d4-a716-446655440000' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": null
}

27. Seznam záznamů úlohy

Získejte stránkovaný seznam záznamů úlohy (komentáře a historie změn) seřazený vzestupně podle created_at.

Endpoint

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

Parametry dotazu

ParametrTypPovinnéPopis
record_typestringNeFiltrovat podle typu záznamu: comment, edit, status_change
pageintegerNeČíslo stránky (od 1)
sizeintegerNeVelikost stránky

Příklad

curl 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/tasks/550e8400-e29b-41d4-a716-446655440000/records' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Úspěšná odpověď (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "total": 2,
    "page": 1,
    "size": 20,
    "items": [
      {
        "id": "rec_001",
        "record_type": "comment",
        "content": "This is a comment",
        "meta": null,
        "task_id": "550e8400-e29b-41d4-a716-446655440000",
        "created_at": "2026-03-19T10:05:00Z",
        "modified_at": "2026-03-19T10:05:00Z"
      },
      {
        "id": "rec_002",
        "record_type": "status_change",
        "content": null,
        "meta": {"from": 0, "to": 1},
        "task_id": "550e8400-e29b-41d4-a716-446655440000",
        "created_at": "2026-03-19T10:10:00Z",
        "modified_at": "2026-03-19T10:10:00Z"
      }
    ]
  }
}

Pole odpovědi záznamu úlohy

PoleTypPopis
idstringID záznamu
record_typestringTyp záznamu: comment / edit / status_change
contentstringText komentáře (pouze pro typ comment)
metaobjectPodrobnosti změny (pro typy edit a status_change)
task_idstringID nadřazené úlohy
operated_bystringPodpis operátora, např. claude-code, openclaw
created_atstringČasové razítko vytvoření (ISO 8601)
modified_atstringČasové razítko poslední úpravy (ISO 8601)

28. Přidání komentáře k úloze

Přidejte k úloze komentář.

Endpoint

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

Tělo požadavku

ParametrTypPovinnéPopis
contentstringAnoObsah komentáře
operated_bystringNePodpis operátora, např. claude-code, openclaw (max. 100 znaků)

Příklad

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/tasks/550e8400-e29b-41d4-a716-446655440000/comments' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "content": "This task is now in progress."
  }'

Úspěšná odpověď (200)

Vrací vytvořený objekt záznamu (stejná struktura jako položky v seznamu záznamů úlohy).


Kódy chyb (aktualizované)

KódStav HTTPPopis
UNAUTHORIZED401API klíč je neplatný nebo zrušený
LIVEDOC_CREATE_FAILED502Vytvoření LiveDocu selhalo
LIVEDOC_UPDATE_FAILED502Aktualizace LiveDocu selhala
LIVEDOC_DELETE_FAILED502Smazání LiveDocu selhalo
LIVEDOC_NOT_FOUND404LiveDoc nebyl nalezen
LIVEDOC_LIST_FAILED502Seznam LiveDoců se nepodařilo načíst
LIVEDOC_RESOURCE_CREATE_FAILED502Vytvoření zdroje selhalo
LIVEDOC_RESOURCE_UPLOAD_FAILED502Nahrání zdroje selhalo
LIVEDOC_RESOURCE_DELETE_FAILED502Smazání zdroje selhalo
LIVEDOC_RESOURCE_NOT_FOUND404Zdroj nebyl nalezen
LIVEDOC_RESOURCE_LIST_FAILED502Seznam zdrojů se nepodařilo načíst
LIVEDOC_RESOURCE_RETRIEVE_FAILED502Načtení zdrojů selhalo
LIVEDOC_RESOURCE_ADD_URLS_FAILED502Přidání zdrojů URL selhalo
LIVEDOC_README_GET_FAILED502Získání README selhalo
LIVEDOC_README_UPDATE_FAILED502Vytvoření nebo aktualizace README selhaly
LIVEDOC_README_DELETE_FAILED502Smazání README selhalo
LIVEDOC_README_NOT_FOUND404README nebylo nalezeno
LIVEDOC_TASK_LIST_FAILED502Seznam úloh se nepodařilo načíst
LIVEDOC_TASK_CREATE_FAILED502Vytvoření úlohy selhalo
LIVEDOC_TASK_UPDATE_FAILED502Aktualizace úlohy selhala
LIVEDOC_TASK_DELETE_FAILED502Smazání úlohy selhalo
LIVEDOC_TASK_NOT_FOUND404Úloha nebyla nalezena
LIVEDOC_TASK_RECORD_LIST_FAILED502Seznam záznamů úlohy se nepodařilo načíst
LIVEDOC_TASK_COMMENT_CREATE_FAILED502Vytvoření komentáře k úloze selhalo