Search published recipes | TRMNL Octri Demo

5 parameters

querystringoptional

Keywords, or #category

sort_bystringoptional

: * `newest` * `oldest` * `popularity` * `install` * `fork`

Allowed:newestoldestpopularityinstallfork

limitintegeroptional

1 to 25, default 10

page_sizeintegeroptional

Selects a cursor page with items and next_cursor instead of the default array

cursorstringoptional

Opaque cursor bound to this account and filters

2 status codes

200Lists the newest recipes when no query is given

dataarray<object>optional

401Unauthorized

errorstringoptional

Error handling

A 401 is returned: Unauthorized.

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.list({
  query: "keyword",
  sortBy: "example",
  limit: 20,
  pageSize: 20,
  cursor: "example",
});

{
  "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