DEV Community videos API
The videos API from DEV Community — 2 operation(s) for videos.
OpenAPI Specification
openapi: 3.0.3
info:
title: Forem API V1 agent_sessions videos API
version: 1.0.0
description: "Access Forem articles, users and other resources via API.\n For a real-world example of Forem in action, check out [DEV](https://www.dev.to).\n All endpoints can be accessed with the 'api-key' header and a accept header, but\n some of them are accessible publicly without authentication.\n\n Dates and date times, unless otherwise specified, must be in\n the [RFC 3339](https://tools.ietf.org/html/rfc3339) format."
servers:
- url: https://dev.to/api
description: Production server
security:
- api-key: []
tags:
- name: videos
paths:
/api/videos:
get:
summary: Articles with a video
tags:
- videos
security: []
description: 'This endpoint allows the client to retrieve a list of articles that are uploaded with a video.
It will only return published video articles ordered by descending popularity.
It supports pagination, each page will contain 24 articles by default.'
operationId: videos
parameters:
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/perPageParam24to1000'
responses:
'200':
description: A List of all articles with videos
content:
application/json:
example:
- type_of: video_article
id: 2269
path: /username271/dulce-et-decorum-est32-1c75
cloudinary_video_url: https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/thumbs-video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f-00001.png
video: https://s3.amazonaws.com/dev-to-input-v0/video-upload__2d7dc29e39a40c7059572bca75bb646b
title: Dulce et Decorum Est32
user_id: 4320
video_duration_in_minutes: 00:00
video_source_url: https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f.m3u8
user:
name: Layne "Eldon" \:/ Satterfield
- type_of: video_article
id: 2270
path: /username272/an-evil-cradling33-n2e
cloudinary_video_url: https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/thumbs-video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f-00001.png
video: https://s3.amazonaws.com/dev-to-input-v0/video-upload__2d7dc29e39a40c7059572bca75bb646b
title: An Evil Cradling33
user_id: 4321
video_duration_in_minutes: 00:00
video_source_url: https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f.m3u8
user:
name: Foster "Augustine" \:/ Cruickshank
schema:
type: array
items:
$ref: '#/components/schemas/VideoArticle'
/videos:
get:
summary: Articles with a video
tags:
- videos
security: []
description: 'This endpoint allows the client to retrieve a list of articles that are uploaded with a video.
It will only return published video articles ordered by descending popularity.
It supports pagination, each page will contain 24 articles by default.'
operationId: videos
parameters:
- $ref: '#/components/parameters/pageParam'
- $ref: '#/components/parameters/perPageParam24to1000'
responses:
'200':
description: A List of all articles with videos
content:
application/json:
example:
- type_of: video_article
id: 287
path: /username499/the-millstone201-1kgb
cloudinary_video_url: https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/thumbs-video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f-00001.png
title: The Millstone201
user_id: 1452
video_duration_in_minutes: 00:00
video_source_url: https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f.m3u8
user:
name: Edgardo "Monroe" \:/ Gusikowski
- type_of: video_article
id: 288
path: /username500/a-many-splendoured-thing202-4gnk
cloudinary_video_url: https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/thumbs-video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f-00001.png
title: A Many-Splendoured Thing202
user_id: 1453
video_duration_in_minutes: 00:00
video_source_url: https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f.m3u8
user:
name: Arlena "Catarina" \:/ Zulauf
schema:
type: array
items:
$ref: '#/components/schemas/VideoArticle'
components:
schemas:
VideoArticle:
description: Representation of an Article with video
type: object
properties:
type_of:
type: string
id:
type: integer
format: int64
path:
type: string
cloudinary_video_url:
type: string
title:
type: string
user_id:
type: integer
format: int64
video_duration_in_minutes:
type: string
video_source_url:
type: string
user:
description: Author of the article
type: object
properties:
name:
type: string
parameters:
perPageParam24to1000:
in: query
name: per_page
required: false
description: Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.
schema:
type: integer
format: int32
minimum: 1
maximum: 1000
default: 24
pageParam:
in: query
name: page
required: false
description: Pagination page
schema:
type: integer
format: int32
minimum: 1
default: 1
securitySchemes:
api-key:
type: apiKey
name: api-key
in: header
description: "API Key authentication.\n\nAuthentication for some endpoints, like write operations on the\nArticles API require a DEV API key.\n\nAll authenticated endpoints are CORS disabled, the API key is intended for non-browser scripts.\n\n### Getting an API key\n\nTo obtain one, please follow these steps:\n\n - visit https://dev.to/settings/extensions\n - in the \"DEV API Keys\" section create a new key by adding a\n description and clicking on \"Generate API Key\"\n\n \n\n - You'll see the newly generated key in the same view\n "