Available Endpoints

The Aimogen REST API exposes a controlled set of endpoints that map directly to Aimogen’s internal execution capabilities. These endpoints are not generic AI endpoints and they do not mirror provider APIs. Each endpoint represents a specific execution context inside Aimogen and is subject to authentication, permissions, limits, provider rules, and logging.

Endpoints are intentionally structured to prevent misuse and to preserve internal consistency.

---

General API Structure #

All Aimogen REST API endpoints follow a consistent structure:

• they are namespaced under Aimogen
• they require authentication
• they execute within a defined context
• they return structured, explicit responses
• they respect all internal safeguards

Endpoints do not expose raw provider access.

---

Content Generation Endpoints #

These endpoints allow external systems to trigger AI content creation using Aimogen’s generation engine.

Typical capabilities:

• generate a single post
• generate content for a specific post type
• pass titles, prompts, or structured inputs
• receive generated content as a response
• optionally control status, categories, and metadata

These endpoints behave exactly like using the content generators in the UI, including limits and provider selection.

---

Bulk Execution Endpoints #

Bulk-related endpoints allow triggering batch-style AI execution programmatically.

Common uses:

• generate multiple items in one request
• process lists of titles or inputs
• trigger controlled batch workflows
• integrate with external data sources

Bulk execution always respects:

• role permissions
• usage limits
• partial completion safety

There is no “unlimited batch” endpoint.

---

AI Content Editing Endpoints #

These endpoints expose AI Content Editing functionality.

They allow:

• submitting existing content
• applying editing instructions
• receiving edited output
• validating transformations before saving

Editing endpoints do not automatically persist changes unless explicitly instructed. This keeps external integrations safe by default.

---

Chatbot Interaction Endpoints #

Chatbot endpoints allow programmatic interaction with chatbots.

They support:

• sending messages
• continuing conversations
• starting new conversations
• receiving AI responses
• respecting chatbot personas, embeddings, and workflows

These endpoints are used for:

• custom frontends
• mobile apps
• embedded tools
• MCP-driven agents

Conversation state is preserved according to chatbot configuration.

---

Assistant Execution Endpoints #

Assistant-related endpoints allow external systems to:

• invoke AI Assistants
• pass messages or tasks
• leverage assistant instructions
• use assistant tools, files, and code execution

Assistants triggered via API behave identically to assistants used in the UI or workflows.

---

OmniBlocks Workflow Endpoints #

OmniBlocks endpoints allow triggering custom AI execution streams.

These endpoints can:

• start a predefined OmniBlocks workflow
• pass input data dynamically
• receive structured outputs
• execute multi-step logic
• integrate AI with external systems

This is the most powerful API surface in Aimogen.

---

Embeddings-Related Endpoints #

Embeddings endpoints allow controlled access to:

• embedding creation
• embedding updates
• embedding querying (where applicable)

They do not expose raw vector stores and cannot be used as general-purpose embedding APIs.

---

Image Generation Endpoints #

Image-related endpoints allow:

• generating images from prompts
• selecting image providers and models
• receiving image URLs or data
• respecting image-specific limits

These endpoints are cost-sensitive and heavily guarded by limits.

---

Forms and Structured Input Endpoints #

AI Forms endpoints allow:

• submitting structured input
• running validation or moderation
• receiving AI-processed responses
• integrating AI into external forms or flows

They are designed for deterministic, controlled input processing.

---

Playground-Oriented Endpoints #

Some endpoints exist specifically to support Playground-style execution, allowing:

• prompt testing
• model comparison
• assistant validation

These endpoints are typically restricted to trusted roles.

---

Status and Validation Endpoints #

Status-related endpoints allow:

• validating API availability
• checking authentication state
• verifying permissions
• confirming feature access

They do not expose usage metrics or internal state beyond what is safe.

---

Error and Response Structure #

All endpoints:

• return structured JSON
• differentiate between permission errors, limit blocks, and execution failures
• never return partial or ambiguous results

If execution does not occur, the response states why.

---

Endpoint Discovery and Stability #

Endpoints are:

• versioned implicitly through Aimogen releases
• documented to avoid breaking changes
• designed for long-term stability

Unsupported or deprecated endpoints are not silently removed.

---

What Is Intentionally Not Exposed #

The REST API does not expose:

• raw provider completion endpoints
• direct token streaming controls
• provider billing data
• internal database structures
• unrestricted execution hooks

This is deliberate.

---

Best Practices for Using Endpoints #

Use endpoints to orchestrate Aimogen features, not to recreate provider APIs. Authenticate properly, handle error states explicitly, respect limits, and monitor logs. Treat each endpoint as a production interface, not an experimental shortcut.

---

Summary #

Aimogen REST API endpoints provide structured, secure access to AI execution contexts, including content generation, editing, chatbots, assistants, workflows, images, embeddings, and forms. Each endpoint maps to a real Aimogen feature and enforces the same permissions, limits, provider controls, and logging as the UI. This design ensures powerful integration without sacrificing safety, predictability, or cost control.