---
title: "vision.find-request@1 · OpenVibe.Services"
canonical: "https://openvibe.services/docs/contracts/vision.find-request"
updated: null
---

# vision.find-request@1 · OpenVibe.Services

HTML: [vision.find-request@1 · OpenVibe.Services](https://openvibe.services/docs/contracts/vision.find-request)

# VisionFindRequest `vision.find-request@1`

Generated at 2026-11-13 06:25:48 UTC from [`openvibe-contracts v0.419.0`](https://github.com/OpenVibers/OpenVibe.Contracts/tree/v0.419.0) and [`openvibe-sdk v0.161.0`](https://github.com/OpenVibers/OpenVibe.SDK/tree/v0.161.0).

- Version: 1.0.0
- Owner: vision
- Visibility: first-party
- Status: active
- Compatibility: backward
- Schema: [`https://openvibe.network/contracts/vision/find-request.v1.json`](/docs/contracts/vision.find-request.json)

vision.find-request@1: the body of POST /api/v1/index and of GET or POST /api/v1/find. \`index\` stores a scoped CLIP embedding for one of the caller's own items (\`item\_id\`, optional \`result\_url\`); \`find\` searches only the caller's own private index, by words (\`q\`) or by an example image. No public image index is ever built.

## Fields

| Field | Type | Required | Description | Constraints |
| --- | --- | --- | --- | --- |
| `image` | string |  | The image as a data URL (base64). | - `pattern ^data:image/` |
| `image_url` | string |  | A public image URL, fetched through Vision's private-address guard. | - `pattern ^https?://`<br>- `format uri` |
| `q` | string |  |  | - `minLength 1`<br>- `maxLength 500` |
| `item_id` | string |  |  | - `pattern ^[\w:.-]{1,200}$` |
| `result_url` | string |  |  | - `pattern ^https://`<br>- `format uri` |

## Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

 Valid: one

~~~~
{
  "q": "red bike by the pier"
}
~~~~

Rejected: one

~~~~
{
  "q": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
~~~~

## Validate

~~~~
const contracts = require('openvibe-contracts');
contracts.validate('vision.find-request@1', value);   // { valid, errors: [{ path, message }] }
~~~~