API Reference

Integrate Shivo into your workflow programmatically. Generate specifications, manage your library, and automate documentation from your CI/CD pipeline.

Authentication

All API requests require authentication via Supabase. Include your session token in the request headers. The API uses cookie-based auth for browser clients and Bearer tokens for server-to-server calls.

// Header

Authorization: Bearer your_supabase_access_token

Base URL

https://shivo.jishulabs.com

Endpoints

POST/api/generate

Generate a new specification from a title, description, and optional features/constraints.

Parameters

Name	Type	Description
`specType`req	string	One of: prd, tdd, sdd, api_design, security, compliance
`title`req	string	Title of the specification to generate
`description`req	string	Detailed description of the feature or project
`features`	string[]	Array of key features to include
`constraints`	string[]	Array of constraints and requirements

Response

{ "content": "# Generated PRD\n\n## Executive Summary..." }

POST/api/specs

Save a generated specification to your account for tracking, review, and export.

Parameters

Name	Type	Description
`title`req	string	Specification title
`content`req	string	Full specification content in Markdown
`spec_type`req	string	Type of specification (prd, tdd, etc.)
`description`	string	Brief summary of the specification

Response

{ "id": "uuid", "title": "...", "status": "draft", "created_at": "..." }

GET/api/settings

Retrieve the authenticated user's profile and notification preferences.

Response

{ "profile": { "full_name": "...", "email": "..." }, "notifications": { ... } }

PUT/api/settings

Update the authenticated user's profile, notification preferences, or appearance settings.

Parameters

Name	Type	Description
`profile`	object	Profile fields: full_name, company, timezone
`notifications`	object	Notification toggles: email_enabled, approval_alerts, etc.
`appearance`	object	Appearance: theme (light/dark/system), language

Response

{ "success": true }

POST/api/settings/export

Export all user data including specs, settings, and templates as a JSON file.

Response

{ "specs": [...], "settings": {...}, "templates": [...] }

Need help with the API?

Our team can help you set up integrations and automate your spec workflow.

Contact Engineering