Reading this with an AI agent?

Read this page as plain text instead: https://www.nianticspatial.com/docs/llms-api-swift/NSDK.NSDKVps2Session.method-anchorPayload.txt — same content, easier to parse than this HTML, with each platform's steps kept separate.

Every page in the current release follows the same pattern, so you can build the URL directly instead of fetching an index: a page at /api/swift/<page>/ is at /llms-api-swift/<page>.txt.

For every page in this section, read https://www.nianticspatial.com/docs/llms-api-swift.txt; for every section of these docs, read https://www.nianticspatial.com/docs/llms.txt.

←API Reference ←NSDK ←NSDKVps2Session

anchorPayload

Declaration

func anchorPayload(anchorId: NSDKVpsAnchorId) -> NSDKAsyncState<String, Never>?

Summary

Gets the payload data of a specified anchor.
The payload encodes the data needed to relocalize an anchor across devices or sessions.
It can be stored and used later with trackAnchor(payload:).
For anchors created via createAnchor(at:), subscribe to createdAnchorPayload
instead of polling this method — the session handles polling automatically.
- Precondition: anchorId must be exactly 32 characters long.

Returns

.inProgress(nil): The anchor is tracked but the payload is not yet available.
- .success(payload): The base64-encoded payload is ready.
- nil: No anchor with anchorId was found.

Parameters

Name	Type	Summary
anchorId	NSDKVpsAnchorId	The unique identifier of the anchor.

Method anchorPayload anchorPayload

Declaration​

Summary​

Returns​

Parameters​

anchorPayload

Declaration

Summary

Returns

Parameters