Fusion Help API
Use when a developer or admin needs to interact directly with the Fusion Help REST API — reading help content, building custom tooling, or automating content management.
When to use
- Display help articles, FAQs, or release notes inside a Fusion app
- Build custom CLI or automation to manage help content
- Programmatically create, update, or delete help documentation
- Search or suggest help content from an application
- Understand Help API endpoints, authentication, or data models
- Read help content for another system
When not to use
- Using
fhelp CLI to sync markdown docs → use fusion-help-docs
- Modifying Fusion.Services.Help backend service code
- General REST API questions unrelated to Help
Required inputs
| Input |
Required |
Description |
| Use case |
Yes |
Reading content, managing content, or searching |
| App key |
For scoped queries |
The Fusion app key to read/manage help for |
| Target environment |
Yes |
ci, fqa, tr, or fprd |
| Auth context |
Yes |
User token (interactive) or service principal (automation) |
Instructions
1. Discover the Help API base URL
Resolve URL dynamically or use known patterns:
| Environment |
Base URL |
ci |
https://help.ci.api.fusion-dev.net |
fqa |
https://help.fqa.api.fusion-dev.net |
fprd |
https://help.api.fusion.equinor.com |
Dynamic discovery (recommended for production tooling):
GET https://discovery.fusion.equinor.com/service-registry/environments/{env}/services
Look for the service with key: "help" in the response. Use the uri field as the base URL.
2. Authentication
All endpoints require a valid Azure AD bearer token. Token audiences and code samples for frontend, backend, and CLI are in references/authentication.md.
Quick reference — token audiences:
| Environment |
Resource ID (audience) |
ci, fqa, tr |
5a842df8-3238-415d-b168-9f16a6a6031b/.default |
fprd |
97978493-9777-4d48-b38a-67b0b9cd88d2/.default |
3. Authorization levels
| Action |
Who can do it |
| Read articles, FAQs, release notes, search |
Any authenticated Fusion user |
| Create / Update / Delete articles, FAQs, release notes |
App admin, trusted app, or Fusion.Help.FullControl |
| Upload assets (images) |
App admin, trusted app, or Fusion.Help.FullControl |
| View changelog (global) |
Fusion.Help.FullControl only |
| View changelog (per app) |
App admin or Fusion.Help.FullControl |
4. Call the API
Endpoints are versioned — include ?api-version=1.0. Resources: Articles, FAQs, Release Notes, Assets, Search/Suggest, Changelog.
For full CRUD details, request/response bodies, OData filters, and validation rules see references/api-endpoints.md.
For compact endpoint matrix and OData cheat sheet see references/api-quick-reference.md.
For response model schemas see references/response-models.md.
5. Integration patterns
Ready-to-use code samples (React component, release notes banner, FAQ search, C# backend automation, Python scripting) are in references/integration-patterns.md.
Expected output
- Working code to authenticate and call the Help API
- Correct endpoint URLs and query parameters for the use case
- Understanding of response models and OData query options
- For admin use cases: correct request bodies for create/update/delete
- For integration patterns: sample code in the relevant language/framework
Safety & constraints
- Read-only endpoints are safe for any authenticated user — no admin permissions needed
- Write operations require app admin, trusted application, or
Fusion.Help.FullControl
- Deleted articles/FAQs/release notes are soft-deleted — slugs cannot be reused
sourceSystem tracks which tool created a record — mixing source systems for the same slug causes fhelp CLI to refuse updates (unless --no-validation is used)- Always test against
ci before targeting fprd
- Never hardcode bearer tokens — use
DefaultAzureCredential or equivalent
- Image uploads must be PNG; API processes them into WebP for serving
1---2name: fusion-help-api3description: Guides developers and admins through direct interaction with the Fusion Help REST API — reading articles, FAQs, release notes, searching content, and managing help documentation programmatically. USE FOR: fetch help articles from API, integrate help content in app, search help content, manage help documentation via API, automate help content, build help tooling. DO NOT USE FOR: using the fhelp CLI tool (use fusion-help-docs skill), modifying Fusion.Services.Help backend code, or non-help-API tasks.4license: MIT5---67# Fusion Help API89Use when a developer or admin needs to interact directly with the Fusion Help REST API — reading help content, building custom tooling, or automating content management.1011## When to use1213- Display help articles, FAQs, or release notes inside a Fusion app14- Build custom CLI or automation to manage help content15- Programmatically create, update, or delete help documentation16- Search or suggest help content from an application17- Understand Help API endpoints, authentication, or data models18- Read help content for another system1920## When not to use2122- Using `fhelp` CLI to sync markdown docs → use `fusion-help-docs`23- Modifying Fusion.Services.Help backend service code24- General REST API questions unrelated to Help2526## Required inputs2728| Input | Required | Description |29|-------|----------|-------------|30| **Use case** | Yes | Reading content, managing content, or searching |31| **App key** | For scoped queries | The Fusion app key to read/manage help for |32| **Target environment** | Yes | `ci`, `fqa`, `tr`, or `fprd` |33| **Auth context** | Yes | User token (interactive) or service principal (automation) |3435## Instructions3637### 1. Discover the Help API base URL3839Resolve URL dynamically or use known patterns:4041| Environment | Base URL |42|-------------|----------|43| `ci` | `https://help.ci.api.fusion-dev.net` |44| `fqa` | `https://help.fqa.api.fusion-dev.net` |45| `fprd` | `https://help.api.fusion.equinor.com` |4647**Dynamic discovery** (recommended for production tooling):4849```50GET https://discovery.fusion.equinor.com/service-registry/environments/{env}/services51```5253Look for the service with `key: "help"` in the response. Use the `uri` field as the base URL.5455### 2. Authentication5657All endpoints require a valid Azure AD bearer token. Token audiences and code samples for frontend, backend, and CLI are in [references/authentication.md](references/authentication.md).5859Quick reference — token audiences:6061| Environment | Resource ID (audience) |62|-------------|----------------------|63| `ci`, `fqa`, `tr` | `5a842df8-3238-415d-b168-9f16a6a6031b/.default` |64| `fprd` | `97978493-9777-4d48-b38a-67b0b9cd88d2/.default` |6566### 3. Authorization levels6768| Action | Who can do it |69|--------|---------------|70| **Read** articles, FAQs, release notes, search | Any authenticated Fusion user |71| **Create / Update / Delete** articles, FAQs, release notes | App admin, trusted app, or `Fusion.Help.FullControl` |72| **Upload assets** (images) | App admin, trusted app, or `Fusion.Help.FullControl` |73| **View changelog** (global) | `Fusion.Help.FullControl` only |74| **View changelog** (per app) | App admin or `Fusion.Help.FullControl` |7576### 4. Call the API7778Endpoints are versioned — include `?api-version=1.0`. Resources: **Articles**, **FAQs**, **Release Notes**, **Assets**, **Search/Suggest**, **Changelog**.7980For full CRUD details, request/response bodies, OData filters, and validation rules see [references/api-endpoints.md](references/api-endpoints.md).8182For compact endpoint matrix and OData cheat sheet see [references/api-quick-reference.md](references/api-quick-reference.md).8384For response model schemas see [references/response-models.md](references/response-models.md).8586### 5. Integration patterns8788Ready-to-use code samples (React component, release notes banner, FAQ search, C# backend automation, Python scripting) are in [references/integration-patterns.md](references/integration-patterns.md).8990## Expected output9192- Working code to authenticate and call the Help API93- Correct endpoint URLs and query parameters for the use case94- Understanding of response models and OData query options95- For admin use cases: correct request bodies for create/update/delete96- For integration patterns: sample code in the relevant language/framework9798## Safety & constraints99100- Read-only endpoints are safe for any authenticated user — no admin permissions needed101- Write operations require app admin, trusted application, or `Fusion.Help.FullControl`102- Deleted articles/FAQs/release notes are **soft-deleted** — slugs cannot be reused103- `sourceSystem` tracks which tool created a record — mixing source systems for the same slug causes `fhelp` CLI to refuse updates (unless `--no-validation` is used)104- Always test against `ci` before targeting `fprd`105- Never hardcode bearer tokens — use `DefaultAzureCredential` or equivalent106- Image uploads must be PNG; API processes them into WebP for serving
equinor