Edge API and Integrations
Connect clients and integrations to your Edge instance
Table of Contents
About this guide
Applications can use the API exposed by your Edge deployment. Start with the API documentation for the installed release, then configure the client with your Edge address and credentials.
Use the correct instance
The standard Edge API origin is https://api.edge.asksage.ai. An organization may replace it with its own hostname. API paths are appended to that origin; the API origin alone is not always the base URL an SDK expects.
For example, where the installed release supports the OpenAI-compatible API:
| Setting | Standard Edge example |
|---|---|
| API origin | https://api.edge.asksage.ai |
| OpenAI-compatible base URL | https://api.edge.asksage.ai/server/openai/v1 |
| Chat completions endpoint | https://api.edge.asksage.ai/server/openai/v1/chat/completions |
Use these as address examples, not as confirmation that every compatibility endpoint is present on every Edge release. The workstation or application running the client must resolve the hostname, reach the deployment, and trust its certificate.
Connect a client
- Obtain the API address and supported endpoint family from your administrator.
- Create or obtain the appropriate Ask Sage API credential for this Edge instance using the supported account process.
- Configure the client base URL and authentication exactly as required by the corresponding API guide.
- Select a model identifier returned by this deployment’s supported model-listing endpoint. Do not substitute a cloud catalog name or a display label unless the API lists it as the identifier.
- Send a short request with approved test content.
- Test additional capabilities separately, such as streaming, document context, images, or tools.
Manager login credentials, provider keys, and Ask Sage API credentials serve different purposes. Do not use a Manager password or a cloud-provider key as a substitute for an Ask Sage API credential.
API references
| Reference | Use it for |
|---|---|
| Ask Sage API | Authentication and the API overview. |
| API Endpoints | Native Ask Sage operations. |
| OpenAI Compatibility Guide | Supported compatible clients and request formats. |
| Python Client | Python integration patterns, with the appropriate Edge instance configuration. |
| Integrations | Tool-specific configuration and external dependencies. |
General examples may point to the cloud service and document features newer than your installed Edge release. Match the instance, endpoint, authentication method, and feature set before adapting an example.
Integrations in an isolated environment
A local model does not make an integration local. An editor, agent, MCP server, identity provider, or connector may still contact remote services. Review the full connection path before approving a workflow for an air-gapped site.
Use services available inside the approved network, stage required client software through the site’s process, and confirm that updates or authentication do not depend on a blocked destination. Requests using cloud inference follow the data-handling considerations in Local and cloud inference.
For failures, check the API origin and path, credential type, certificate trust, model readiness, and the installed release’s supported operations before changing server configuration.