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:

NeedUse
A web, mobile, or backend application needs a synchronous agent replyPOST /v1/channels/http/messages
The agent needs live data or a host-owned operation preparation resultCapability quickstart
The account needs shared response instructions or topic scopeAgent policy
The account needs to find unresolved requests and capability gapsCapability-gap diagnostics

The HTTP channel accepts text-only JSON messages and one optional binary image

through multipart/form-data. Use the payload part for the JSON request and

the image part for a single JPEG, PNG, or WebP file up to 4 MiB; public

base64 image fields are not supported.

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:

  1. Use Forgium Agent with an agent — decision protocol.
  2. Environments — keep environments isolated.
  3. Request access — obtain and validate the bundle when needed.
  4. Contract retrieval — download and validate the raw
    contract if an agent cannot discover it through navigation.
  5. Authentication — API-key rules.
  6. Read Getting started for the HTTP quickstart, or
    Self-service business capabilities when the host
    application must provide live data or prepare a host-owned operation.
  7. Read Configure an agent policy when shared response
    instructions or best-effort topic scope are required.
  8. Read Capability-gap diagnostics when the account wants to
    identify unsupported requests and prioritize new capabilities.
  9. 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.