• Update History: Last Updated March 20, 2025 with ProtoPie Connect 2.9.8

Before getting started

• A valid ProtoPie Connect server needs to be up and running to use the Connect API
  • Either ProtoPie Connect Desktop or ProtoPie Connect Embedded needs to be running.
• There is no authentication required to make requests while using the API
• Previous API specs are available to use but will not be supported going forward.
  • Connect API (Deprecated)

Pies API Specs

Get Pie Information on ProtoPie Connect - GET /api/pies

• Action

  • Retrieves information about pies that have been loaded to ProtoPie Connect.

• Request

  • URL

    GET /api/pies HTTP/1.1
    Host: {CONNECT_SERVER_IP}:9981
    

  • Header

    • Not Required

  • Parameters

    • None

• Response

  • Responds with List<pies> in JSON format.

    pies

• Examples

Add/Replace Pies to ProtoPie Connect - POST /api/pies/add

• Action

  • Adds a new local pie to ProtoPie Connect.
  • Also can be used to replace an existing pie with a new local pie. For this, specify pieId of the existing Pie you want replace

• Request

  • URL

    POST /api/pies/add HTTP/1.1
    Host: {CONNECT_SERVER_IP}:9981
    

  • Header

    • Not Required

  • Parameters

    • Request body to include formdata.

    formdata

• Response

  • The response is of JSON format.
    • result: API call result
    • message: Message associated with
    • data: JSON about pie added