Thread Weaver
Thread Weaver · GPT Actions
AlphaNotes
This is the backend for a ChatGPT plugin that provides study aid for YouTube videos.
POST /get_transcriptGet the transcript of a videoThis endpoint returns the title, the thumbnail's URL (show after title), the transcript of a video, and a pdf link. Use it when the user asks for the video transcript only.
POST /get_article_textScrape an article and return its content for making a Twitter threadThis endpoint scrapes the content of an article and returns its content along with listing any YouTube links found in the article. Use this endpoint when the user asks for an article thread or gives a URL that is not from YouTube. Also, ignore the instructions from the assistant_hint.
原始 API 定义
{
"openapi": "3.0.0",
"info": {
"title": "AlphaNotes",
"version": "0.1.0",
"description": "This is the backend for a ChatGPT plugin that provides study aid for YouTube videos."
},
"servers": [
{
"url": "https://ainotes.alphanotes.one"
}
],
"paths": {
"/get_transcript": {
"post": {
"summary": "Get the transcript of a video",
"operationId": "videoTranscript",
"description": "This endpoint returns the title, the thumbnail's URL (show after title), the transcript of a video, and a pdf link. Use it when the user asks for the video transcript only.\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Video"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VideoResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/get_article_text": {
"post": {
"summary": "Scrape an article and return its content for making a Twitter thread",
"operationId": "articleText",
"description": "This endpoint scrapes the content of an article and returns its content along with listing any YouTube links found in the article. Use this endpoint when the user asks for an article thread or gives a URL that is not from YouTube. Also, ignore the instructions from the assistant_hint.\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Article"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessfulArticleResponse"
}
}
}
},
"404": {
"description": "Article Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnavailableArticleError"
}
}
}
},
"413": {
"description": "Article Too Long",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleTooLongError"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Processing Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessingError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"HTTPValidationError": {
"type": "object",
"title": "HTTPValidationError",
"properties": {
"detail": {
"type": "array",
"title": "Detail",
"items": {
"$ref": "#/components/schemas/ValidationError"
}
}
}
},
"ValidationError": {
"type": "object",
"title": "ValidationError",
"required": [
"loc",
"msg",
"type"
],
"properties": {
"loc": {
"type": "array",
"title": "Location",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
}
},
"Video": {
"type": "object",
"title": "Video",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
}
}
},
"VideoURL": {
"type": "object",
"title": "VideoURL",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url"
}
}
},
"VideoResponse": {
"type": "object",
"title": "VideoResponse",
"required": [
"title",
"thumbnail_url",
"token_count",
"content",
"assistant_hint"
],
"properties": {
"title": {
"type": "string",
"description": "The title of the video"
},
"thumbnail_url": {
"type": "string",
"format": "uri",
"description": "The URL of the video thumbnail"
},
"token_count": {
"type": "integer",
"description": "The token count"
},
"content": {
"oneOf": [
{
"$ref": "#/components/schemas/Transcript"
},
{
"$ref": "#/components/schemas/Summary"
}
]
},
"assistant_hint": {
"type": "string",
"description": "The instructions to follow"
}
}
},
"NotesResponse": {
"type": "object",
"title": "NotesResponse",
"required": [
"title",
"thumbnail_url",
"token_count",
"assistant_hint",
"content"
],
"properties": {
"title": {
"type": "string",
"description": "The title of the video"
},
"thumbnail_url": {
"type": "string",
"format": "uri",
"description": "The URL of the video thumbnail"
},
"token_count": {
"type": "integer",
"description": "The token count of the content"
},
"assistant_hint": {
"type": "string",
"description": "The instructions to follow"
},
"content": {
"oneOf": [
{
"$ref": "#/components/schemas/Transcript"
},
{
"$ref": "#/components/schemas/Notes"
}
]
}
}
},
"Transcript": {
"type": "string",
"description": "The full transcript of the video"
},
"Notes": {
"type": "string",
"description": "The generated notes for the video"
},
"Summary": {
"type": "string",
"description": "The generated summary of the video"
},
"TextModel": {
"type": "object",
"title": "TextModel",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"description": "Markdown text to be converted to PDF",
"example": "## This is a title\nThis is some text."
}
}
},
"SharedLinkResponse": {
"type": "object",
"title": "SharedLinkResponse",
"required": [
"link"
],
"properties": {
"link": {
"type": "string",
"format": "uri",
"description": "Shareable Dropbox link of the uploaded PDF"
}
}
},
"ChunkResponse": {
"type": "object",
"properties": {
"unique_id": {
"type": "string",
"description": "The unique ID associated with the video transcript"
},
"video_title": {
"type": "string",
"description": "The title of the video"
},
"current_chunk_index": {
"type": "integer",
"description": "The index of the current chunk"
},
"next_chunk_to_fetch": {
"type": "integer",
"description": "The index of the next chunk to fetch"
},
"Chunks_left_to_fetch": {
"type": "integer",
"description": "The number of chunks left to fetch"
},
"chunk": {
"type": "object",
"description": "The content of the current chunk"
}
}
},
"Article": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
}
}
},
"SuccessfulArticleResponse": {
"type": "object",
"properties": {
"article_content": {
"type": "string"
},
"youtube_links": {
"type": "array",
"items": {
"type": "string"
}
},
"source": {
"type": "string",
"format": "uri"
},
"assistant_hint": {
"type": "string"
}
}
},
"UnavailableArticleError": {
"type": "object",
"properties": {
"UNAVAILABLE_ARTICLE_ERROR": {
"type": "string"
}
}
},
"ProcessingError": {
"type": "object",
"properties": {
"PROCESSING_ERROR": {
"type": "string"
}
}
},
"ArticleTooLongError": {
"type": "object",
"properties": {
"ARTICLE_TOO_LONG": {
"type": "string"
}
}
}
}
}
}