REST API Reference
Programmatic access to OmniRoles' full project generation engine. Authenticate with an API key, send a project description, and receive PRDs, database schemas, API contracts, and Jira sprint boards in structured JSON.
Authentication & Base URL
https://api.omniroles.com/v1All API requests require a persistent API key passed via the HTTP Authorization header:
Authorization: Bearer <your-api-key>
Generate and scope API keys from the OmniRoles dashboard under Settings → API Keys. Keys inherit your subscription tier and consume credits per call.
API Endpoints
/v1/projects/generateGenerate a complete project architecture, ERD, API specs, and sprint board from a natural-language description.
{
"description": "Multi-tenant pharmacy management SaaS",
"tech_stack": ["Next.js", "FastAPI", "PostgreSQL"],
"output_format": "full"
}{
"project_id": "proj_abc123",
"status": "processing",
"estimated_time_seconds": 600,
"webhook_url": null
}/v1/projects/{project_id}Check generation status and retrieve structured output artifact URLs.
{
"project_id": "proj_abc123",
"status": "completed",
"outputs": {
"prd": { "url": "https://cdn.omniroles.com/outputs/proj_abc123/prd.md", "format": "markdown" },
"erd": { "url": "https://cdn.omniroles.com/outputs/proj_abc123/erd.mmd", "format": "mermaid" },
"api_contracts": { "url": "https://cdn.omniroles.com/outputs/proj_abc123/apis.json", "format": "json" },
"jira_sprint": { "url": "https://cdn.omniroles.com/outputs/proj_abc123/jira.json", "format": "jira-import" }
},
"credits_consumed": 5000
}/v1/projectsList all project generations in your workspace with status filtering and pagination.
status ("processing" | "completed" | "failed"), limit (default 20, max 100), offset (default 0)./v1/webhooksRegister a webhook URL to receive HTTPS callback payloads when background generations complete.
{
"url": "https://your-server.com/webhooks/omniroles",
"events": ["project.completed", "project.failed"]
}Rate Limits & Response Codes
| Subscription Tier | Requests / Min | Credits Consumed / Call |
|---|---|---|
| Free | 10 | 1,000 |
| Pro | 60 | 5,000 |
| Business | 120 | 20,000 |
| Enterprise | 300 | 50,000 |
OmniRoles REST API provides direct software consumption access to BrandXpoint's proprietary software engine. It does not enable third-party sellers to resell or deliver services to end customers.