Add a new item to property inventory. Optionally use AI to identify items from photos.
| Parameter | Type | Required | Description |
|---|---|---|---|
property_id | string | Yes | UUID of the property to add item to |
name | string | No | Item name (1-255 chars). Optional if photo provided. |
photo_url | string | No | URL to item photo for AI identification |
photo_base64 | string | No | Base64 encoded photo for AI identification |
room | string | No | Room where item is located |
notes | string | No | Additional notes (max 2000 chars) |
name, photo_url, or photo_base64. If only a photo is provided, AI will identify the item and use that as the name.{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "add_item",
"arguments": {
"property_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "KitchenAid Stand Mixer",
"room": "Kitchen",
"notes": "Wedding gift from 2022. Artisan 5-quart in Empire Red."
}
}
}
{
"jsonrpc": "2.0",
"id": 2,
"method": "tools/call",
"params": {
"name": "add_item",
"arguments": {
"property_id": "550e8400-e29b-41d4-a716-446655440000",
"photo_url": "https://example.com/photos/my-tv.jpg",
"room": "Living Room"
}
}
}
{
"jsonrpc": "2.0",
"id": 3,
"method": "tools/call",
"params": {
"name": "add_item",
"arguments": {
"property_id": "550e8400-e29b-41d4-a716-446655440000",
"photo_base64": "/9j/4AAQSkZJRg...",
"name": "Office Chair"
}
}
}
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"content": [
{
"type": "text",
"text": "{\"success\":true,\"item\":{\"id\":\"new-item-uuid\",\"name\":\"KitchenAid Stand Mixer\",\"brand\":null,\"model\":null},\"identified\":false,\"message\":\"Item added successfully\"}"
}
]
}
}
{
"jsonrpc": "2.0",
"id": 2,
"result": {
"content": [
{
"type": "text",
"text": "{\"success\":true,\"item\":{\"id\":\"new-item-uuid\",\"name\":\"Samsung 65\\\" QLED TV\",\"brand\":\"Samsung\",\"model\":\"QN65Q80B\"},\"identified\":true,\"message\":\"Item added successfully\"}"
}
]
}
}
{
"success": true,
"item": {
"id": "new-item-uuid",
"name": "Samsung 65\" QLED TV",
"brand": "Samsung",
"model": "QN65Q80B"
},
"identified": true,
"message": "Item added successfully"
}
| Field | Type | Description |
|---|---|---|
success | boolean | Whether the item was created |
item.id | string | UUID of the created item |
item.name | string | Final item name (provided or AI-identified) |
item.brand | string | null | Brand (from AI identification) |
item.model | string | null | Model number (from AI identification) |
identified | boolean | Whether AI identification was performed |
message | string | Success or error message |
When you provide a photo (URL or base64), OBI uses GPT-4o-mini to analyze the image and extract:
If you also provide a name, it will be used instead of the AI-identified name, but brand and model will still be extracted from the photo.
{
"content": [
{
"type": "text",
"text": "{\"error\": \"Must provide either name, photo URL, or base64 photo\"}"
}
],
"isError": true
}
{
"content": [
{
"type": "text",
"text": "{\"error\": \"Property not found or access denied\"}"
}
],
"isError": true
}
{
"content": [
{
"type": "text",
"text": "{\"error\": \"Failed to identify item\"}"
}
],
"isError": true
}
{
"content": [
{
"type": "text",
"text": "{\"error\": \"AI identification not configured\"}"
}
],
"isError": true
}