| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.yumpu.com/2.0 | link | — | — | — |
Actions (38)
Document · 17
- Create document (file)POST /document/file.json
Create a new document by uploading a PDF/file.
documented - Create document (url)POST /document/url.json
Create a new document from a publicly accessible URL.
documented - Create document hotspotPOST /document/hotspot.json
Create a new hotspot on a document.
documented - Delete documentDELETE /document.json
Delete an existing document.
documented - Delete document hotspotDELETE /document/hotspot.json
Delete a hotspot on a document.
documented - Get documentGET /document.json
Retrieve an existing document by ID (query parameter).
documented - Get document hotspotGET /document/hotspot.json
Retrieve a single hotspot by its ID.
documented - Get document progressGET /document/progress.json
Retrieve the current rendering/progress status for a document.
documented - Get document progressGET /document/progress.json
Query the render/progress state for a document progress ID.
documented - List countriesGET /countries.json
Retrieve a list of countries supported by the API.
documented - List document categoriesGET /document/categories.json
Retrieve the list of document categories.
documented - List document categoriesGET /document/categories.json
List all document categories.
documented - List document hotspotsGET /document/hotspots.json
Retrieve hotspots for a document (supports filtering by page).
documented - List document languagesGET /document/languages.json
Retrieve the list of languages supported by documents.
documented - List document languagesGET /document/languages.json
List supported document languages.
documented - Update documentPUT /document.json
Update an existing document's metadata.
documented - Update document hotspotPUT /document/hotspot.json
Update an existing hotspot.
documented
Collections · 9
- Create collectionPOST /collection.json
Create a new collection.
documented - Create sectionPOST /collection/section.json
Create a new section within a collection.
documented - Delete collectionDELETE /collection.json
Delete a collection.
documented - Delete sectionDELETE /collection/section.json
Delete a section.
documented - Get collectionGET /collection.json
Retrieve an existing collection by ID.
documented - Get sectionGET /collection/section.json
Retrieve a section within a collection by ID.
documented - List collectionsGET /collections.json
Retrieve a paginated list of collections.
documented - Update collectionPUT /collection.json
Update an existing collection.
documented - Update sectionPUT /collection/section.json
Update an existing section.
documented
Embed · 5
- Create embedPOST /embed.json
Create a new embed for a document.
documented - Delete embedDELETE /embed.json
Delete an embed.
documented - Get embedGET /embed.json
Get a specific embed by ID.
documented - Get embedGET /embed.json
Retrieve a single embed by ID.
documented - Update embedPUT /embed.json
Update an existing embed.
documented