Backend/API Orientation
This page gives a plain-language view of backend behavior so developers can onboard without reading raw endpoint inventories first.
Direct links for this section
- Backend API base: api.visyble.ai
- OpenAPI JSON: api.visyble.ai/openapi.json
- Backend API Explained: docs.visyble.ai/generated/backend-api-explained
- Backend Domain Guide: docs.visyble.ai/generated/backend-domain-guide
- API Endpoint Details: docs.visyble.ai/generated/api-endpoint-details
- Frontend API Usage Reference: docs.visyble.ai/generated/frontend-api-usage-reference
Backend panorama
The backend is the decision engine of the product. It receives requests from the interface, applies business and operational rules, orchestrates data pipelines, and returns outputs that drive user decisions.
A helpful way to think about the backend is in six functional layers:
- Insight and analytics intelligence
- Agent and crawler intelligence
- Job execution and scheduling
- Core entities such as brands, prompts, and sources
- Workspace operations such as settings, billing, integrations, and webhooks
- System reliability and control-plane services
What developers should understand first
Before implementation work, every developer should be able to answer:
- Which backend areas are most critical for daily product value
- Which areas are operationally sensitive
- Which API groups drive visible frontend behavior
- Which parts are platform infrastructure rather than user-facing capability
When these answers are clear, implementation becomes more accurate and safer.
Execution and reliability model
The system combines product APIs with operational orchestration. That means backend work is not only about returning data; it is also about preserving reliability under recurring workloads.
In practice, this requires developers to understand:
- how scrape and processing jobs are scheduled and monitored
- how fallback behavior protects user-visible outcomes
- how control-plane components coordinate recurring execution
- how operational states appear in product-facing views
Access and governance model
The backend enforces access, organizational boundaries, and production safeguards. New developers should treat governance controls as part of product behavior, not as an afterthought.
This includes:
- access policies for user and organization scope
- production gating and rollout controls
- audit-friendly behavior for sensitive actions
Maintenance and data integrity
Some backend capabilities are runtime APIs, while others are operational maintenance workflows used to preserve data quality. Developers should clearly separate these two concerns when making changes.
A good rule: runtime behavior serves users directly, while maintenance behavior protects long-term data trust.
How to use backend docs effectively
Read backend docs in this sequence:
- Plain-language API explanations to understand intent
- Domain-level guides to understand architecture
- Endpoint-level details for implementation and validation
- Operations checklist for production safety
This sequence keeps onboarding clear and reduces confusion from low-level details too early in the learning process.