Open Inventory / Docs
EndpointsAiResourcesIdAnalyze

Generate structured item fields from the first three images

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

POST
/resources/{id}/analyze

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Path Parameters

id*string
Formatuuid

Header Parameters

Idempotency-Key?string

UUID identifying one queue operation; safe to reuse for retries.

Formatuuid
X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Request Body

application/json
  1. body
overwrite?boolean
Defaulttrue
prompt?string

Optional replacement for the built-in inventory-analysis prompt. Omit it to use the server default.

Lengthlength <= 5000

Response Body

Item enriched or completed response replayed

Example Request
curl -X POST 'https://inventory.example.com/api/v1/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08/analyze' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
Empty