SourcelyGPT
SourcelyGPT · Actions GPT
FastAPI
POST /citeCitePOST /cite_formatCite FormatPOST /generate_citationGenerate CitationPOST /continue2Continue2POST /paraphraseParaphrasePOST /academiseAcademisePOST /shortenShortenPOST /expandExpandPOST /summarizeSummaryPOST /bullets_to_textBullets To TextPOST /write_in_depthWrite In DepthPOST /write_supporting_argumentWrite Supporting ArgumentPOST /write_opposing_argumentWrite Opposing ArgumentPOST /write_introductionWrite IntroductionPOST /write_conclusionWrite ConclusionPOST /write_abstractWrite AbstractPOST /write_summaryWrite SummaryPOST /give_feedbackGive FeedbackPOST /startStartPOST /plagiariasm_checkPlagiariasm CheckPOST /downloadDownload
Schéma original API
{
"openapi": "3.1.0",
"info": {
"title": "FastAPI",
"version": "0.1.0"
},
"servers": [
{
"url": "https://api-yomu-writer-470e5c0e3608.herokuapp.com"
}
],
"paths": {
"/cite": {
"post": {
"summary": "Cite",
"operationId": "cite_cite_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CiteRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/cite_format": {
"post": {
"summary": "Cite Format",
"operationId": "cite_format_cite_format_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CiteFormatRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/generate_citation": {
"post": {
"summary": "Generate Citation",
"operationId": "generate_citation_generate_citation_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenerateCitationsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/continue2": {
"post": {
"summary": "Continue2",
"operationId": "continue2_continue2_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Autocomplete2TextRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/paraphrase": {
"post": {
"summary": "Paraphrase",
"operationId": "paraphrase_paraphrase_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessTextRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/academise": {
"post": {
"summary": "Academise",
"operationId": "academise_academise_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessTextRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/shorten": {
"post": {
"summary": "Shorten",
"operationId": "shorten_shorten_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessTextRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/expand": {
"post": {
"summary": "Expand",
"operationId": "expand_expand_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessTextRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/summarize": {
"post": {
"summary": "Summary",
"operationId": "summary_summarize_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessTextRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/bullets_to_text": {
"post": {
"summary": "Bullets To Text",
"operationId": "bullets_to_text_bullets_to_text_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessTextRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/write_in_depth": {
"post": {
"summary": "Write In Depth",
"operationId": "write_in_depth_write_in_depth_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessTextRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/write_supporting_argument": {
"post": {
"summary": "Write Supporting Argument",
"operationId": "write_supporting_argument_write_supporting_argument_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessTextRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/write_opposing_argument": {
"post": {
"summary": "Write Opposing Argument",
"operationId": "write_opposing_argument_write_opposing_argument_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessTextRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/write_introduction": {
"post": {
"summary": "Write Introduction",
"operationId": "write_introduction_write_introduction_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentAIRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/write_conclusion": {
"post": {
"summary": "Write Conclusion",
"operationId": "write_conclusion_write_conclusion_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentAIRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/write_abstract": {
"post": {
"summary": "Write Abstract",
"operationId": "write_abstract_write_abstract_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentAIRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/write_summary": {
"post": {
"summary": "Write Summary",
"operationId": "write_summary_write_summary_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentAIRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/give_feedback": {
"post": {
"summary": "Give Feedback",
"operationId": "give_feedback_give_feedback_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentAIRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/start": {
"post": {
"summary": "Start",
"operationId": "start_start_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartEssayRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/plagiariasm_check": {
"post": {
"summary": "Plagiariasm Check",
"operationId": "plagiariasm_check_plagiariasm_check_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlagiarismRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/download": {
"post": {
"summary": "Download",
"operationId": "download_download_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
}
},
"components": {
"schemas": {
"Autocomplete2TextRequest": {
"properties": {
"markdown_text": {
"type": "string",
"title": "Markdown Text"
}
},
"type": "object",
"required": [
"markdown_text"
],
"title": "Autocomplete2TextRequest"
},
"CiteFormatRequest": {
"properties": {
"full_authors_names_list": {
"items": {
"type": "string"
},
"type": "array",
"title": "Full Authors Names List"
},
"full_authors_names": {
"type": "string",
"title": "Full Authors Names"
},
"year": {
"type": "integer",
"title": "Year"
},
"title": {
"type": "string",
"title": "Title"
},
"venue_or_journal": {
"type": "string",
"title": "Venue Or Journal"
}
},
"type": "object",
"required": [
"full_authors_names_list",
"full_authors_names",
"year",
"title",
"venue_or_journal"
],
"title": "CiteFormatRequest"
},
"CiteRequest": {
"properties": {
"text": {
"type": "string",
"title": "Text"
},
"request_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Request Type",
"default": "free"
},
"year_from": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Year From"
},
"year_to": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Year To"
},
"minimum_citation_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Minimum Citation Count",
"default": 0
},
"open_access_pdf": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Open Access Pdf",
"default": false
},
"is_research_paper": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Research Paper",
"default": false
},
"is_review_paper": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Review Paper",
"default": false
},
"include_keywords": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Include Keywords"
},
"exclude_keywords": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Exclude Keywords"
},
"yomu": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Yomu",
"default": false
}
},
"type": "object",
"required": [
"text"
],
"title": "CiteRequest"
},
"DocumentAIRequest": {
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"default": ""
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text",
"default": ""
},
"is_markdown": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Markdown",
"default": false
},
"base64_image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Base64 Image"
}
},
"type": "object",
"title": "DocumentAIRequest"
},
"DownloadRequest": {
"properties": {
"publicId": {
"type": "string",
"title": "Publicid"
},
"format": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Format",
"default": "tex"
},
"isProduction": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Isproduction",
"default": true
},
"author": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Author"
}
},
"type": "object",
"required": [
"publicId"
],
"title": "DownloadRequest"
},
"GenerateCitationsRequest": {
"properties": {
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text",
"default": ""
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
}
},
"type": "object",
"title": "GenerateCitationsRequest"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"PlagiarismRequest": {
"properties": {
"publicId": {
"type": "string",
"title": "Publicid"
},
"isProduction": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Isproduction",
"default": true
}
},
"type": "object",
"required": [
"publicId"
],
"title": "PlagiarismRequest"
},
"ProcessTextRequest": {
"properties": {
"text": {
"type": "string",
"title": "Text"
}
},
"type": "object",
"required": [
"text"
],
"title": "ProcessTextRequest"
},
"StartEssayRequest": {
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": ""
},
"include_title": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Include Title",
"default": false
},
"include_outline": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Include Outline",
"default": false
},
"include_ideas": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Include Ideas",
"default": false
}
},
"type": "object",
"title": "StartEssayRequest"
},
"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"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "ACCESS_TOKEN"
}
}
}
}