Recipes

Get a recipe

Retrieve a recipe by name

get/recipes/{owner}/{name}

Request

Base URL
https://api.pollination.solutions (the document declares no server; this is the origin it was published from)
Auth
- HTTP bearer
- or API key in header x-pollination-token
TypeScript
https://skmtc.dev/pollination/apis/pollination-server/docs/recipes/:owner/:name/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

ownerstring required

namestring required

Response

Retrieved

publicboolean

Whether or not a repository is publicly viewable

keywordsstring[]

A list of keywords to index the repository by

descriptionstring

A description of the repository

iconstring

An icon to represent this repository

namestring required

The name of the repository

idstring required

The recipe unique ID

latest_tagstring required

The latest package version to be indexed

slugstring

The repository slug

Example response

{
  "keywords": [
    "daylight",
    "radiance"
  ],
  "description": "Run daylight simulations the easy way!",
  "icon": "https://avatars1.githubusercontent.com/u/38131342",
  "name": "daylight-factor",
  "id": "5d5e7103-2c1e-413f-9332-f8ec4a9aace7",
  "latest_tag": "0.2.1",
  "owner": {
    "id": "0ad77f99-8043-46e4-8220-7221487c3ee5",
    "account_type": "user",
    "name": "ladybugbot",
    "display_name": "Ladybug Bot",
    "description": "Beep Boop!"
  },
  "permissions": {
    "read": true
  },
  "slug": "ladybug-tools/daylight-factor"
}

Changes

No recorded changes to this operation across all 1 revision of this API.