{ "service": "heyzine", "displayName": "Heyzine", "categories": [ "Design & Media", "Productivity" ], "authTypes": [ "api_key" ], "auth": [ { "type": "api_key", "label": "API Key", "placeholder": "heyzine_api_key", "description": "Heyzine API key sent with the Authorization: Bearer header. Log in or register on the developers page to view it." } ], "homepageUrl": "https://heyzine.com", "actions": [ { "id": "heyzine.add_flipbook_to_bookshelf", "service": "heyzine", "name": "add_flipbook_to_bookshelf", "description": "Add a flipbook to a specific Heyzine bookshelf.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Heyzine flipbook or bookshelf identifier." }, "flipbook_id": { "type": "string", "minLength": 1, "description": "The Heyzine flipbook identifier." }, "position": { "type": "integer", "minimum": 0, "description": "The optional 0-based position inside the bookshelf." } }, "additionalProperties": false, "required": [ "id", "flipbook_id" ], "description": "The input payload for adding a flipbook to a bookshelf." }, "outputSchema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the Heyzine operation succeeded." }, "code": { "type": "integer", "description": "The HTTP-like status code returned by Heyzine." }, "msg": { "type": "string", "description": "The status message returned by Heyzine." } }, "additionalProperties": false, "required": [ "success" ], "description": "The normalized result of a mutating Heyzine API operation." } }, { "id": "heyzine.delete_flipbook", "service": "heyzine", "name": "delete_flipbook", "description": "Delete a specific Heyzine flipbook.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Heyzine flipbook or bookshelf identifier." } }, "additionalProperties": false, "required": [ "id" ], "description": "The input payload for selecting a Heyzine resource." }, "outputSchema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the Heyzine operation succeeded." }, "code": { "type": "integer", "description": "The HTTP-like status code returned by Heyzine." }, "msg": { "type": "string", "description": "The status message returned by Heyzine." } }, "additionalProperties": false, "required": [ "success" ], "description": "The normalized result of a mutating Heyzine API operation." } }, { "id": "heyzine.get_flipbook", "service": "heyzine", "name": "get_flipbook", "description": "Get the details and oEmbed metadata for a specific Heyzine flipbook.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Heyzine flipbook or bookshelf identifier." } }, "additionalProperties": false, "required": [ "id" ], "description": "The input payload for selecting a Heyzine resource." }, "outputSchema": { "type": "object", "properties": { "flipbook": { "type": "object", "properties": { "id": { "type": "string", "description": "The Heyzine flipbook identifier." }, "date": { "type": "string", "description": "The publication date string returned by Heyzine." }, "title": { "anyOf": [ { "type": "string", "description": "The flipbook title." }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string", "description": "The flipbook subtitle." }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "description": "The flipbook description." }, { "type": "null" } ] }, "pages": { "type": "integer", "description": "The number of pages in the flipbook." }, "size": { "type": "integer", "description": "The PDF size in bytes when returned by Heyzine." }, "private": { "anyOf": [ { "type": "string", "description": "The private note associated with the flipbook when returned by Heyzine." }, { "type": "null" } ] }, "position": { "type": "integer", "description": "The 0-based bookshelf position returned by Heyzine." }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "The tags returned by Heyzine for the flipbook." }, "links": { "type": "object", "properties": { "custom": { "anyOf": [ { "type": "string", "description": "The custom domain URL for the flipbook when configured." }, { "type": "null" } ] }, "base": { "type": "string", "description": "The base Heyzine URL for the flipbook." }, "thumbnail": { "type": "string", "description": "The cover thumbnail URL for the flipbook." }, "pdf": { "type": "string", "description": "The downloadable PDF URL for the flipbook." } }, "additionalProperties": false, "description": "The public URLs returned by Heyzine for a flipbook." }, "oembed": { "type": "object", "properties": { "type": { "type": "string", "description": "The oEmbed content type." }, "version": { "type": "string", "description": "The oEmbed version string." }, "title": { "anyOf": [ { "type": "string", "description": "The title returned by the oEmbed payload." }, { "type": "null" } ] }, "provider_name": { "type": "string", "description": "The oEmbed provider name." }, "provider_url": { "type": "string", "description": "The oEmbed provider URL." }, "html": { "type": "string", "description": "The embed HTML snippet returned by Heyzine." }, "width": { "type": "integer", "description": "The embed width returned by Heyzine." }, "height": { "type": "integer", "description": "The embed height returned by Heyzine." }, "thumbnail_url": { "type": "string", "description": "The oEmbed thumbnail URL." }, "thumbnail_width": { "type": "integer", "description": "The oEmbed thumbnail width." }, "thumbnail_height": { "type": "integer", "description": "The oEmbed thumbnail height." } }, "additionalProperties": true, "required": [ "type", "version" ], "description": "The oEmbed payload returned by Heyzine for a flipbook." } }, "additionalProperties": false, "description": "A Heyzine flipbook resource." } }, "additionalProperties": false, "required": [ "flipbook" ], "description": "The normalized output payload for the get_flipbook action." } }, { "id": "heyzine.list_bookshelf_flipbooks", "service": "heyzine", "name": "list_bookshelf_flipbooks", "description": "List the flipbooks assigned to a specific Heyzine bookshelf.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Heyzine flipbook or bookshelf identifier." } }, "additionalProperties": false, "required": [ "id" ], "description": "The input payload for selecting a Heyzine resource." }, "outputSchema": { "type": "object", "properties": { "flipbooks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The Heyzine flipbook identifier." }, "date": { "type": "string", "description": "The publication date string returned by Heyzine." }, "title": { "anyOf": [ { "type": "string", "description": "The flipbook title." }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string", "description": "The flipbook subtitle." }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "description": "The flipbook description." }, { "type": "null" } ] }, "pages": { "type": "integer", "description": "The number of pages in the flipbook." }, "size": { "type": "integer", "description": "The PDF size in bytes when returned by Heyzine." }, "private": { "anyOf": [ { "type": "string", "description": "The private note associated with the flipbook when returned by Heyzine." }, { "type": "null" } ] }, "position": { "type": "integer", "description": "The 0-based bookshelf position returned by Heyzine." }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "The tags returned by Heyzine for the flipbook." }, "links": { "type": "object", "properties": { "custom": { "anyOf": [ { "type": "string", "description": "The custom domain URL for the flipbook when configured." }, { "type": "null" } ] }, "base": { "type": "string", "description": "The base Heyzine URL for the flipbook." }, "thumbnail": { "type": "string", "description": "The cover thumbnail URL for the flipbook." }, "pdf": { "type": "string", "description": "The downloadable PDF URL for the flipbook." } }, "additionalProperties": false, "description": "The public URLs returned by Heyzine for a flipbook." }, "oembed": { "type": "object", "properties": { "type": { "type": "string", "description": "The oEmbed content type." }, "version": { "type": "string", "description": "The oEmbed version string." }, "title": { "anyOf": [ { "type": "string", "description": "The title returned by the oEmbed payload." }, { "type": "null" } ] }, "provider_name": { "type": "string", "description": "The oEmbed provider name." }, "provider_url": { "type": "string", "description": "The oEmbed provider URL." }, "html": { "type": "string", "description": "The embed HTML snippet returned by Heyzine." }, "width": { "type": "integer", "description": "The embed width returned by Heyzine." }, "height": { "type": "integer", "description": "The embed height returned by Heyzine." }, "thumbnail_url": { "type": "string", "description": "The oEmbed thumbnail URL." }, "thumbnail_width": { "type": "integer", "description": "The oEmbed thumbnail width." }, "thumbnail_height": { "type": "integer", "description": "The oEmbed thumbnail height." } }, "additionalProperties": true, "required": [ "type", "version" ], "description": "The oEmbed payload returned by Heyzine for a flipbook." } }, "additionalProperties": false, "description": "A Heyzine flipbook resource." }, "description": "The flipbooks returned for the selected bookshelf." } }, "additionalProperties": false, "required": [ "flipbooks" ], "description": "The normalized output payload for the list_bookshelf_flipbooks action." } }, { "id": "heyzine.list_bookshelves", "service": "heyzine", "name": "list_bookshelves", "description": "List the bookshelves accessible with the current Heyzine API key.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": {}, "additionalProperties": false, "description": "No input parameters are required for this action." }, "outputSchema": { "type": "object", "properties": { "bookshelves": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The Heyzine bookshelf identifier." }, "title": { "anyOf": [ { "type": "string", "description": "The bookshelf title." }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "description": "The bookshelf description." }, { "type": "null" } ] }, "thumbnail": { "anyOf": [ { "type": "string", "description": "The bookshelf thumbnail URL." }, { "type": "null" } ] }, "flipbook_count": { "type": "integer", "description": "The number of flipbooks currently assigned to the bookshelf." } }, "additionalProperties": false, "description": "A Heyzine bookshelf resource." }, "description": "The bookshelves returned by Heyzine." } }, "additionalProperties": false, "required": [ "bookshelves" ], "description": "The normalized output payload for the list_bookshelves action." } }, { "id": "heyzine.list_flipbooks", "service": "heyzine", "name": "list_flipbooks", "description": "List the flipbooks accessible with the current Heyzine API key.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": {}, "additionalProperties": false, "description": "No input parameters are required for this action." }, "outputSchema": { "type": "object", "properties": { "flipbooks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The Heyzine flipbook identifier." }, "date": { "type": "string", "description": "The publication date string returned by Heyzine." }, "title": { "anyOf": [ { "type": "string", "description": "The flipbook title." }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string", "description": "The flipbook subtitle." }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "description": "The flipbook description." }, { "type": "null" } ] }, "pages": { "type": "integer", "description": "The number of pages in the flipbook." }, "size": { "type": "integer", "description": "The PDF size in bytes when returned by Heyzine." }, "private": { "anyOf": [ { "type": "string", "description": "The private note associated with the flipbook when returned by Heyzine." }, { "type": "null" } ] }, "position": { "type": "integer", "description": "The 0-based bookshelf position returned by Heyzine." }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "The tags returned by Heyzine for the flipbook." }, "links": { "type": "object", "properties": { "custom": { "anyOf": [ { "type": "string", "description": "The custom domain URL for the flipbook when configured." }, { "type": "null" } ] }, "base": { "type": "string", "description": "The base Heyzine URL for the flipbook." }, "thumbnail": { "type": "string", "description": "The cover thumbnail URL for the flipbook." }, "pdf": { "type": "string", "description": "The downloadable PDF URL for the flipbook." } }, "additionalProperties": false, "description": "The public URLs returned by Heyzine for a flipbook." }, "oembed": { "type": "object", "properties": { "type": { "type": "string", "description": "The oEmbed content type." }, "version": { "type": "string", "description": "The oEmbed version string." }, "title": { "anyOf": [ { "type": "string", "description": "The title returned by the oEmbed payload." }, { "type": "null" } ] }, "provider_name": { "type": "string", "description": "The oEmbed provider name." }, "provider_url": { "type": "string", "description": "The oEmbed provider URL." }, "html": { "type": "string", "description": "The embed HTML snippet returned by Heyzine." }, "width": { "type": "integer", "description": "The embed width returned by Heyzine." }, "height": { "type": "integer", "description": "The embed height returned by Heyzine." }, "thumbnail_url": { "type": "string", "description": "The oEmbed thumbnail URL." }, "thumbnail_width": { "type": "integer", "description": "The oEmbed thumbnail width." }, "thumbnail_height": { "type": "integer", "description": "The oEmbed thumbnail height." } }, "additionalProperties": true, "required": [ "type", "version" ], "description": "The oEmbed payload returned by Heyzine for a flipbook." } }, "additionalProperties": false, "description": "A Heyzine flipbook resource." }, "description": "The flipbooks returned by Heyzine." } }, "additionalProperties": false, "required": [ "flipbooks" ], "description": "The normalized output payload for the list_flipbooks action." } }, { "id": "heyzine.remove_flipbook_from_bookshelf", "service": "heyzine", "name": "remove_flipbook_from_bookshelf", "description": "Remove a flipbook from a specific Heyzine bookshelf.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Heyzine flipbook or bookshelf identifier." }, "flipbook_id": { "type": "string", "minLength": 1, "description": "The Heyzine flipbook identifier." } }, "additionalProperties": false, "required": [ "id", "flipbook_id" ], "description": "The input payload for selecting a Heyzine bookshelf and flipbook." }, "outputSchema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the Heyzine operation succeeded." }, "code": { "type": "integer", "description": "The HTTP-like status code returned by Heyzine." }, "msg": { "type": "string", "description": "The status message returned by Heyzine." } }, "additionalProperties": false, "required": [ "success" ], "description": "The normalized result of a mutating Heyzine API operation." } }, { "id": "heyzine.set_bookshelf_social_data", "service": "heyzine", "name": "set_bookshelf_social_data", "description": "Set the social sharing metadata for a specific Heyzine bookshelf.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Heyzine flipbook or bookshelf identifier." }, "title": { "type": "string", "description": "The optional social sharing title." }, "description": { "type": "string", "description": "The optional social sharing description." }, "thumbnail": { "type": "string", "description": "The URL for the social sharing thumbnail image." } }, "additionalProperties": false, "required": [ "id" ], "description": "The social metadata values to update in Heyzine. At least one of title, description, or thumbnail is required." }, "outputSchema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the Heyzine operation succeeded." }, "code": { "type": "integer", "description": "The HTTP-like status code returned by Heyzine." }, "msg": { "type": "string", "description": "The status message returned by Heyzine." } }, "additionalProperties": false, "required": [ "success" ], "description": "The normalized result of a mutating Heyzine API operation." } }, { "id": "heyzine.set_flipbook_social_data", "service": "heyzine", "name": "set_flipbook_social_data", "description": "Set the social sharing metadata for a specific Heyzine flipbook.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Heyzine flipbook or bookshelf identifier." }, "title": { "type": "string", "description": "The optional social sharing title." }, "description": { "type": "string", "description": "The optional social sharing description." }, "thumbnail": { "type": "string", "description": "The URL for the social sharing thumbnail image." } }, "additionalProperties": false, "required": [ "id" ], "description": "The social metadata values to update in Heyzine. At least one of title, description, or thumbnail is required." }, "outputSchema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the Heyzine operation succeeded." }, "code": { "type": "integer", "description": "The HTTP-like status code returned by Heyzine." }, "msg": { "type": "string", "description": "The status message returned by Heyzine." } }, "additionalProperties": false, "required": [ "success" ], "description": "The normalized result of a mutating Heyzine API operation." } } ] }