Skip to main content
POST

​
Description

Creates one or more catalog items. NeuronSearchLab generates each positive integer item ID. Store the returned id; use it for events and POST /v1/items/{item_id} updates.

​
Request

Do not send id, item_id, or itemId. IDs are generated by NeuronSearchLab during ingestion. You can also send an array of item objects to create multiple items in one call.

​
Response

When the request body is an array, the response is a list envelope (object: "list") whose data array contains every created item. A single-item request returns the item resource directly.

​
Errors

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required
Minimum string length: 1
Example:

"Wireless Headphones"

​
description
string
Example:

"Noise-cancelling Bluetooth headphones."

​
metadata
object

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

Example:

Response

Created item or created item list

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

"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:
​
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