For the complete documentation index, see llms.txt. This page is also available as Markdown.

Extension

The Extension object represents a set of requirements (parameters) that vendors ask their clients to meet. Think of it as a checklist (extension parameters) that ensures clients are ready and able to work with the vendor’s products or services.

Field
Type
Description

id

string, core

(Read-only) The identifier for the extension.

name

string, core

The name of the extension.

website

URI

(Optional) URL for the extension website.

icon

string, core

The logo of the extension.

shortDescription

string

(Optional) A short description of the extension.

longDescription

string

(Optional) A long description of the extension.

categories

object

Represents the category object, which contains a list of selected categories.

vendor

object

Represents the vendor account object.

status

enum

The status of the extension. Allowed values are:

  • Draft

  • Deleted - Can be deleted if it's in a draft state.

  • Public - Available in the extensions directory. Only an Operations user can make the extension public.

  • Private - Not available in the extensions directory, but can be accessed through an invitation.

statistics

object

(Read-only) Represents the extensionStatistics object.

configuration

object

Represents the configuration object. Available only if retrieved with the extension’s token or vendor token.

service

object

Represents the service object.

meta

object

(Read-only) (Optional) Represents the extensionMeta object.

audit

object

Represents the audit object.

Extension Statistics object

Field
Type
Description

installations

integer

(Read-only) Number of installations assigned to the extension.

Service object

Field
Type
Description

secret

string

Represents the secret key.

Example

Last updated

Was this helpful?