API referenceMedia
Create a media recipe
Creates a recipe in the workspace with the key's owner as its creator. It starts at version 1 and is private to its creator unless visibility is team.
POST
https://app.xplantpro.com/Scope
write:media_recipesHonours Idempotency-KeyA component sent without an id is given one; keep the ids from the response to update the recipe later.
Send an Idempotency-Key header to make retries safe: a repeat with the same key within 24 hours returns the first response instead of writing twice. See Idempotency.
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Idempotency-Key | string | No | Any unique string you choose per logical write. A retry carrying the same key within 24 hours returns the first result instead of writing again. Scoped to your API key and this operation. 8–255 characters. Must match ^[A-Za-z0-9._:~-]+$. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | The recipe's name, for example MS + 1 mg/L BAP. 1–200 characters. |
components | object[] | Yes | The ingredients, in order. At least one. Up to 100 items. |
components[].id | string | No | Your id for this component. Kept as given; when left out, one is assigned and returned, so an update can send it back. 1–64 characters. |
components[].name | string | Yes | The ingredient, for example Sucrose or 6-BAP. 1–200 characters. |
components[].qty | string | Yes | The amount as the recipe writes it, for example 30 or 0.5. 1–50 characters. |
components[].unit | string | No | The unit of qty, for example g/L or mg/L. 1–20 characters. |
components[].concentration | string | No | A concentration, when the recipe states one apart from the amount. 1–50 characters. |
notes | string | No | Free-text notes, up to 500 characters. Up to 500 characters. |
status | "active" | "archived" | "deprecated" | "draft" | "published" | No | One of active, archived, deprecated, draft, published. Default "active". |
visibility | "private" | "team" | No | Who in the workspace can see the recipe. private: only the key's owner, who is recorded as its creator. team: everyone in the workspace. Default "private". |
is_public | boolean | No | Publish the recipe to xPlant's public recipe library, where anyone can read it. A draft recipe stays out of the library either way. Default false. |
origin | "user" | "imported" | No | imported for a recipe brought in from another system; user otherwise. Default "user". |
ph_target | number | null | No | Target pH, 0 to 14. Stored to two decimal places. From 0 to 14. |
sterilization_notes | string | null | No | How to sterilize the medium, up to 500 characters. Up to 500 characters. |
storage_notes | string | null | No | How to store the prepared medium, up to 500 characters. Up to 500 characters. |
usage_notes | string | null | No | How to use the medium, up to 500 characters. Up to 500 characters. |
Example
curl -X POST https://app.xplantpro.com/api/v1/media-recipes \
-H "Authorization: Bearer $XPLANT_API_KEY" \
-H "Idempotency-Key: recipes-sync-half-ms-v3" \
-H "Content-Type: application/json" \
-d '{
"title": "MS + 1 mg/L BAP",
"components": [
{
"name": "MS basal salts",
"qty": "4.4",
"unit": "g/L"
},
{
"name": "Sucrose",
"qty": "30",
"unit": "g/L"
},
{
"name": "6-BAP",
"qty": "1",
"unit": "mg/L"
},
{
"name": "Agar",
"qty": "7",
"unit": "g/L"
}
],
"notes": "Shoot multiplication medium for aroid cultures.",
"visibility": "team",
"ph_target": 5.8,
"sterilization_notes": "Autoclave for 20 minutes at 121 °C.",
"storage_notes": "Keep poured vessels at 4 °C and use within two weeks."
}'Response
201 with { "ok": true, "data": … }. data holds the result.
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | — |
title | string | Yes | — |
status | string | null | Yes | One of active, archived, deprecated, draft, published. |
origin | string | null | Yes | Where the recipe came from, for example user or imported. |
visibility | string | Yes | private: only its creator can see it. team: everyone in the workspace can. |
is_public | boolean | Yes | Published to xPlant's public recipe library. |
notes | string | null | Yes | — |
ph_target | number | null | Yes | Target pH. |
sterilization_notes | string | null | Yes | — |
storage_notes | string | null | Yes | — |
usage_notes | string | null | Yes | — |
components | object[] | Yes | The ingredients, in order. |
components[].id | string | Yes | The component's id. Send it back in an update to keep the component. |
components[].name | string | Yes | The ingredient. |
components[].qty | string | Yes | The amount as the recipe writes it. |
components[].unit | string | null | Yes | The unit of qty. |
components[].concentration | string | null | Yes | A concentration, when the recipe states one apart from the amount. |
version | integer | Yes | The recipe's version. It goes up by one each time the formulation changes, and every version is kept. |
created_by | string | Yes | User id of the workspace member who created the recipe. Only they can change it. |
created_at | string | null | Yes | ISO 8601. |
{
"ok": true,
"data": {
"id": "a3d5f7b9-1c2e-4f6a-8b0d-2e4f6a8c0e1f",
"title": "MS + 1 mg/L BAP",
"status": "active",
"origin": "user",
"visibility": "team",
"is_public": false,
"notes": "Shoot multiplication medium for aroid cultures.",
"ph_target": 5.8,
"sterilization_notes": "Autoclave for 20 minutes at 121 °C.",
"storage_notes": "Keep poured vessels at 4 °C and use within two weeks.",
"usage_notes": null,
"components": [
{
"id": "c1a2b3c4-d5e6-4f70-8a9b-0c1d2e3f4a5b",
"name": "MS basal salts",
"qty": "4.4",
"unit": "g/L",
"concentration": null
},
{
"id": "d2b3c4d5-e6f7-4a81-9b0c-1d2e3f4a5b6c",
"name": "Sucrose",
"qty": "30",
"unit": "g/L",
"concentration": null
},
{
"id": "e3c4d5e6-f7a8-4b92-8c1d-2e3f4a5b6c7d",
"name": "6-BAP",
"qty": "1",
"unit": "mg/L",
"concentration": null
},
{
"id": "f4d5e6f7-a8b9-4ca3-9d2e-3f4a5b6c7d8e",
"name": "Agar",
"qty": "7",
"unit": "g/L",
"concentration": null
}
],
"version": 1,
"created_by": "0d7e4b9a-6f21-4c3e-8a5b-2e9f1c7d4a60",
"created_at": "2026-09-25T14:12:03.000Z"
}
}| Response header | Meaning |
|---|---|
Idempotent-Replay | true when this response is a replay of an earlier request with the same Idempotency-Key. |
X-Request-Id | Identifies this request. Include it when you contact support. |
Errors
| Status | Code | When |
|---|---|---|
400 | VALIDATION_ERROR | The request body is not valid JSON. |
401 | UNAUTHORIZED | The key is missing, malformed or revoked, or its owner is no longer a member of the workspace. |
402 | PAID_PLAN_REQUIRED | The workspace's plan does not include the API. The full API is included with xPlant+ Teams and Enterprise; on Hobby and Pro Lab, keys can connect devices only. |
403 | FORBIDDEN | The key lacks a scope this operation requires, or its owner's current role in the workspace cannot use it — a key never does more than its owner can in xPlant. error names the scope, and for a role, the role it needs. |
403 | DEVICE_TOKEN_NOT_ACCEPTED | A device token was sent; this operation needs a workspace API key. |
409 | IDEMPOTENCY_IN_FLIGHT | A request with this Idempotency-Key is still being processed; retry after Retry-After seconds. |
422 | VALIDATION_ERROR | The Idempotency-Key header is malformed. |
422 | VALIDATION_ERROR | A field failed validation. error names the first one, for example title: title is required. |
429 | RATE_LIMIT_EXCEEDED | Too many requests for this key, device token or workspace. Wait Retry-After seconds. |
500 | MEDIA_RECIPE_CREATE_FAILED | The recipe could not be saved. Retry with the same Idempotency-Key. |
Branch on code, never on the error text. See Errors.
List media recipes
The workspace's culture media recipes that the key's owner can see — their own, and those shared with the workspace or published — newest first, each with its components. Another member's private recipe is not listed. Filter by status.
Get a media recipe
One recipe with its components and current version.