Skip to main content
FiveMesh Voice API endpoints are not public yet. This page describes the planned surface for server-side integrations that need to inspect or operate managed PMA-Voice compatible instances for registered FiveM servers.
Use the dashboard for Voice setup and operations until public Voice API endpoints are released.

​
Common operations

OperationDescription
Read Voice stateInspect whether a registered server has a Voice instance.
Read regionsList regions that can accept new Voice instances.
Create instanceProvision a Voice instance for a registered server and region.
Restart instanceRequest a restart for an existing instance.
Delete instanceRemove an instance that should no longer serve the registered server.
Read setup configRetrieve the endpoint, port and PMA-Voice settings for server configuration.

​
Server ownership

Voice operations require access to the workspace that owns the registered cfx.re server. If a server belongs to an organization workspace, create the service key in the organization resource context and grant only the Voice permissions the automation needs when public API access becomes available.