Slideform REST API

import requests

API_KEY = "ta_your_key"
BASE    = "https://rest.slideform.co"
HEADERS = {"x-api-key": API_KEY}

resp = requests.get(f"{BASE}/projects", headers=HEADERS)
for p in resp.json()["projects"]:
    print(f"{p['id']}  {p['name']}")

const API_KEY = "ta_your_key";
const BASE    = "https://rest.slideform.co";
const headers = { "x-api-key": API_KEY };

const resp = await fetch(`${BASE}/projects`, { headers });
const data = await resp.json();

data.projects.forEach(p => console.log(p.id, p.name));

require "net/http"
require "json"

API_KEY = "ta_your_key"
BASE    = "https://rest.slideform.co"

uri = URI("#{BASE}/projects")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = API_KEY

resp = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(resp.body)

data["projects"].each { |p| puts "#{p['id']}  #{p['name']}" }

import time
import requests

API_KEY = "ta_your_key"
BASE    = "https://rest.slideform.co"
HEADERS = {"x-api-key": API_KEY}

# 1. Submit a job
job = requests.post(
    f"{BASE}/job",
    headers=HEADERS,
    json={
        "project": "abc123",
        "pragmas": {
            "{{report_date}}": "2026-03-01",
            "{{region}}": "North America",
        },
    },
).json()

job_id = job["id"]
print(f"Submitted job: {job_id}")

# 2. Poll for completion
while True:
    status = requests.get(
        f"{BASE}/status/{job_id}", headers=HEADERS
    ).json()

    if status["status"] == "ok":
        print("Job complete!")
        break
    elif status["status"] == "failed":
        raise RuntimeError("Job failed")

    print(f"Status: {status['status']} — waiting 5s...")
    time.sleep(5)

# 3. Download the file
file_name = status["file_name"]
resp = requests.get(
    f"{BASE}/job/{job_id}/file", headers=HEADERS
)

with open(file_name, "wb") as f:
    f.write(resp.content)

print(f"Downloaded: {file_name}")

import { writeFile } from "node:fs/promises";

const API_KEY = "ta_your_key";
const BASE    = "https://rest.slideform.co";
const headers = { "x-api-key": API_KEY, "Content-Type": "application/json" };

// 1. Submit a job
const jobResp = await fetch(`${BASE}/job`, {
  method: "POST",
  headers,
  body: JSON.stringify({
    project: "abc123",
    pragmas: {
      "{{report_date}}": "2026-03-01",
      "{{region}}": "North America",
    },
  }),
});
const job = await jobResp.json();
const jobId = job.id;
console.log(`Submitted job: ${jobId}`);

// 2. Poll for completion
let status;
while (true) {
  const r = await fetch(`${BASE}/status/${jobId}`, { headers });
  status = await r.json();

  if (status.status === "ok") {
    console.log("Job complete!");
    break;
  } else if (status.status === "failed") {
    throw new Error("Job failed");
  }

  console.log(`Status: ${status.status} — waiting 5s...`);
  await new Promise(r => setTimeout(r, 5000));
}

// 3. Download the file
const fileResp = await fetch(`${BASE}/job/${jobId}/file`, { headers });
const buffer = Buffer.from(await fileResp.arrayBuffer());
await writeFile(status.file_name, buffer);
console.log(`Downloaded: ${status.file_name}`);

require "net/http"
require "json"

API_KEY = "ta_your_key"
BASE    = "https://rest.slideform.co"

def api_get(path)
  uri = URI("#{BASE}#{path}")
  req = Net::HTTP::Get.new(uri)
  req["x-api-key"] = API_KEY
  Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
end

def api_post(path, body)
  uri = URI("#{BASE}#{path}")
  req = Net::HTTP::Post.new(uri, "Content-Type" => "application/json", "x-api-key" => API_KEY)
  req.body = body.to_json
  Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
end

# 1. Submit a job
resp = api_post("/job", {
  project: "abc123",
  pragmas: {
    "{{report_date}}" => "2026-03-01",
    "{{region}}"     => "North America",
  }
})
job = JSON.parse(resp.body)
job_id = job["id"]
puts "Submitted job: #{job_id}"

# 2. Poll for completion
status = nil
loop do
  status = JSON.parse(api_get("/status/#{job_id}").body)

  case status["status"]
  when "ok"
    puts "Job complete!"
    break
  when "failed"
    abort "Job failed"
  end

  puts "Status: #{status['status']} — waiting 5s..."
  sleep 5
end

# 3. Download the file
file_resp = api_get("/job/#{job_id}/file")
file_name = status["file_name"]
File.binwrite(file_name, file_resp.body)
puts "Downloaded: #{file_name}"

import requests

API_KEY = "ta_your_key"
BASE    = "https://rest.slideform.co"
HEADERS = {"x-api-key": API_KEY}

# 1. Upload the image
with open("logo.png", "rb") as f:
    upload = requests.post(
        f"{BASE}/files",
        headers={"x-api-key": API_KEY},
        files={"file": f},
    ).json()

print(f"Uploaded: {upload['id']}")

# 2. Submit a job referencing the uploaded image
job = requests.post(
    f"{BASE}/job",
    headers=HEADERS,
    json={
        "project": "abc123",
        "pragmas": {
            "{{report_date}}": "2026-03-01",
            "{{logo}}": "logo.png",
        },
        "options": {
            "{{logo}}": {"type": "image", "crop": True},
        },
    },
).json()

print(f"Job submitted: {job['id']}")

import { readFile } from "node:fs/promises";

const API_KEY = "ta_your_key";
const BASE    = "https://rest.slideform.co";

// 1. Upload the image
const form = new FormData();
form.append("file", new Blob([await readFile("logo.png")]), "logo.png");

const upload = await fetch(`${BASE}/files`, {
  method: "POST",
  headers: { "x-api-key": API_KEY },
  body: form,
});
const uploadData = await upload.json();
console.log(`Uploaded: ${uploadData.id}`);

// 2. Submit a job referencing the uploaded image
const job = await fetch(`${BASE}/job`, {
  method: "POST",
  headers: { "x-api-key": API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    project: "abc123",
    pragmas: {
      "{{report_date}}": "2026-03-01",
      "{{logo}}": "logo.png",
    },
    options: {
      "{{logo}}": { type: "image", crop: true },
    },
  }),
});
const jobData = await job.json();
console.log(`Job submitted: ${jobData.id}`);

require "net/http"
require "json"

API_KEY = "ta_your_key"
BASE    = "https://rest.slideform.co"

# 1. Upload the image
uri = URI("#{BASE}/files")
file = File.open("logo.png", "rb")
form = [["file", file, { filename: "logo.png" }]]
req = Net::HTTP::Post.new(uri)
req["x-api-key"] = API_KEY
req.set_form(form, "multipart/form-data")

resp = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
upload = JSON.parse(resp.body)
puts "Uploaded: #{upload['id']}"

# 2. Submit a job referencing the uploaded image
uri = URI("#{BASE}/job")
req = Net::HTTP::Post.new(uri, "Content-Type" => "application/json", "x-api-key" => API_KEY)
req.body = {
  project: "abc123",
  pragmas: {
    "{{report_date}}" => "2026-03-01",
    "{{logo}}"     => "logo.png",
  },
  options: {
    "{{logo}}" => { type: "image", crop: true },
  }
}.to_json

resp = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
job = JSON.parse(resp.body)
puts "Job submitted: #{job['id']}"

resp = requests.post(
    f"{BASE}/email/send",
    headers=HEADERS,
    json={
        "html": "<h1>Monthly Report</h1><p>Attached.</p>",
        "subject": "March 2026 Report",
        "recipients": ["team@example.com"],
    },
).json()

print(resp["message"])  # "Email sent to 1 recipient(s)"

const resp = await fetch(`${BASE}/email/send`, {
  method: "POST",
  headers,
  body: JSON.stringify({
    html: "<h1>Monthly Report</h1><p>Attached.</p>",
    subject: "March 2026 Report",
    recipients: ["team@example.com"],
  }),
});
const result = await resp.json();
console.log(result.message); // "Email sent to 1 recipient(s)"

resp = api_post("/email/send", {
  html:       "<h1>Monthly Report</h1><p>Attached.</p>",
  subject:    "March 2026 Report",
  recipients: ["team@example.com"],
})
data = JSON.parse(resp.body)
puts data["message"]  # "Email sent to 1 recipient(s)"