Reading Guide For Automation
Teams that connect assistants, bots, or external automation to Veoveo should read the docs in the same order the product uses context: workspace first, artifacts second, tools third, operations last.
Recommended Reading Order
- Read Core Concepts to understand workspaces, artifacts, links, events, tools, and operations.
- Read Artifacts before building anything that reads or writes workspace data.
- Read Agents to understand bot identity, channel input, tool use, memory, and governance.
- Read Tools for the available native and container-backed capabilities.
- Read API Overview and the generated reference when you need exact routes and schemas.
- Read Runtime when you need to understand long-running work, callbacks, retries, and timelines.
Public Machine-Readable Bundles
Veoveo publishes text bundles for systems that need a compact documentation entry point:
- llms.txt points to the main public documentation bundles.
- llms-api.txt focuses on API and route documentation.
- llms-tools.txt focuses on tool behavior and contracts.
Use these bundles as navigation aids. For decisions that depend on exact request or response shapes, use the API reference pages.
Good Integration Habits
- Keep workspace and artifact identifiers from prior API responses instead of reconstructing them from display text.
- Treat rendered summaries and thumbnails as navigation aids until you inspect the source artifact or event.
- Record the operation, artifact, or route that produced an automated result so a human can review it later.
- Prefer narrow reads over broad workspace scans when a user has already selected an artifact or operation.