Read a recipe and how it installs

1 parameter

idintegerrequired

Recipe id

3 status codes

200A recipe with custom fields must be forked so the installer can fill them

dataobjectoptional

401Unauthorized

errorstringoptional

404Not a published recipe

Error handling

A 401 is returned: Unauthorized. A 404 is returned: Not a published recipe.

import { Client } from "trmnl-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{defaultHost}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.recipes.get({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "data": {
    "ai_keywords": [
      "example_key_abc123"
    ],
    "ai_tags": [
      "example_value"
    ],
    "author": "Ada",
    "categories": [
      "example_value"
    ],
    "custom_fields": [
      {}
    ],
    "description": "Example description",
    "id": 1,
    "install_choices": [
      {}
    ],
    "install_method": "simple_install",
    "kind": "official",
    "name": "Train Departures",
    "published_at": "example_value",
    "requirements": [
      "example_value"
    ],
    "screenshot_url": "https://example.com",
    "share_oauth_config": true,
    "source_revision": "example_value",
    "stats": {
      "forks": 1,
      "installs": 1
    },
    "strategy": "polling"
  }
}

Request

Response

Errors