GET /v1/recipes/{id}

Read a recipe

Permission

A key with chosen permissions needs recipes.read. A key made with every permission may always call it.

Parameters

• id (path)string · required

  uuid

Response: Recipe

200 · A template that asks a few questions and makes something.

• object"recipe"

• idstring

  uuid

• namestring

• descriptionstring

• actionstring

  `arm` makes one generation from your answers; `reprompt` does too, with a model writing the prompt from them; `run` starts a multi-step run (`GET /v1/runs/{id}`). New values may be added.

  one of "arm", "reprompt", "run"

• typestring

  What it makes. New values may be added.

  one of "image", "clip", "voiceover", "music"

• modelstring | null

  The default model; null on a `run` recipe, whose steps choose their own.

• recommended_modelsstring[]

  Models its author tested. Any model of its medium that can take its inputs runs it too.

• promptobject | null

  What `prompt` asks for when you run it; null when it asks for none.

• inputsobject[]

  The media an `arm` or `reprompt` recipe takes, by key.

• choicesobject[]

• run_inputsobject[]

  What a `run` recipe takes, by key; empty on the others.

• tagsstring[]

• usesinteger

• cover_urlstring | null

  uri

• app_urlstring

  uri

Example

The required fields only, each a placeholder. Replace them before sending.

curl "https://api.meetkuro.com/v1/recipes/<id>" \
  -H "Authorization: Bearer $KURO_API_KEY"

import { Kuro } from "@meetkuro/sdk";

const kuro = new Kuro(); // reads KURO_API_KEY
await kuro.recipes.get("<id>");

Every operation