Skip to main content

Quick Start Guide

This guide will help you get started with Pluslide, from account registration to making your first API call.

1. Sign Up​

  • Visit the Pluslide website and log in. If you have never logged in to Pluslide before, it will register a new account for you.

2. Create a Project​

  • After logging in, go to the Project page and click "New Project".
  • Enter your project name to create a project.

2.1 Add a Template​

  • Enter your project and click "New Template".
  • Name your Template Key; It is recommended to choose an identifiable name; the Template Key will be used as a unique identifier for API calls.

2.2 Create Fields​

  • In the editor, click "Add Field".
  • Select the field type (e.g., text, image, chart, group).
  • (Option) If needed, you can modify the field properties to customize its appearance.
  • Name your Field Key; It is recommended to choose an identifiable name; the Field Key will be used as a unique identifier for API calls.

2.3 Record Important Information​

  • Make sure to note your Project ID, Template Key, and Field Key. You will need these for API calls.

3. Generate an API Key​

  • Go to API Tokens page and click "Add Token".
  • Name your Token Name; it can be anything you like.
  • Copy the Token Secret to a secure location. (It will only be shown once.)

4. Make Your First API Call​

  • Refer to the API documentation to integrate Pluslide API into your backend or frontend project.
  • Include your API Key in the request header.
  • Provide Project ID, Template Key, Field Key, and data to dynamically generate a presentation.

Example (REST API)​

POST /api/v1/presentations
Authorization: Bearer <API_KEY>
Content-Type: application/json

{
  "projectId": "your_project_id",
  "presentation": {
    "slideList": [
      {
        "templateKey": "your_template_key",
        "content": {
          "your_field_key": "value1",
          "your_field_key2": "value2"
          ...
        }
      }
    ]
  }
}
  • If you are unsure about what to include in the slideList, you can go to the Playground page and select the Template you just created to test it out.
  • The response will include a task ID. You can use this ID to get the presentation link, or you can visit the Presentation page to download your presentation.

Congratulations on creating your first presentation! For advanced features, see the following sections or the full product documentation.