Skip to main content
POST
/
v1
/
items
/
{item_id}
Update item
curl --request POST \
  --url https://api.neuronsearchlab.com/v1/items/{item_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Wireless Headphones v2",
  "metadata": {
    "category": "electronics",
    "availability": "in_stock"
  },
  "active": true
}
'
{
  "id": "itm_7f3a2c9e",
  "object": "item",
  "name": "Wireless Headphones",
  "description": "Noise-cancelling Bluetooth headphones.",
  "metadata": {
    "category": "electronics",
    "brand": "Acme"
  },
  "active": true,
  "created": 1777478400,
  "updated_at": 1777478500
}

Documentation Index

Fetch the complete documentation index at: https://docs.neuronsearchlab.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

Updates an existing item. All body fields are optional, but at least one field must be supplied. If name, description, or metadata changes, the item embedding is refreshed. PATCH /v1/items/{item_id} is also available as a compatibility alias with the same request and response shape.

​
Request

POST /v1/items/itm_7f3a2c9e

{
  "name": "Wireless Headphones v2",
  "metadata": {
    "category": "electronics",
    "availability": "in_stock"
  },
  "active": true
}
FieldTypeRequiredDescription
namestringnoReplacement item name.
descriptionstringnoReplacement description.
metadataobjectnoReplacement metadata object.
activebooleannoWhether the item is eligible for recommendations.

​
Response

{
  "id": "itm_7f3a2c9e",
  "object": "item",
  "name": "Wireless Headphones v2",
  "description": "Noise-cancelling Bluetooth headphones.",
  "metadata": {
    "category": "electronics",
    "availability": "in_stock"
  },
  "active": true,
  "created": 1777478400,
  "updated_at": 1777478500
}

​
Errors

StatusScenario
400Malformed item ID, empty body, or invalid field
404Item does not exist for the authenticated tenant

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
item_id
string
required

Public item ID.

Pattern: ^itm_[A-Za-z0-9][A-Za-z0-9_-]{2,}$

Body

application/json

Partial item update. At least one field must be supplied.

​
name
string
Minimum string length: 1
​
description
string
​
metadata
object

Arbitrary JSON object used for filtering, ranking, and debugging.

Example:
{
  "category": "electronics",
  "brand": "Acme",
  "price": 10999,
  "currency": "usd"
}
​
active
boolean

Whether the item is eligible for recommendations.

Response

Updated item

​
id
string
required
Pattern: ^itm_[A-Za-z0-9][A-Za-z0-9_-]{2,}$
Example:

"itm_7f3a2c9e"

​
object
enum<string>
required
Available options:
item
​
name
string
required
Example:

"Wireless Headphones"

​
description
string
required
Example:

"Noise-cancelling Bluetooth headphones."

​
metadata
object
required

Arbitrary JSON object used for filtering, ranking, and debugging.

Example:
{
  "category": "electronics",
  "brand": "Acme",
  "price": 10999,
  "currency": "usd"
}
​
active
boolean
required
Example:

true

​
created
integer<int64> | null
required

Unix timestamp in seconds.

Example:

1777478400

​
updated_at
integer<int64> | null
required

Unix timestamp in seconds.

Example:

1777478500