Open Inventory / Docs
EndpointsAiResourcesIdImage

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

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

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
mode*string
query?string

Optional brand, model, or exact-item search hint. Saved item details are always included.

Length1 <= length <= 500

Response Body

Image imported or generated, appended to the item, or completed response replayed

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

Generate a square studio or transparent cover from an item image POST

Previous Page

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

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.