# @forge/api

> Forge API methods

Latest version **8.5.0** (published 2026-11-09) · SEE LICENSE IN LICENSE.txt license · 0 weekly downloads

## Install

```sh
npm install @forge/api
pnpm add @forge/api
yarn add @forge/api
bun add @forge/api
```

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 8.5.0 |
| Published | 2026-11-09 |
| First published | 2019-11-18 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE.txt |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 176.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Atlassian |
| Maintainers | atlassianartifactteam |

## Links

- npm: https://www.npmjs.com/package/@forge/api
- npm.io page: https://npm.io/package/@forge/api

## Dependencies (6)

- [@forge/auth](https://npm.io/package/@forge/auth.md) 1.0.0
- [@forge/i18n](https://npm.io/package/@forge/i18n.md) 1.0.1
- [@forge/util](https://npm.io/package/@forge/util.md) 4.0.0
- [@forge/egress](https://npm.io/package/@forge/egress.md) 3.0.1
- [headers-utils](https://npm.io/package/headers-utils.md) ^3.0.2
- [@forge/manifest](https://npm.io/package/@forge/manifest.md) ^13.9.0

## Recent versions

- 8.5.0 (latest) — 2026-11-09
- 8.5.1-next.2-experimental-ea0dc44 (experimental) — 2026-11-19
- 8.5.1-next.2 (next) — 2026-11-12
- 8.5.1-next.2-experimental-aab0b34 — 2026-11-19
- 8.5.1-next.2-experimental-f59888d — 2026-11-18
- 8.5.1-next.2-experimental-55abb77 — 2026-11-18
- 8.5.1-next.2-experimental-c04e853 — 2026-11-17
- 8.5.1-next.2-experimental-a5f8a43 — 2026-11-16
- 8.5.1-next.1 — 2026-11-11
- 8.5.1-next.0 — 2026-11-11
- 8.5.0-next.4 — 2026-11-05
- 8.5.0-next.3 — 2026-11-04
- 8.4.1-next.1-experimental-1e95696 — 2026-11-01
- 8.4.1-next.2 — 2026-10-29
- 8.4.1-next.1-experimental-65945d2 — 2026-10-28
- … 658 more at https://npm.io/package/@forge/api/versions

## README

# Forge API

API methods exposed during runtime in Forge apps. These include methods to simplify common actions such as making 
REST requests to Atlassian products.

## Requirements

See [Set up Forge](https://developer.atlassian.com/platform/forge/set-up-forge/) for details of the software required to develop Forge apps.

## Usage

In your Forge app, include the following:

```

import api from '@forge/api';

```

See [Runtime API reference](https://developer.atlassian.com/platform/forge/runtime-api-reference/) for details of the methods available and how to use them.

## Support

See [Get help](https://developer.atlassian.com/platform/forge/get-help/) for how to get help and provide feedback.

---
_Source: https://npm.io/package/@forge/api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
