Source: docs/integration/overview.md
Forgium Agent — Public API overview
Forgium Agent is a conversational-agent service. Start with [Use Forgium Agent
with an agent](use-with-an-agent.md) when a coding agent is doing the
integration. Your application can send a user message to the Public API and
receive an agent response.
For automated discovery, use the agent manifest. It
publishes the canonical guides, raw OpenAPI contract, environment variables,
and stop conditions. The manifest is the source for the generated
agent index and LLM index.
What you can build
Choose the path that matches the host application:
| Need | Use |
|---|---|
| A web, mobile, or backend application needs a synchronous agent reply | POST /v1/channels/http/messages |
| The agent needs approved live data or actions from the host application | Self-service business capabilities |
The HTTP channel currently accepts text messages.
Access boundary
Before integrating, ask the Forgium administrator for this access bundle for
the target environment:
FORGIUM_AGENT_BASE_URL=https://<public-api-host>
FORGIUM_AGENT_API_KEY=mg_xxx
Use the key only with the Public API (/v1/*). If it is missing or rejected,
ask the administrator for help.
Recommended reading order
For an agent:
- Use Forgium Agent with an agent — decision protocol.
- Environments — keep environments isolated.
- Request access — obtain and validate the bundle when needed.
- Contract retrieval — download and validate the raw
contract if an agent cannot discover it through navigation. - Authentication — API-key rules.
- Read Getting started for the HTTP quickstart, or
Self-service business capabilities when the host
application must provide live data or actions. - Use the OpenAPI contract for exact request and response
fields. For a server-side HTTP adapter, see HTTP integration reference.
For a manual integration, start at Getting started.