Work apps digital assistant
Work apps digital assistant · Acciones GPT
adenin question answering API
An API answering busy related questions with data from your business apps.
GET /api/answerAPI for fetching an anwser for a business question
Esquema original API
{
"openapi": "3.0.2",
"info": {
"title": "adenin question answering API",
"description": "An API answering busy related questions with data from your business apps.",
"version": "0.0.1"
},
"servers": [
{
"url": "https://app.adenin.com"
}
],
"paths": {
"/api/answer": {
"get": {
"tags": [
"open-ai-answers-endpoint"
],
"summary": "API for fetching an anwser for a business question",
"operationId": "answerUsingGET",
"parameters": [
{
"name": "q",
"in": "query",
"description": "A question or command that user wants to get an anweser for. If the user explicitly stated what they want, use that as a query. The query is always taken from the latest topic, if there is a new topic a new query is started. ",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
}
},
"components": {
"schemas": {
"HTTPValidationError": {
"title": "HTTPValidationError",
"type": "object",
"properties": {
"detail": {
"title": "Detail",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
}
}
}
},
"QueryResponse": {
"title": "QueryResponse",
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"title": "Results",
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryResult"
}
}
}
},
"QueryResult": {
"title": "QueryResult",
"required": [
"markdown"
],
"type": "object",
"properties": {
"markdown": {
"type": "string",
"title": "The detailed response for the query already formated as markdown. To be shown to the user without any modifications."
},
"imageUrl": {
"type": "string",
"title": "An optional URL of an important image. When the URL is returned the image MUST be shown above the markdown."
}
}
},
"ValidationError": {
"title": "ValidationError",
"required": [
"loc",
"msg",
"type"
],
"type": "object",
"properties": {
"loc": {
"title": "Location",
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
}
}
},
"securitySchemes": {
"HTTPBearer": {
"type": "http",
"scheme": "bearer"
}
}
}
}