Manifest

App manifest is a JSON object that describes the app. It should have the following structure:

name

Display name of the app.

slug

Unique, human-readable identifier of the app.

description

Description of the app.

image

URL of the app icon.

endpoint

Base URL of the app.

wantsPage

Whether the app intends to display a dedicated page.

wantsRefresh

Whether the app wants to be polled for new UI updates.

hotkey

Ctrl+ hotkey to open the app page. Will be ignored if wantsPage is false.

functions

An object containing functions that the AI can call, with the following structure:

  • Name
    type
    Type
    "function"
    Description

    Required field. Should always be "function".

  • Name
    description
    Type
    string
    Description

    Description of the function.

  • Name
    parameters
    Type
    Parameters
    Description

    An object containing parameters that the function accepts:

    • Name
      type
      Type
      "object"
      Description

      Required field. Should always be "object".

    • Name
      properties
      Type
      Properties
      Description

      An object containing properties that the parameter accepts:

      • Name
        type
        Type
        "string" | "number" | "boolean" | "array"
        Description

        Property type

      • Name
        description
        Type
        string
        Description

        Description of the parameter.

    • Name
      required
      Type
      string[]
      Description

      An array of required parameters.

Was this page helpful?