Docs

Placid API Documentation

This is the complete API documentation for connecting to the Placid API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Placid: Generate images, PDFs, and videos from templates. Keep reading to get started.

Quickstart

Before you run your first Placid request, you need three things:

  1. A MindCloud account — sign in or create an account at MindCloud.
  2. A MindCloud API Key — create one in API Keys. Keep it on your server.
  3. At least one Placid connection — create or choose one in Connections. Note its connectionId.

Every Placid action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/placid/latest/actions/{actionSlug}

You need a MindCloud API Key and a Placid connection. Then call an action such as Get Collection:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/placid/latest/actions/get-collection" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Placid account that should run the action. MindCloud stores and refreshes the Placid credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Get your Placid API token

You need access to the Placid project that contains the templates you want to use.

  1. Open the Placid project you want to use

    Placid API tokens are project-specific. Choose the project that contains the templates you plan to generate from.

  2. Copy the API token from the project overview

    Open the project overview and copy the Placid API token for that project.

  3. Paste the token into the MindCloud connection

    Use the copied token as the API key for this Placid connection.

  4. Verify the token against a template in the same project

    Run a safe read such as List Templates or Get Template. The token and template UUID must belong to the same Placid project.

Placid actions

All 21 published actions for this Placid version. Each page documents the endpoint, arguments, and response controls.

More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.