Sales Lead Assistant
Sales Lead Assistant · Ações GPT
AISynthMind Service API
API for interacting with AISynthMind services.
GET /oauth/getUserInfoGet user informationRetrieve user information. No request parameters required.
POST /oauth/runTaskInitiate a leads search taskInitiate an asynchronous lead search task that takes more than 5 minutes to execute and requires polling the getTaskResult endpoint to retrieve results.
POST /oauth/getTaskResultRetrieve the results of the leads search task.Retrieve the results of the leads search task submitted through the runTask interface.
Esquema API original
{
"openapi": "3.0.0",
"info": {
"title": "AISynthMind Service API",
"description": "API for interacting with AISynthMind services.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://service.synthmind.app",
"description": "Main AISynthMind Service API server"
}
],
"paths": {
"/oauth/getUserInfo": {
"get": {
"operationId": "getUserInfo",
"summary": "Get user information",
"description": "Retrieve user information. No request parameters required.",
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resCode": {
"type": "string",
"description": "Response code indicating success or failure."
},
"msg": {
"type": "string",
"description": "Message providing additional information about the response."
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true,
"description": "User ID if available, otherwise null."
}
}
},
"pageData": {
"type": "object",
"nullable": true,
"description": "Additional paginated data if available, otherwise null."
}
}
},
"examples": {
"successExample": {
"value": {
"resCode": "200",
"msg": "success",
"data": {
"id": null
},
"pageData": null
}
},
"failureExample": {
"value": {
"resCode": "403",
"msg": "Authentication required",
"data": null,
"pageData": null
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/AuthError"
},
"default": {
"$ref": "#/components/responses/ErrorResponse"
}
}
}
},
"/oauth/runTask": {
"post": {
"operationId": "initiateLeadsTask",
"summary": "Initiate a leads search task",
"x-openai-isConsequential": false,
"description": "Initiate an asynchronous lead search task that takes more than 5 minutes to execute and requires polling the getTaskResult endpoint to retrieve results.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"leadsNumber": {
"type": "integer",
"description": "The number of leads to search for."
},
"position": {
"type": "string",
"description": "The job position for the lead search, e.g., \"Data entry\"."
},
"searchRequirement": {
"type": "string",
"description": "Detailed criteria for the lead search, such as \"Remote, part-time data entry positions in the non-profit organization management industry with no specific scale or location preference\"."
},
"searchPurpose": {
"type": "string",
"description": "The purpose of the search, for example, \"Finding client leads for remote, part-time data entry work within the non-profit sector\"."
},
"userInformation": {
"type": "string",
"description": "Additional information about the user initiating the search, if any."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Request successful, but need to check resCode to determine the operation result",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resCode": {
"type": "string"
},
"msg": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"taskId": {
"type": "string",
"description": "task Id."
},
"status": {
"type": "string",
"description": "The status of the task."
},
"userId": {
"type": "string",
"description": "User ID associated with the task."
},
"resultUrl": {
"type": "string",
"format": "uri",
"description": "URL to the generated report table which can be viewed by opening in a new page."
}
}
},
"pageData": {
"type": "string"
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/AuthError"
},
"7113": {
"description": "Insufficient account balance, please log in to https://synthmind.app to recharge.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resCode": {
"type": "string"
},
"msg": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"taskId": {
"type": "string",
"description": "task Id."
},
"status": {
"type": "string",
"description": "The status of the task."
},
"userId": {
"type": "string",
"description": "User ID associated with the task."
},
"resultUrl": {
"type": "string",
"format": "uri",
"description": "URL to the generated report table which can be viewed by opening in a new page."
}
}
},
"pageData": {
"type": "string"
}
}
}
}
}
},
"default": {
"$ref": "#/components/responses/ErrorResponse"
}
}
}
},
"/oauth/getTaskResult": {
"post": {
"operationId": "getLeadsTaskResult",
"summary": "Retrieve the results of the leads search task.",
"x-openai-isConsequential": false,
"description": "Retrieve the results of the leads search task submitted through the runTask interface.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the leads search task."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Request successful, but need to check resCode to determine the operation result",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resCode": {
"type": "string"
},
"msg": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"resultUrl": {
"type": "string",
"format": "uri",
"description": "URL to the generated report table which can be viewed by opening in a new page."
}
}
},
"pageData": {
"type": "string"
}
}
}
}
}
},
"201": {
"description": "The task is in progress, please check back later.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resCode": {
"type": "string"
},
"msg": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"resultUrl": {
"type": "string",
"format": "uri",
"description": "URL to the generated report table which can be viewed by opening in a new page."
}
}
},
"pageData": {
"type": "string"
}
}
}
}
}
},
"202": {
"description": "No matching results found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resCode": {
"type": "string"
},
"msg": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"resultUrl": {
"type": "string",
"format": "uri",
"description": "URL to the generated report table which can be viewed by opening in a new page."
}
}
},
"pageData": {
"type": "string"
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/AuthError"
},
"7113": {
"description": "Insufficient account balance, please log in to https://synthmind.app to recharge.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resCode": {
"type": "string"
},
"msg": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"resultUrl": {
"type": "string",
"format": "uri",
"description": "URL to the generated report table which can be viewed by opening in a new page."
}
}
},
"pageData": {
"type": "string"
}
}
}
}
}
},
"default": {
"$ref": "#/components/responses/ErrorResponse"
}
}
}
}
},
"components": {
"schemas": {
"ErrorResponseSchema": {
"type": "object",
"properties": {
"resCode": {
"type": "string",
"description": "Response code indicating success or failure. Non-200 values indicate failure."
},
"msg": {
"type": "string",
"description": "Message providing additional information about the error."
},
"data": {
"type": "string",
"nullable": true,
"description": "Data is null in case of an error."
}
}
},
"AuthErrorSchema": {
"type": "object",
"properties": {
"resCode": {
"type": "string",
"description": "Response code indicating an authentication error, typically 403."
},
"msg": {
"type": "string",
"description": "Message providing additional information about the authentication error."
},
"data": {
"type": "string",
"nullable": true,
"description": "Data is null in case of an authentication error."
}
}
}
},
"responses": {
"ErrorResponse": {
"description": "General error response indicating failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
}
},
"AuthError": {
"description": "Authentication error, requires OAuth 2.0 re-authentication.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthErrorSchema"
}
}
}
}
}
}
}