Getting started with Capydox
Typical flow from sign-up to documenting APIs and team evidence.
1. Create your account
Sign up with email and password and confirm your email when you receive the link. If your company uses an organization with SSO, your administrator can give you access without a local password.
2. Create or open a workspace
In the workspaces panel you can create a personal project or join a team or organization workspace according to your role. Each workspace groups collections, documentation, OpenAPI, evidence and its own settings.
3. Import your collection
In APIs → Import upload collections in compatible formats (Postman JSON, Insomnia YAML, ApiDog JSON). Capydox generates the technical base (endpoints, methods, models) to document and link evidence.
4. Document and review
- Markdown documentation for the workspace: project overview.
- Per-collection document: edit Markdown per request or unified view.
- OpenAPI editor: maintain a YAML/JSON spec per workspace with validation and preview.
5. Evidence and environments
Run or log tests and associate evidence with requests. Configure environments (URLs and variables) to align documentation with real deployments.
6. Grow with the team
With Team or organization plans, invite members, define roles and, in Business, configure SSO OIDC for your domain.
Quick checklist
- Email verified.
- Main workspace defined by team.
- Collection naming and versioning conventions agreed.
- Roles and SSO reviewed before inviting external users.