Overview

This component documents the backend Symbol Management module. It is separate from the viewer `symbolsControl` placement API.

Use these routes when your application needs to create folders, upload symbols, edit symbol metadata, or maintain the library that placement experiences consume later.

• Separate from placement control: this is library management, not viewer panel open or close behavior.
• Folder based: symbols are grouped under folders and loaded by folder ID.
• End-user admin flow: create, update, delete, and inspect symbols before they are used in placement workflows.
• Auth header: protected integrations send `x-api-key` with every Symbol Management request.
• Base URL example: `http://localhost:5203/api`

Protected Symbol Management routes require a client API key before folders or symbols can be loaded from the backend.

Complete API Key Management setup first if your implementation does not yet have a client key or a defined process for issuing `x-api-key` credentials.

• Implementation prerequisite: review API Key Management Overview before wiring protected Symbol Management routes.
• Admin route reference: use API Key Management REST API for issuing and maintaining client keys.

Choose the page below based on the part of the workflow you are implementing.

• Use Folders when the user needs to create, rename, list, or delete symbol folders.
• Use Symbols when the user needs to upload, edit, move, or remove symbol records.
• Use REST API when you need the combined route list, payload contracts, and backend status expectations.

The client should keep the library workflow predictable and refresh the affected list after every mutation.

• Load folders first: fetch the folder collection before folder-specific symbol requests.
• Load symbols by folder ID: fetch symbols only after a valid folder ID is available.
• Send `x-api-key` on every call: include the client API key in the request headers for folders and symbols routes.
• Refresh after mutations: reload the changed folder list or symbols list after create, update, or delete.
• Show server messages: surface backend message text directly in client-side error handling.
• Upload from the computer: convert files to base64 content and serialize the symbol `data` field before save.

Use the pages below as the main reference for implementation details.