# /nytimes/recipes

`POST /api/nytimes/recipes`

Price: 1 credit

Get one NYT Cooking recipe by URL: title, the cook's introduction, every ingredient with its quantity and unit, the preparation steps in order, the cook's notes, prep, cook and total times in minutes, how many readers rated it, the recipe tags by kind, the byline, the lead photograph with its credit, and the publication, last-edit and last-revision times.

## How to use it

Fetch one cooking.nytimes.com recipe. recipe takes the full URL, the 'recipes/<id>-<slug>' path with its slug, or the nyt://recipe/<uuid> uri that nytimes/articles/search returns as uri when types includes recipe. The numeric part alone does not address a recipe — NYT resolves the URL only with its slug attached. ingredients carry name plus quantity and unit where NYT states them; steps is the ordered preparation text; notes holds the cook's asides; cook_time_minutes, prep_time_minutes and total_time_minutes are minutes. byline names the cooks — NYT publishes no linkable author profile on a recipe, so there is no authors list here. source_id is the numeric id inside the recipe URL; updated_at moves on any edit while major_update_at moves only when the kitchen revises the recipe itself. A URL that points at a NYT Cooking article or collection rather than a recipe is rejected.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `recipe` (string, required) — NYT Cooking recipe URL, its recipes/<id>-<slug> path, or a nyt://recipe/<uuid> identifier (examples: "https://cooking.nytimes.com/recipes/1027652-hummus-soup-with-crispy-chickpeas", "recipes/767820572-creamy-tomato-hummus-soup", "nyt://recipe/9979aa3f-1de7-5f86-ad9a-1a5f335d7cb2"; minLength: 1)

## Response

### 200 — Successful Response

- `@type` (string) (default: "NytimesRecipe")
- `uri` (string, required)
- `source_id` (string, nullable)
- `asset_type` (string, required)
- `document_type` (string, nullable)
- `web_url` (string, nullable)
- `alias` (string, nullable)
- `document_title` (string, required)
- `seo_title` (string, nullable)
- `promotional_headline` (string, nullable)
- `published_at` (integer, nullable)
- `updated_at` (integer, nullable)
- `major_update_at` (integer, nullable)
- `tone` (string, nullable)
- `byline` (string, nullable)
- `image` (object, nullable)
  - `@type` (string) (default: "NytimesImage")
  - `uri` (string, nullable)
  - `image` (string, required)
  - `width` (integer, nullable)
  - `height` (integer, nullable)
  - `caption` (string, nullable)
  - `credit` (string, nullable)
  - `alt_text` (string, nullable)
- `description` (string, nullable)
- `notes` (array) (default: [])
- `cook_time_minutes` (integer, nullable)
- `prep_time_minutes` (integer, nullable)
- `total_time_minutes` (integer, nullable)
- `rating_count` (integer, nullable)
- `ingredients` (array) (default: [])
  - `@type` (string) (default: "NytimesIngredient")
  - `name` (string, required)
  - `quantity` (number, nullable)
  - `unit` (string, nullable)
- `steps` (array) (default: [])
- `recipe_tags` (array) (default: [])
  - `@type` (string) (default: "NytimesRecipeTag")
  - `name` (string, required)
  - `tag_type` (string, nullable)
- `comment_status` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

No NYT Cooking recipe at this identifier, or it points at another kind of page

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.

