BLUEPIC - Graphic Designer

BLUEPIC - Graphic Designer · Acciones GPT

Bluepic GPT Bridge

Bluepic GPT Bridge API that simplifies the Bluepic API for the needs of GPT

  • GET /healthHealth Check

    Health Check

  • GET /templatesList Templates

    List all templates the user has access to

  • GET /variablesGet all variables of a given template

    Returns an array of variables of a specific template including their role, description and meta properties

  • POST /uploadUploads an image.
  • GET /exportTemplateRenders and exports a template

    Renders and exports a template by providing a template id and a set of variables

  • GET /suggestImageSuggests an image for a template by providing a single keyword

    Suggests an image for a template by providing a single keyword that describes the purpose of the image within the context of the template

  • GET /customTemplatesFolderGets the login url for connecting a custom templates folder with this open ai user

    Provides a login link for connecting a custom templates folder with the open ai user and if already connect one, the folder id too

Esquema original API
{
  "openapi": "3.0.0",
  "info": {
    "title": "Bluepic GPT Bridge",
    "description": "Bluepic GPT Bridge API that simplifies the Bluepic API for the needs of GPT",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://bluepic.app/"
    }
  ],
  "paths": {
    "/health": {
      "get": {
        "summary": "Health Check",
        "description": "Health Check",
        "operationId": "healthCheck",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "ok": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/templates": {
      "get": {
        "summary": "List Templates",
        "description": "List all templates the user has access to",
        "operationId": "listTemplates",
        "parameters": [
          {
            "name": "userPrompt",
            "in": "query",
            "description": "The user's prompt",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TemplatesOutput"
                }
              }
            }
          }
        }
      }
    },
    "/variables": {
      "get": {
        "summary": "Get all variables of a given template",
        "description": "Returns an array of variables of a specific template including their role, description and meta properties",
        "operationId": "getVariables",
        "parameters": [
          {
            "name": "templateId",
            "in": "query",
            "description": "The unique template id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Variable"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/upload": {
      "post": {
        "operationId": "uploadImage",
        "summary": "Uploads an image.",
        "parameters": [
          {
            "name": "imageUrl",
            "in": "query",
            "description": "The public accessible image source url",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Image uploaded successfully"
          },
          "400": {
            "description": "Invalid input"
          }
        }
      }
    },
    "/exportTemplate": {
      "get": {
        "summary": "Renders and exports a template",
        "description": "Renders and exports a template by providing a template id and a set of variables",
        "operationId": "exportTemplate",
        "parameters": [
          {
            "name": "templateId",
            "in": "query",
            "description": "Template ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "data",
            "in": "query",
            "description": "Template variables as JSON object",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExportTemplateResponse"
                }
              }
            }
          }
        }
      }
    },
    "/suggestImage": {
      "get": {
        "summary": "Suggests an image for a template by providing a single keyword",
        "description": "Suggests an image for a template by providing a single keyword that describes the purpose of the image within the context of the template",
        "operationId": "suggestImage",
        "parameters": [
          {
            "name": "keyword",
            "in": "query",
            "description": "Keyword that describes the purpose of the image within the context of the template. The keyword needs to be english!",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "Offset index for suggesting an image within given keyword results",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "imageSource": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/customTemplatesFolder": {
      "get": {
        "summary": "Gets the login url for connecting a custom templates folder with this open ai user",
        "description": "Provides a login link for connecting a custom templates folder with the open ai user and if already connect one, the folder id too",
        "operationId": "customTemplatesFolder",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "folderId": {
                      "type": "string"
                    },
                    "loginUrl": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ExportTemplateResponse": {
        "type": "object",
        "properties": {
          "imageSource": {
            "description": "Image source that shows the rendered graphic template as image",
            "type": "string"
          },
          "editPageUrl": {
            "description": "URL to Edit Page where the user can edit the template explicitly",
            "type": "string"
          }
        }
      },
      "UploadResponse": {
        "type": "object",
        "properties": {
          "image": {
            "type": "string"
          }
        }
      },
      "TemplatesOutput": {
        "type": "object",
        "properties": {
          "templates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Template"
            }
          },
          "total": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "Template": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "width": {
            "type": "integer",
            "format": "int64"
          },
          "height": {
            "type": "integer",
            "format": "int64"
          },
          "aiDescription": {
            "type": "string"
          }
        }
      },
      "Field": {
        "type": "object",
        "properties": {
          "datatype": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "aiDescription": {
            "type": "string"
          },
          "props": {
            "type": "object"
          },
          "model": {
            "type": "object"
          },
          "key": {
            "type": "string"
          }
        }
      },
      "Variable": {
        "type": "object",
        "properties": {
          "variableKey": {
            "type": "string"
          },
          "role": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "meta": {
            "type": "object"
          }
        }
      }
    }
  }
}