OrgvatarREST API v1

Orgvatar REST API v1

The Orgvatar REST API lets you embed the full V-Avatar consultation experience into your platform. Built for platform integrators like Yassu.ai and 2percent.ai.

Quick Start

1Generate an API key from your API Keys dashboard.
2Store it as ORGAVA_API_KEY in your environment variables.
3Add Authorization: Bearer YOUR_API_KEY to all authenticated requests.
4Call GET /api/v1/health to verify connectivity.

Base URL

https://orgvatar.ai/api/v1

Authentication

All authenticated endpoints require a Bearer token in the Authorization header. Keys are prefixed with orgvatar_ and scoped to a single startup and tier.

Header

Authorization: Bearer orgvatar_your_api_key_here

Tier Access

Tier	V-Avatars	Departments
Starter	Ava, Marcus, Sofia, Alex, Priya (COO), Sam, Jordan, Liam	HR, Finance, Marketing, Technology, Operations
Growth	All Starter + James, Nina, Ravi, Aria, David, Diego, Zoe, Kai, Maya, Priya (AI)	+ Legal, Finance Ops, Demand Gen, Customer Success
Pro	Full team of 20 V-Avatars	+ Strategy & Governance (Dr. Lena Fischer, The Board Room)

Endpoints

Integration Guides

Yassu.ai Integration

Embed Orgvatar's V-Avatar consultations as a native feature within the Yassu platform. Users can access their virtual team without leaving Yassu.

1. Generate a Growth-tier API key for Yassu.ai
2. Sync user startup profiles via POST /startups/profile
3. Render avatar list with GET /avatars
4. Proxy consultation messages via POST /consultations/:id/message

2percent.ai Integration

Add Orgvatar's virtual executive team as a value-add for 2percent.ai users. Founders get access to their V-Avatars directly within the 2percent.ai workflow.

1. Generate a Pro-tier API key for 2percent.ai
2. Use POST /consultations/start with the relevant avatar
3. Stream responses back to your UI
4. Retrieve documents via GET /documents/:id/download

Error Codes

HTTP Status	Error Code	Description
401	unauthorized	Missing or invalid API key
403	forbidden	Key doesn't have access to this resource or tier
404	not_found	Resource doesn't exist
400	bad_request	Missing or invalid request parameters
429	rate_limited	Too many requests — back off and retry
500	internal_error	Server error — contact support
503	service_unavailable	Database temporarily unavailable

Orgvatar REST API v1 · For integration support, contact the Orgvatar team.