GET /api/v1/document/oembed/ – Open Knowledge Foundation Germany Froide API

document

Changed on Sep 11, 2025

get/api/v1/document/oembed/

Request

The document declares no server URL.
Auth: API key in cookie sessionid

Query parameters

format'csv' | 'json'

Response

resource_uristring uri required

idinteger required

site_urlstring required

titlestring

slugstring required

descriptionstring

published_atstring date-time nullable required

num_pagesinteger required

publicboolean required

listedboolean required

allow_annotationboolean required

pendingboolean required

file_urlstring required

file_sizeinteger nullable required

cover_imagestring required

page_templatestring required

outlinestring required

propertiesunknown required

uidstring uuid required

dataunknown required

pages_uristring required

originalstring uri required

foirequeststring uri required

publicbodystring uri required

last_modified_atstring required

Changes

Sep 11, 20252ba1a8b828b8 Revision changes
- breaking
  the response property's maxLength was unset from 250 for the response status (media type: application/json)
- breaking
  the response property's maxLength was unset from 250 for the response status (media type: text/csv)
- breaking
  the response's property format changed from int64 to no format for status (media type: application/json)
- breaking
  the response's property format changed from int64 to no format for status (media type: text/csv)
- info
  the response optional property became read-only for the status (media type: application/json)
- info
  the response optional property became read-only for the status (media type: text/csv)
- info
  the response optional property became read-only for the status (media type: application/json)
- info
  the response optional property became read-only for the status (media type: text/csv)
- info
  the response optional property became read-only for the status (media type: application/json)
- info
  the response optional property became read-only for the status (media type: text/csv)
- info
  the response optional property became read-only for the status (media type: application/json)
- info
  the response optional property became read-only for the status (media type: text/csv)
- info
  the response optional property became read-only for the status (media type: application/json)
- info
  the response optional property became read-only for the status (media type: text/csv)
- info
  the response optional property became read-only for the status (media type: application/json)
- info
  the response optional property became read-only for the status (media type: text/csv)
- info
  the response optional property became read-only for the status (media type: application/json)
- info
  the response optional property became read-only for the status (media type: text/csv)
- info
  the response optional property became read-only for the status (media type: application/json)
- info
  the response optional property became read-only for the status (media type: text/csv)
- info
  the response optional property became read-only for the status (media type: application/json)
- info
  the response optional property became read-only for the status (media type: text/csv)
- info
  the response optional property became read-only for the status (media type: application/json)
- info
  the response optional property became read-only for the status (media type: text/csv)
- info
  the response optional property became read-only for the status (media type: application/json)
- info
  the response optional property became read-only for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
Feb 17, 2025f5a1531aecbe Revision changes
- breaking
  the response's property type changed from object to no type for status (media type: application/json)
- breaking
  the response's property type changed from object to no type for status (media type: text/csv)
- breaking
  the response's property type changed from object to no type for status (media type: application/json)
- breaking
  the response's property type changed from object to no type for status (media type: text/csv)
- info
  api operation id oembedDocument removed and replaced with document_oembed_retrieve
- info
  the endpoint scheme security cookieAuth was added to the API
- info
  api tag document added
- info
  api tag api removed
- info
  added the new optional query request parameter format
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  the response property became required for the status (media type: application/json)
- info
  the response property became required for the status (media type: text/csv)
- info
  added the required property to the response with the status (media type: application/json)
- info
  added the required property to the response with the status (media type: text/csv)
- info
  added the required property to the response with the status (media type: application/json)
- info
  added the required property to the response with the status (media type: text/csv)
- info
  added the required property to the response with the status (media type: application/json)
- info
  added the required property to the response with the status (media type: text/csv)
- info
  added the required property to the response with the status (media type: application/json)
- info
  added the required property to the response with the status (media type: text/csv)

Operation history