LIlit-protocol
App

Edits an application

Changed on
put/app/{appId}

Request

  • Base URL
    https://api.heyvincent.ai
  • URL
    https://api.heyvincent.ai/app/{appId}
  • Auth
    API key in header Authorization

Path parameters

appIdnumber required

ID of the target application

Request body

namestring

The name of the application

descriptionstring

Description of the application

contactEmailstring email

Contact email for the application manager

appUrlstring uri

This should be a landing page for the app.

logostring

Base64 encoded logo image

deploymentStatus'dev' | 'test' | 'prod'

Identifies if an application is in development, test, or production.

activeVersionnumber

Active version of the application

Example request

{
  "name": "Memecoin DCA App",
  "description": "This is a memecoin DCA App.",
  "contactEmail": "contact@example.com",
  "appUrl": "https://myapplication.example.com/",
  "logo": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAIAAAACDbGyAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOvwAADr8BOAVTJAAAAA5JREFUGFdj/M+ACAAAAAD//wE7AnsAAAAAAElFTkSuQmCC",
  "deploymentStatus": "dev",
  "activeVersion": 1
}

Response

Successful operation

_idstring required

Document ID

updatedAtstring date-time required

Timestamp when this was last modified

createdAtstring date-time required

Timestamp when this was created

appIdnumber required

Application ID

activeVersionnumber

Active version of the application

namestring required

The name of the application

descriptionstring required

Description of the application

contactEmailstring email

Contact email for the application manager

appUrlstring uri

This should be a landing page for the app.

logostring

Base64 encoded logo image

deploymentStatus'dev' | 'test' | 'prod'

Identifies if an application is in development, test, or production.

managerAddressstring required

App manager's wallet address. Derived from the authorization signature provided by the creator.

isDeletedboolean

Whether or not this App is deleted

Example response

{
  "appId": 12345,
  "activeVersion": 1,
  "name": "Memecoin DCA App",
  "description": "This is a memecoin DCA App.",
  "contactEmail": "contact@example.com",
  "appUrl": "https://myapplication.example.com/",
  "logo": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAIAAAACDbGyAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOvwAADr8BOAVTJAAAAA5JREFUGFdj/M+ACAAAAAD//wE7AnsAAAAAAElFTkSuQmCC",
  "deploymentStatus": "dev",
  "managerAddress": "0x123456789012345678901234567890123456abcd"
}

Changes

  • 3a57afc3e1f4Revision changes
    • info

      the endpoint scheme security siweAuth was added to the API

    • info

      the endpoint scheme security bearerAuth was removed from the API

  • 52c665bbf407Revision changes
    • info

      the response required property became not read-only for the status