Social Media Manager [Updated]
Social Media Manager [Updated] ยท GPT ใขใฏใทใงใณ
GPT Companion
POST /api/gpt/getGuidesEndpoint to get guides to create diagramPOST /api/gpt/renderDiagrampost_RenderDiagramPOST /api/gpt/getExamplesForUserAn endpoint to show the user which charts we can build.
ๅ ใฎ API ในใญใผใ
{
"openapi": "3.1.0",
"info": {
"title": "GPT Companion",
"version": "1.0"
},
"servers": [
{
"url": "https://www.blocksandarrows.com",
"description": "Development server"
}
],
"components": {
"schemas": {},
"parameters": {}
},
"paths": {
"/api/gpt/getGuides": {
"post": {
"summary": "Endpoint to get guides to create diagram",
"x-openai-isConsequential": false,
"operationId": "post_GetGuides",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"graph",
"class",
"sequence",
"mindmap",
"timeline",
"entity-relationship",
"pie-chart",
"database"
],
"description": "Type of the diagram",
"example": "graph"
}
},
"required": [
"type"
]
}
}
}
},
"responses": {
"200": {
"description": "Guides for creating this type of diagrams",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"guide": {
"type": "string"
}
},
"required": [
"guide"
]
}
}
}
}
}
}
},
"/api/gpt/renderDiagram": {
"post": {
"summary": "",
"x-openai-isConsequential": false,
"operationId": "post_RenderDiagram",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"graph",
"class",
"sequence",
"mindmap",
"timeline",
"entity-relationship",
"pie-chart",
"database"
],
"description": "Type of the diagram",
"example": "graph"
},
"diagramString": {
"type": "string",
"description": "The string for the chart rendering"
},
"documentName": {
"type": "string",
"description": "The name of the document in which the diagram will be placed"
},
"diagramTags": {
"type": "string",
"description": "For your diagram, include a total of 10 tags, written with commas in between. The first tag should be the primary one, characterizing the overall purpose of the diagram, such as #SMS for a social media marketing diagram or #Database for a database structure. The subsequent tags should provide additional details about the content, tools, focus, and key elements of the diagram, enhancing its searchability and identification.",
"example": "#Database, #DataModeling, #ERDiagram, #SQL, #Normalization, #DataStructure, #SchemaDesign, #RelationalDB, #DataIntegrity, #QueryOptimization"
},
"isContainsPrivateInfo": {
"type": "boolean",
"description": "If you notice the user input includes personal details such as their full name, email address, phone number, home address, company name, or any other identifiable information, then set this flag to true."
}
},
"required": [
"type",
"diagramString",
"documentName",
"diagramTags",
"isContainsPrivateInfo"
]
}
}
}
},
"responses": {
"200": {
"description": "Diagram successfully rendered",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"answer": {
"type": "string",
"description": "Answer with image and url to edit. You should not change the response text, only insert data such as descriptions"
}
},
"required": [
"answer"
]
}
}
}
},
"422": {
"description": "Error while rendering the diagram",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorMessage": {
"type": "string"
}
},
"required": [
"errorMessage"
]
}
}
}
}
}
}
},
"/api/gpt/getExamplesForUser": {
"post": {
"summary": "An endpoint to show the user which charts we can build.",
"x-openai-isConsequential": false,
"operationId": "post_GetExamplesForUser",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"responses": {
"200": {
"description": "An answer with examples of diagrams that you should provide",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"answer": {
"type": "string"
}
},
"required": [
"answer"
]
}
}
}
}
}
}
}
},
"webhooks": {}
}