---
title: "Recipe detail"
method: GET
path: "/v1/recipes/{name}"
tags: ["recipes"]
---

# Recipe detail

`GET /v1/recipes/{name}`

## Request

- Base URL: `https://api.briq.cloud`
- URL: `https://api.briq.cloud/v1/recipes/{name}`
- Auth: none declared

## Path parameters

- `name` string, required

## Response `200`

ok

- object
  - `recipe` object, required
    - `name` string, required
    - `title` string, required
    - `description` string, required
    - `tags` string[], required
    - `params` object, required: The params a run gets when it passes none: the defaults, not every param
    - `parameters` RecipeParam[], required: Every param the recipe takes, optional ones included, with what it does
      - `name` string, required
      - `type` string, required
      - `options` string[], nullable, required: The allowed values, for an enum
      - `defaultValue` string, nullable, required: JSON of the default, when there is one
      - `required` boolean, required
      - `description` string, nullable, required
      - `format` string, nullable: The shape of a record or object value, e.g. `{ url, ref?, dir?, token? }`
    - `outputs` string[], required
    - `briqs` object[], required
      - `name` string, required
      - `image` string, required
      - `ports` number[], required
    - `docs` string, required: The recipe's page, as `briq_docs` names it: `cookbook/<name>`
    - `guides` string[], required: Guides that walk through a task with this recipe, as `briq_docs` names them

## Other responses

- `404`: ok

---

[API](https://skmtc.dev/briq/apis/briq-api.md) · [All operations](https://skmtc.dev/briq/apis/briq-api/llms.txt) · [OpenAPI document](https://skmtc.dev/briq/apis/briq-api/revisions/609b424459cb?raw)