Share
Sign In
OpenAPI Scheme
Sider.ai API
커맨드스페이스
{
"openapi": "3.1.0",
"info": {
"title": "Sider Tools API",
"description": "An API for various tools that are available from Sider AI to be used with any GPT.",
"version": "1.0.0"
},
"paths": {
"/scholarGPT/scholar": {
"get": {
"summary": "Scholar Search",
"description": ":param query: Search query.\n:param language: language code.\n:param year_start: Start year.\n:param year_end: End year.\n:param sorted: false for relevance, true for date.",
"operationId": "scholar_search_scholarGPT_scholar_get",
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Query"
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "en",
"title": "Language"
}
},
{
"name": "year_start",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"title": "Year Start"
}
},
{
"name": "year_end",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"title": "Year End"
}
},
{
"name": "sorted",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Sorted"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/scholarGPT/patents": {
"get": {
"summary": "Get Patents",
"description": ":param query: Search query.\n:param language: language code.\n:param country\n:param sort: \"new\", \"old\", None.\n:param before: type:YYYYMMDD\n:param after: type:YYYYMMDD\n:param status: \"GRANT\", \"APPLICATION\"",
"operationId": "get_patents_scholarGPT_patents_get",
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Query"
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "en",
"title": "Language"
}
},
{
"name": "country",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Country"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Sort"
}
},
{
"name": "before",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Before"
}
},
{
"name": "after",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "After"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Status"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/googleGPT/images": {
"get": {
"summary": "Image Search",
"description": ":param query: The search query.\n:param language: The language code of the articles to search for.\n:param time: The time period to search for articles. Options are \"h\" for past hour, \"d\" for past day, \"w\" for past week, and \"m\" for past month.\n:param country: The country to search for articles.",
"operationId": "image_search_googleGPT_images_get",
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Query"
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "en",
"title": "Language"
}
},
{
"name": "country",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "us",
"title": "Country"
}
},
{
"name": "time",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Time"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/googleGPT/videos": {
"get": {
"summary": "Video Search",
"description": ":param query: The search query.\n:param language: The language code of the articles to search for.\n:param time: The time period to search for articles. Options are \"h\" for past hour, \"d\" for past day, \"w\" for past week, and \"m\" for past month.\n:param country: The country to search for articles.",
"operationId": "video_search_googleGPT_videos_get",
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Query"
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "en",
"title": "Language"
}
},
{
"name": "country",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Country"
}
},
{
"name": "time",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Time"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/shopping/product_search": {
"get": {
"summary": "Product Search",
"description": ":param query: The search query.\n:param language\n:param time: The time period to search for articles. Options are \"h\" for past hour, \"d\" for past day, \"w\" for past week, and \"m\" for past month.\n:param country: The country to search for articles.\n:param location",
"operationId": "product_search_shopping_product_search_get",
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Query"
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "en",
"title": "Language"
}
},
{
"name": "time",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Time"
}
},
{
"name": "country",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Country"
}
},
{
"name": "location",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Location"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/shopping/get_product_sellers": {
"get": {
"summary": "Get Product Sellers",
"description": ":param product_id: The product ID.\n:param language: The language code of the articles to search for.\n:param country: The country to search for articles.\n:param location: The location to search for articles.",
"operationId": "get_product_sellers_shopping_get_product_sellers_get",
"parameters": [
{
"name": "product_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Product Id"
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "en",
"title": "Language"
}
},
{
"name": "country",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Country"
}
},
{
"name": "location",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Location"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/newsGPT/news": {
"get": {
"summary": "News Search",
"description": ":param query: The search query.\n:param language: The language code of the articles to search for.\n:param time: The time period to search for articles. Options are \"w\" for past week, \"h\" for past hour, \"d\" for past day, and \"m\" for past month.\n:param country: The country to search for articles.",
"operationId": "news_search_newsGPT_news_get",
"parameters": [
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Query"
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "en",
"title": "Language"
}
},
{
"name": "time",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "w",
"title": "Time"
}
},
{
"name": "country",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "us",
"title": "Country"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/sider/search/api/get": {
"get": {
"summary": "Get Content",
"description": ":param url: The URL of the page to be read.",
"operationId": "get_content_sider_search_api_get_get",
"parameters": [
{
"name": "url",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Url"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/sider/search/api/search": {
"get": {
"summary": "Api Search",
"description": ":param q: query\n:param gl: country\n:param hl: language\n:param tbm: time frame\n:param start: The index of the first result to return.\n:param num: number of results.",
"operationId": "api_search_sider_search_api_search_get",
"parameters": [
{
"name": "q",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Q"
}
},
{
"name": "gl",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Gl"
}
},
{
"name": "hl",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Hl"
}
},
{
"name": "tbm",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Tbm"
}
},
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"title": "Start"
}
},
{
"name": "num",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"title": "Num"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/sider/presenter/api/slides": {
"post": {
"summary": "Generate Slides",
"description": ":param type: Allowed types: [reveal]\n:param slides: The slides content.\n:param theme: Select Theme from: [beigo,blood,dracula,moon,night,serif,simple,sky,white]\n:param transition: Select Transition from: [none, fade, slide, convex, concave, zoom]",
"operationId": "generate_slides_sider_presenter_api_slides_post",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Type"
}
},
{
"name": "theme",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Theme"
}
},
{
"name": "transition",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Transition"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_generate_slides_sider_presenter_api_slides_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/sider/presenter/api/graph": {
"post": {
"summary": "Generate Graph",
"description": ":param type: Allowed types: [mermaid]\n:param code: The code for the graph.",
"operationId": "generate_graph_sider_presenter_api_graph_post",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Type"
}
},
{
"name": "code",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Code"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/sider/presenter/api/pdf": {
"post": {
"summary": "Generate Pdf",
"description": ":param type: Allowed types: [pdf]\n:param markdown: The markdown content to be converted to PDF.\n:param url: The URL of the page to be converted to PDF.",
"operationId": "generate_pdf_sider_presenter_api_pdf_post",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Type"
}
},
{
"name": "markdown",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Markdown"
}
},
{
"name": "url",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Url"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/sider/presenter/api/doc": {
"post": {
"summary": "Generate Doc",
"description": ":param type: Allowed types: [docx]\n:param markdown: The markdown content to be converted to DOCX.\n:param html: The HTML content to be converted to DOCX.",
"operationId": "generate_doc_sider_presenter_api_doc_post",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Type"
}
},
{
"name": "markdown",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Markdown"
}
},
{
"name": "html",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Html"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/sider/presenter/api/sheet": {
"post": {
"summary": "Generate Sheet",
"description": ":param type: Allowed types: [xlsx]\n:param csv: The CSV content to be converted to XLSX.",
"operationId": "generate_sheet_sider_presenter_api_sheet_post",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Type"
}
},
{
"name": "csv",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Csv"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/sider/presenter/api/map": {
"post": {
"summary": "Generate Map",
"description": ":param type: Allowed types: [default]\n:param longitude: The longitude of the location.\n:param latitude: The latitude of the location.\n:param zoom: The zoom level of the map.",
"operationId": "generate_map_sider_presenter_api_map_post",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Type"
}
},
{
"name": "longitude",
"in": "query",
"required": true,
"schema": {
"type": "number",
"title": "Longitude"
}
},
{
"name": "latitude",
"in": "query",
"required": true,
"schema": {
"type": "number",
"title": "Latitude"
}
},
{
"name": "zoom",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Zoom"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/sider/presenter/api/screenshot": {
"post": {
"summary": "Get Screenshot",
"description": ":param url: The URL of the page to be screenshotted.\n:param width: The width of the screenshot.\n:param height: The height of the screenshot.",
"operationId": "get_screenshot_sider_presenter_api_screenshot_post",
"parameters": [
{
"name": "url",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Url"
}
},
{
"name": "width",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Width"
}
},
{
"name": "height",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Height"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/sider/presenter/api/tts/generate": {
"post": {
"summary": "Generate Tts",
"description": ":param text: The text to be converted to speech.\n:param voice: voice selected from the list of available voices.",
"operationId": "generate_tts_sider_presenter_api_tts_generate_post",
"parameters": [
{
"name": "text",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Text"
}
},
{
"name": "voice",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Voice"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/sider/presenter/api/tts/list_voices": {
"get": {
"summary": "List Voices",
"operationId": "list_voices_sider_presenter_api_tts_list_voices_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Body_generate_slides_sider_presenter_api_slides_post": {
"properties": {
"slides": {
"items": {},
"type": "array",
"title": "Slides"
}
},
"type": "object",
"required": [
"slides"
],
"title": "Body_generate_slides_sider_presenter_api_slides_post"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
}
}
},
"servers": [
{
"url": "https://actions.sider.ai/gpts/action"
}
]
}