πŸ–ΌοΈSearch by Image or Model

Learn how to search for assets across your collections via image or model.

Get similar 3D models and images based on a search image

GET https://api.echo3D.com/imageSearch?key=<API_KEY>&keys=<API_KEYS>&file=<IMAGE_BINARY>

This query allows you to retrieve similar 3D models and image assets across a list of collections that match the associated search image file.

Query Parameters

Name
Type
Description

key*

string

Your API key.

secKey*

string

Your Secret key. Only if enabled through the Security page.

email*

string

Your email address

userKey*

string

Your authentication key

keys*

string

A comma separated string of API keys.

The collection associated with each API key will be searched through to find assets that match the input search image.

file*

binary

The search image file. Must be of type .jpg, .jpeg, or .png.

threshold

float

The minimum similarity score an asset must have to be included in the response. Value must be between 0 and 1, where 0 is least similar and 1 is most similar. When this value is not included, it defaults to 0.5.

getScore

boolean

If true, the similarity score of each asset will be returned in the response.

Request:

Name
Value

key

late-sea-5767

secKey

<YOUR-SEC-KEY>

userKey

<YOUR-USER-KEY>

email

<YOUR-EMAIL>

keys

broad-butterfly-4544,patient-term-4545,late-sea-5767

file

binary

Response body:

{
  "broad-butterfly-4544": [
    "entry-id-1",
    "entry-id-2"
  ],
  "patient-term-4545": [],
  "late-sea-5767": [
    "entry-id-3"
  ]
}

Get similar 3D models and images based on a search model

GET https://api.echo3D.com/imageSearch?key=<API_KEY>&keys=<API_KEYS>&entryId=<SEARCH_ENTRY_ID>&operation="entrySearch"

This query allows you to retrieve similar 3D models and image assets across a list of collections that match one of your existing echo3D assets.

Query Parameters

Name
Type
Description

key*

string

Your API key.

secKey*

string

Your Secret key. Only if enabled through the Security page.

email*

string

Your email address

userKey*

string

Your authentication key

keys*

string

A comma separated string of API keys.

The collection associated with each API key will be searched through to find assets that match the input search image.

entryId*

string

The entryId of the existing echo3D asset you are finding similar assets for. Must be of type .obj, .glb, or .usdz.

operation*

string

Defines that we must use the entryIdas the search criteria. Should have value "entrySearch".

threshold

float

The minimum similarity score an asset must have to be included in the response. Value must be between 0 and 1, where 0 is least similar and 1 is most similar. When this value is not included, it defaults to 0.5.

getScore

boolean

If true, the similarity score of each asset will be returned in the response.

Request:

Name
Value

key

late-sea-5767

secKey

<YOUR-SEC-KEY>

userKey

<YOUR-USER-KEY>

email

<YOUR-EMAIL>

operation

entrySearch

keys

broad-butterfly-4544,patient-term-4545,late-sea-5767

entryId

entry-id-2

Response body:

{
  "broad-butterfly-4544": [
    "entry-id-1",
    "entry-id-2"
  ],
  "patient-term-4545": [],
  "late-sea-5767": [
    "entry-id-3"
  ]
}

Last updated

Was this helpful?