{ "openapi": "3.0.0", "info": { "title": "WhatsApp API", "description": "API Wrapper for WhatsAppWebJS - Rotas de Usuário (Bearer Token)", "version": "1.0.0" }, "host": "", "tags": [ { "name": "Health", "description": "Health check and system status endpoints" }, { "name": "Auth", "description": "Authentication and user management endpoints" }, { "name": "Session", "description": "Handling multiple sessions logic, creation and deletion" }, { "name": "Client", "description": "All functions related to the client" }, { "name": "Message", "description": "May fail if the message is too old (Only from the last 100 Messages of the given chat)" }, { "name": "Chat", "description": "Chat management and operations" }, { "name": "Group Chat", "description": "Group chat management and operations" }, { "name": "Contact", "description": "Contact management and operations" } ], "paths": { "/ping": { "get": { "tags": [ "Health" ], "description": "", "parameters": [], "responses": {} } }, "/test-qr": { "get": { "tags": [ "Health" ], "description": "", "parameters": [], "responses": {} } }, "/test-qr-auth": { "get": { "tags": [ "Health" ], "description": "", "parameters": [], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/cache/status": { "get": { "tags": [ "Health" ], "description": "", "parameters": [], "responses": {} } }, "/cache/clear": { "post": { "tags": [ "Health" ], "description": "", "parameters": [], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/database/status": { "get": { "tags": [ "Health" ], "description": "", "parameters": [], "responses": {} } }, "/localCallbackExample": { "post": { "tags": [ "Health" ], "description": "", "parameters": [], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/session/start/{sessionId}": { "get": { "tags": [ "Session" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/session/status/{sessionId}": { "get": { "tags": [ "Session" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/session/qr/{sessionId}": { "get": { "tags": [ "Session" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/session/qr/{sessionId}/image": { "get": { "tags": [ "Session" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/session/terminate/{sessionId}": { "get": { "tags": [ "Session" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/session/terminateInactive": { "get": { "tags": [ "Session" ], "description": "", "parameters": [], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/session/terminateAll": { "get": { "tags": [ "Session" ], "description": "", "parameters": [], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getClassInfo/{sessionId}": { "get": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/acceptInvite/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/archiveChat/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/createGroup/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getBlockedContacts/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getChatById/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getChatLabels/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getChats/{sessionId}": { "get": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getChatsByLabelId/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getCommonGroups/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getContactById/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getContacts/{sessionId}": { "get": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getInviteInfo/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getLabelById/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getLabels/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getNumberId/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/isRegisteredUser/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getProfilePicUrl/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getState/{sessionId}": { "get": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/markChatUnread/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/muteChat/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/pinChat/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/searchMessages/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/sendMessage/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/sendPresenceAvailable/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/sendPresenceUnavailable/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/sendSeen/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/setDisplayName/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/setProfilePicture/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/setStatus/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/unarchiveChat/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/unmuteChat/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/unpinChat/{sessionId}": { "post": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/client/getWWebVersion/{sessionId}": { "get": { "tags": [ "Client" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/chat/getClassInfo/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/chat/clearMessages/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/chat/clearState/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/chat/delete/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/chat/fetchMessages/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/chat/getContact/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/chat/sendStateRecording/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/chat/sendStateTyping/{sessionId}": { "post": { "tags": [ "Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/groupChat/getClassInfo/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/groupChat/addParticipants/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/groupChat/demoteParticipants/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/groupChat/getInviteCode/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/groupChat/leave/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/groupChat/promoteParticipants/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/groupChat/removeParticipants/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/groupChat/revokeInvite/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/groupChat/setDescription/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/groupChat/setInfoAdminsOnly/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/groupChat/setMessagesAdminsOnly/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/groupChat/setSubject/{sessionId}": { "post": { "tags": [ "Group Chat" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/message/getClassInfo/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/message/delete/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/message/downloadMedia/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/message/forward/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/message/getInfo/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/message/getMentions/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/message/getOrder/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/message/getPayment/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/message/getQuotedMessage/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/message/react/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/message/reply/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/message/star/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/message/unstar/{sessionId}": { "post": { "tags": [ "Message" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/contact/getClassInfo/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/contact/block/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/contact/getAbout/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/contact/getChat/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/contact/unblock/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/contact/getFormattedNumber/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/contact/getCountryCode/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } }, "/contact/getProfilePicUrl/{sessionId}": { "post": { "tags": [ "Contact" ], "description": "", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": {}, "security": [ { "bearerAuth": [] } ] } } }, "components": { "schemas": { "StartSessionResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Session initiated successfully" } } }, "StatusSessionResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "state": { "type": "string", "example": "CONNECTED" }, "message": { "type": "string", "example": "session_connected" } } }, "TerminateSessionResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Logged out successfully" } } }, "TerminateSessionsResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Flush completed successfully" } } }, "ErrorResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "Some server error" } } }, "NotFoundResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "Some server error" } } }, "ForbiddenResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "Invalid API key" } } }, "UnauthorizedResponse": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "Unauthorized - Invalid or missing authentication token" } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }