{ "openapi": "3.0.3", "info": { "title": "Audiorella API", "description": "Audiorella Podcast Management API", "version": "1.0.0" }, "servers": [ { "url": "https://api.audiorella.com" } ], "components": { "securitySchemes": { "user_login": { "type": "oauth2", "flows": { "password": { "tokenUrl": "/oauth/token", "refreshUrl": "/oauth/token/refresh", "scopes": {} } } } }, "schemas": { "BlogEpisodeResource": { "type": "object", "properties": { "id": { "type": "integer" }, "podcast_id": { "type": "integer" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "published_at": { "type": "string" }, "cover_image": { "type": "string" }, "description": { "type": "string" }, "permalink_full_url": { "type": "string" }, "audio_cdn_url": { "type": "string" } } }, "CategoryResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "EpisodeResource": { "type": "object", "properties": { "id": { "type": "integer" }, "podcast_id": { "type": "integer" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "description": { "type": "string" }, "notes": { "type": "string" }, "cover_image": { "type": "string" }, "type": { "type": "integer" }, "season": { "type": "integer" }, "number": { "type": "integer" }, "copyright": { "type": "string" }, "permalink": { "type": "string" }, "permalink_full_url": { "type": "string" }, "custom_url": { "type": "string" }, "authors": { "type": "string" }, "explicit_language": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "ads": { "type": "array", "items": { "type": "object" } } } }, "PodcastResource": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "subdomain": { "type": "string" }, "description": { "type": "string" }, "author": { "type": "string" }, "cover_image": { "type": "string" }, "email": { "type": "string" }, "website": { "type": "string" }, "copyright": { "type": "string" }, "publication_type": { "type": "string" }, "episode_number_in_feed": { "type": "integer" }, "explicit_language": { "type": "integer" }, "language": { "type": "string" }, "status": { "type": "string" }, "number_of_feed_item": { "type": "integer" }, "user_id": { "type": "integer" }, "category_ids": { "type": "array", "items": { "type": "integer" } }, "tags": { "type": "array", "items": { "type": "string" } }, "blog_bg_color": { "type": "string" }, "blog_text_color": { "type": "string" }, "blog_tracking_code": { "type": "string" }, "feed_cdn_url": { "type": "string" }, "blog_preview_token": { "type": "string" }, "blog_preview_url": { "type": "string" }, "redirect_itune_url": { "type": "string" }, "redirect_feed_url": { "type": "string" }, "redirect_blog_url": { "type": "string" }, "dai_enabled": { "type": "boolean" }, "dai_collection_id": { "type": "string" } } }, "YoutubeMediaDataResource": { "type": "object", "properties": { "media": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "playlists": { "type": "array", "items": { "type": "object", "properties": { "media_if_ref": { "type": "string" }, "is_media_in_playlist": { "type": "boolean" }, "id": { "type": "string" }, "title": { "type": "string" } } } } } }, "ExportResource": { "type": "object", "properties": { "podcast_id": { "type": "integer" }, "service": { "type": "string" }, "url": { "type": "string" }, "manual": { "type": "integer" }, "isset": { "type": "integer" } } }, "PlanDefinitionResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "PlayerColorsResource": { "type": "object", "properties": { "podcast": { "type": "string" }, "title": { "type": "string" }, "controls": { "type": "string" }, "background": { "type": "string" }, "flyout": { "type": "string" }, "link": { "type": "string" }, "logo": { "type": "string" } } }, "SubscribeButtonConfigResource": { "type": "object", "properties": { "color": { "type": "string" }, "size": { "type": "string" }, "format": { "type": "string" }, "style": { "type": "string" } } } } }, "paths": { "/api/analytics/search": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsSearch", "parameters": [ { "name": "bytext", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/downloads": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsDownloads", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "episode_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "compare_with_previous_range", "in": "query", "schema": { "type": "boolean" } }, { "name": "extract_days", "in": "query", "schema": { "type": "boolean" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/users": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsUsers", "parameters": [ { "name": "bytext", "in": "query", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "schema": { "type": "string" } }, { "name": "sort_type", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/podcasts": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsPodcasts", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "bytext", "in": "query", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "schema": { "type": "string" } }, { "name": "sort_type", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/episodes": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsEpisodes", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "bytext", "in": "query", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "schema": { "type": "string" } }, { "name": "sort_type", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/last/episode": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsLastEpisode", "parameters": [ { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/platforms": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsPlatforms", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "episode_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/countries": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsCountries", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "episode_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/webplayer": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsWebplayer", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "episode_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/regions": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsRegions", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "episode_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/cities": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsCities", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "episode_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/apps": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsApps", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "episode_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/apps-by-day": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsAppsByDay", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "episode_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/apps/platforms": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsAppsPlatforms", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "episode_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/compare/users": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsCompareUsers", "parameters": [ { "name": "user_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "days", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/compare/podcasts": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsComparePodcasts", "parameters": [ { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "days", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/compare/episodes": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsCompareEpisodes", "parameters": [ { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_id", "in": "query", "schema": { "type": "integer" } }, { "name": "episode_ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "days", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/ad-inventar": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsAdInventar", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "schema": { "type": "integer" } }, { "name": "podcast_id", "in": "query", "schema": { "type": "integer" } }, { "name": "sort_by", "in": "query", "schema": { "type": "string" } }, { "name": "sort_type", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer" } }, { "name": "export", "in": "query", "schema": { "type": "string" } }, { "name": "only_summary", "in": "query", "schema": { "type": "boolean" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/dashboard/overview": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsDashboardOverview", "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/dashboard/subscriptions": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsDashboardSubscriptions", "parameters": [ { "name": "segment", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/dashboard/revenue": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsDashboardRevenue", "parameters": [ { "name": "segment", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/dashboard/encoding": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsDashboardEncoding", "parameters": [ { "name": "segment", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/analytics/dashboard/downloads": { "get": { "tags": [ "Analytics" ], "operationId": "analyticsDashboardDownloads", "parameters": [ { "name": "segment", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/audio-snippets/{id}": { "delete": { "tags": [ "AudioSnippet" ], "operationId": "deleteAudioSnippet", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/audio-snippets/download": { "get": { "tags": [ "AudioSnippet" ], "operationId": "downloadAudioSnippet", "parameters": [ { "name": "filename", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/password/reset/email": { "post": { "tags": [ "Authentication" ], "operationId": "passwordResetEmail", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } }, "required": [ "email" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/logout": { "post": { "tags": [ "Authentication" ], "operationId": "logout", "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/register": { "post": { "tags": [ "Authentication" ], "operationId": "register", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "password": { "type": "string" }, "country": { "type": "string" }, "organizational_type": { "type": "integer", "description": "1=INDIVIDUAL, 2=COMPANY" }, "terms_conditions": { "type": "boolean" }, "register_type": { "type": "integer", "description": "1=GENERAL, 2=COLLABORATOR" }, "ad_integration": { "type": "integer", "description": "1=INTERESTED, 2=ALREADY HAVE, 3=NOT INTERESTED" } }, "required": [ "first_name", "last_name", "email", "password", "country", "organizational_type", "terms_conditions", "ad_integration" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/password/reset": { "post": { "tags": [ "Authentication" ], "operationId": "passwordReset", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "email": { "type": "string", "format": "email" }, "password": { "type": "string" }, "password_confirmation": { "type": "string" } }, "required": [ "token", "email", "password", "password_confirmation" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/verify": { "get": { "tags": [ "Authentication" ], "operationId": "verify", "parameters": [ { "name": "expires", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "hash", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "signature", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/verify/resend": { "post": { "tags": [ "Authentication" ], "operationId": "verifyResend", "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/history-logs": { "get": { "tags": [ "HistoryLog" ], "operationId": "getHistoryLogs", "parameters": [ { "name": "sort_by", "in": "query", "schema": { "type": "string" } }, { "name": "sort_type", "in": "query", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/invoices": { "get": { "tags": [ "Invoice" ], "operationId": "getInvoices", "parameters": [ { "name": "sort_by", "in": "query", "schema": { "type": "string" } }, { "name": "sort_type", "in": "query", "schema": { "type": "string" } }, { "name": "invoice", "in": "query", "schema": { "type": "string" } }, { "name": "user", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/news": { "get": { "tags": [ "News" ], "operationId": "getNews", "responses": { "200": { "description": "Success" } } } }, "/api/plans": { "get": { "tags": [ "Plan" ], "operationId": "getPlans", "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/plans/standard": { "get": { "tags": [ "Plan" ], "operationId": "getPlansStandard", "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/plans/extra-encoding": { "post": { "tags": [ "Plan" ], "operationId": "plansExtraEncoding", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "extra_hours": { "type": "number" }, "nonce": { "type": "string" }, "description": { "type": "string" } }, "required": [ "extra_hours", "nonce" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/plans/professional/{token}": { "get": { "tags": [ "Plan" ], "operationId": "getPlansProfessionalToken", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/plans/professional/{id}": { "post": { "tags": [ "Plan" ], "operationId": "updatePlansProfessional", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "download": { "type": "number" }, "encoding": { "type": "number" }, "price": { "type": "number" }, "skip_payment": { "type": "boolean" } }, "required": [ "download", "encoding", "price" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/plans/professional": { "post": { "tags": [ "Plan" ], "operationId": "createPlansProfessional", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "download": { "type": "number" }, "encoding": { "type": "number" }, "price": { "type": "number" }, "user_id": { "type": "integer" }, "skip_payment": { "type": "boolean" } }, "required": [ "download", "encoding", "price" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/plans/{id}/subscribe": { "post": { "tags": [ "Plan" ], "operationId": "plansSubscribe", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nonce": { "type": "string" }, "description": { "type": "string" }, "device_data": { "type": "string" } }, "required": [ "nonce" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/categories": { "get": { "tags": [ "Category" ], "operationId": "getCategories", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryResource" } } } } } } }, "post": { "tags": [ "Category" ], "operationId": "createCategory", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryResource" } } } } } } }, "/api/categories/{id}": { "get": { "tags": [ "Category" ], "operationId": "getCategoryById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryResource" } } } } } }, "delete": { "tags": [ "Category" ], "operationId": "deleteCategory", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } }, "patch": { "tags": [ "Category" ], "operationId": "updateCategory", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } } } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryResource" } } } } } } }, "/api/episodes": { "get": { "tags": [ "Episode" ], "operationId": "getEpisodes", "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EpisodeResource" } } } } } } }, "post": { "tags": [ "Episode" ], "operationId": "createEpisode", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "podcast_id": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "integer" }, "subtitle": { "type": "string" }, "description": { "type": "string" }, "notes": { "type": "string" }, "cover_image": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "season": { "type": "integer" }, "number": { "type": "integer" }, "permalink": { "type": "string" }, "custom_url": { "type": "string" }, "authors": { "type": "string" }, "explicit_language": { "type": "boolean" } }, "required": [ "podcast_id", "title", "type" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EpisodeResource" } } } } } } }, "/api/episodes/{id}": { "get": { "tags": [ "Episode" ], "operationId": "getEpisodeById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EpisodeResource" } } } } } }, "post": { "tags": [ "Episode" ], "operationId": "updateEpisode", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "podcast_id": { "type": "integer" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "description": { "type": "string" }, "notes": { "type": "string" }, "cover_image": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "integer" }, "season": { "type": "integer" }, "number": { "type": "integer" }, "permalink": { "type": "string" }, "custom_url": { "type": "string" }, "authors": { "type": "string" }, "explicit_language": { "type": "boolean" }, "published": { "type": "boolean" }, "published_at": { "type": "string", "format": "date-time" } }, "required": [ "podcast_id", "title" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EpisodeResource" } } } } } }, "delete": { "tags": [ "Episode" ], "operationId": "deleteEpisode", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/episodes/{id}/upload/audio": { "post": { "tags": [ "Episode" ], "operationId": "uploadEpisodeAudio", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/episodes/{id}/uploaded/audio": { "delete": { "tags": [ "Episode" ], "operationId": "deleteUploadedEpisodeAudio", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/episodes/{id}/encode/audio": { "post": { "tags": [ "Episode" ], "operationId": "encodeEpisodeAudio", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/episodes/{id}/stop-encoding/audio": { "post": { "tags": [ "Episode" ], "operationId": "stopEncodingEpisodeAudio", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/episodes/{id}/download/encoded/audio": { "get": { "tags": [ "Episode" ], "operationId": "downloadEncodedEpisodeAudio", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/episodes/{id}/cover-image": { "get": { "tags": [ "Episode" ], "operationId": "getEpisodeCoverImage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/episodes/{id}/generate/guid": { "patch": { "tags": [ "Episode" ], "operationId": "generateEpisodeGuid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/episodes/{id}/duplicate": { "post": { "tags": [ "Episode" ], "operationId": "duplicateEpisode", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/episodes/{id}/ads": { "post": { "tags": [ "Episode" ], "operationId": "setEpisodeAds", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ad_breaks": { "type": "array", "items": { "type": "integer" } } }, "required": [ "ad_breaks" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/episodes/{id}/chapters": { "post": { "tags": [ "Episode" ], "operationId": "setEpisodeChapters", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chapters": { "type": "array", "items": { "type": "integer" } } }, "required": [ "chapters" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/episodes/{id}/audio-cutting-processor": { "get": { "tags": [ "Episode" ], "operationId": "getEpisodeAudioCuttingProcessor", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "Episode" ], "operationId": "setEpisodeAudioCuttingProcessor", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "config": { "type": "object" } }, "required": [ "config" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Episode" ], "operationId": "deleteEpisodeAudioCuttingProcessor", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/episodes/{id}/youtube": { "get": { "tags": [ "Episode" ], "operationId": "getEpisodeYoutube", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/YoutubeMediaDataResource" } } } } } }, "post": { "tags": [ "Episode" ], "operationId": "setEpisodeYoutube", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "media": { "type": "object" }, "playlists": { "type": "array", "items": { "type": "object" } } }, "required": [ "media" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/podcasts": { "post": { "tags": [ "Podcast" ], "operationId": "createPodcast", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "subdomain": { "type": "string" }, "description": { "type": "string" }, "author": { "type": "string" }, "cover_image": { "type": "string", "format": "binary" }, "language": { "type": "string" }, "number_of_feed_item": { "type": "integer" }, "subtitle": { "type": "string" }, "email": { "type": "string", "format": "email" }, "website": { "type": "string", "format": "uri" }, "copyright": { "type": "string" }, "publication_type": { "type": "string" }, "category_ids": { "type": "array", "items": { "type": "integer" } }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "subdomain", "description", "author", "cover_image", "language", "number_of_feed_item" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PodcastResource" } } } } } } }, "/api/podcasts/{id}": { "get": { "tags": [ "Podcast" ], "operationId": "getPodcastById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PodcastResource" } } } } } }, "post": { "tags": [ "Podcast" ], "operationId": "updatePodcast", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "subdomain": { "type": "string" }, "description": { "type": "string" }, "author": { "type": "string" }, "cover_image": { "type": "string", "format": "binary" }, "language": { "type": "string" }, "number_of_feed_item": { "type": "integer" }, "subtitle": { "type": "string" }, "email": { "type": "string", "format": "email" }, "website": { "type": "string", "format": "uri" }, "copyright": { "type": "string" }, "publication_type": { "type": "string" }, "category_ids": { "type": "array", "items": { "type": "integer" } }, "tags": { "type": "array", "items": { "type": "string" } }, "dai_autobreakpoints_enable": { "type": "boolean" }, "dai_autobreakpoints": { "type": "string" }, "redirect_feed_url": { "type": "string", "format": "uri" }, "redirect_blog_url": { "type": "string", "format": "uri" } }, "required": [ "title", "subdomain", "description", "author", "language", "number_of_feed_item" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PodcastResource" } } } } } }, "delete": { "tags": [ "Podcast" ], "operationId": "deletePodcast", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/podcasts/validate": { "post": { "tags": [ "Podcast" ], "operationId": "validatePodcast", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/podcasts/{id}/exports": { "get": { "tags": [ "Podcast" ], "operationId": "getPodcastExports", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportResource" } } } } } } } }, "/api/podcasts/{id}/exports/{service}": { "get": { "tags": [ "Podcast" ], "operationId": "getPodcastExport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "service", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "spotify", "deezer", "google", "itunes", "amazon" ] } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportResource" } } } } } }, "post": { "tags": [ "Podcast" ], "operationId": "setPodcastExport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "service", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "spotify", "deezer", "google", "itunes", "amazon" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" } }, "required": [ "url" ] } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Podcast" ], "operationId": "deletePodcastExport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "service", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "spotify", "deezer", "google", "itunes", "amazon" ] } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/podcasts/{id}/exports/{service}/subscribe": { "post": { "tags": [ "Podcast" ], "operationId": "subscribePodcastExport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "service", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "spotify", "deezer", "google" ] } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/podcasts/{id}/exports/{service}/unsubscribe": { "post": { "tags": [ "Podcast" ], "operationId": "unsubscribePodcastExport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "service", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "spotify", "deezer", "google" ] } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/podcasts/{id}/blog": { "post": { "tags": [ "Podcast" ], "operationId": "setPodcastBlog", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "noblog": { "type": "boolean" }, "ownblog": { "type": "boolean" }, "blog_bg_color": { "type": "string" }, "blog_text_color": { "type": "string" }, "blog_tracking_code": { "type": "string" }, "blog_header_image": { "type": "string", "format": "binary" } } } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success" } } } }, "/api/podcasts/{id}/player/colors": { "post": { "tags": [ "Podcast" ], "operationId": "setPodcastPlayerColors", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "podcast": { "type": "string" }, "title": { "type": "string" }, "controls": { "type": "string" }, "background": { "type": "string" }, "flyout": { "type": "string" }, "link": { "type": "string" }, "logo": { "type": "string" } } } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlayerColorsResource" } } } } } } }, "/api/podcasts/{id}/episodes": { "get": { "tags": [ "Podcast" ], "operationId": "getPodcastEpisodes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EpisodeResource" } } } } } } } }, "/api/podcasts/{id}/subscribe/config": { "post": { "tags": [ "Podcast" ], "operationId": "setPodcastSubscribeConfig", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "color": { "type": "string" }, "size": { "type": "string" }, "format": { "type": "string" }, "style": { "type": "string" } } } } } }, "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscribeButtonConfigResource" } } } } } } }, "/api/profile/podcasts": { "get": { "tags": [ "Profile" ], "operationId": "getProfilePodcasts", "parameters": [ { "name": "sort_by", "in": "query", "schema": { "type": "string" } }, { "name": "sort_type", "in": "query", "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "string" } } ], "security": [ { "user_login": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PodcastResource" } } } } } } } } } }