Open Inventory / Docs
EndpointsAiResourcesIdResearch

Add missing item details using saved content, images, and GPT web search

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}/research

Preserves existing fields, appends newly researched description details, merges tags and categories, fills tracking identifiers or value only at high confidence, and adds sourced internal notes only when blank.

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

Response Body

Missing details added, no reliable additions found, or completed response replayed

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

Find a reusable web image or generate a new AI image and append it to an item POST

Previous Page

Queue stale fields for background translation POST

Requires ai scope. Omit languageCodes to queue every active target language. Jobs are coalesced per resource and locale and survive restarts.