Skip to main content
Entities are the core publishable assets on the platform. An entity can be an app, a service, or a chat extension. Each entity has metadata, versions, publishers, and sharing controls.

​
Create entity

Returns the created entity with storage configuration. Authentication: User authentication + entities:publish scope.

​
Get entity

Returns entity details including the active version, all versions, and storage configuration. Authentication: Entity access required (publisher, shared user, or store publication access).

​
Update entity

Authentication: Entity access + publisher role required.

​
Delete entity

Deletes the entity and all associated versions, shares, and publications. Version packages are removed from storage. Authentication: Entity access + publisher role required.

​
Get entity details

Returns comprehensive entity information including full version history and metadata. Authentication: Entity access required.

​
Icon upload

Returns a signed upload URL and the storage path to use when creating or updating the entity. Authentication: User authentication + entities:publish scope.

​
Entity types

All entity types share the same lifecycle: create → push versions → set active → share or publish → deploy (apps only).