# API Reference — Five SDK

Locate the Five SDK APIs used by each task and distinguish browser SDK methods from server OpenAPI endpoints.

Canonical: https://developer.realsee.ai/docs/five-sdk/api-reference
Source: https://developer.realsee.ai/docs/five-sdk/api-reference.md
Language: en

[Download examples](https://developer.realsee.ai/starters/react-five/1.3.0/starter.zip)

This API map lists the exported Five SDK types and methods used by each guide.

## Find the relevant surface

| Capability | Public surface | Guide |
| --- | --- | --- |
| Work lifecycle | `Five`, `parseWork`, `appendTo`, `load`, `refresh`, `dispose` | [Load a scene](https://developer.realsee.ai/docs/five-sdk/load-a-scene) |
| View modes | `Mode`, `changeMode`, `currentMode`, `mode.change` | [Camera and modes](https://developer.realsee.ai/docs/five-sdk/camera-and-modes#switch-the-mode) |
| Viewpoints and pose | `Pano`, `Pose`, `observers`, `moveToPano`, `updateCamera` | [Navigate](https://developer.realsee.ai/docs/five-sdk/camera-and-modes#navigate-to-an-actual-viewpoint) |
| Save and restore | `State`, `getCurrentState`, `setState` | [Saved views](https://developer.realsee.ai/docs/five-sdk/camera-and-modes#save-and-restore-a-view) |
| Spatial interaction | `gesture.tap`, `model.intersectRaycaster`, `project2d` | [Events and coordinates](https://developer.realsee.ai/docs/five-sdk/events-and-coordinates) |
| Image export | `getSize`, `getPixels` | [Capture an image](https://developer.realsee.ai/docs/five-sdk/capture-images) |
| Asset feedback | `works.ready`, `pano.texture.*`, `models.load`, `models.refined`, `model.error` | [Loading stages](https://developer.realsee.ai/docs/five-sdk/load-a-scene#observe-the-relevant-loading-stage) |

In version 6.9.2, `five.on(...)` returns an unsubscribe function. Keep it and call it at teardown. Use the event names and payloads documented for your SDK version.

## Read the fixed-version package

- [Public declaration entry](https://unpkg.com/@realsee/five@6.9.2/five/index.d.ts).
- [Package file browser](https://unpkg.com/browse/@realsee/five@6.9.2/).
- [Package AI documentation index](https://unpkg.com/@realsee/five@6.9.2/llms.txt).

Use declarations for argument and return types, then inspect the implementation and run the example for behavior. Package AI guides can contain naming mistakes; a copied event name is not a contract test.

## Browser SDK and server APIs

Five SDK renders Work in the browser. [OpenAPI](https://developer.realsee.ai/docs/open-api) retrieves Team data and performs server-side operations using Developer app credentials. Endpoint-level contracts remain in the [API reference](https://developer.realsee.ai/api-reference). The browser SDK does not replace authentication or authorize a Team resource.