VizSeek API

easy peasy

API Intro

The VizSeek API provides a simple RESTful interface with lightweight JSON-formatted responses to use many of VizSeek's website features using OAuth. Developers, see integration information here.

Use the VizSeek APIs to:

  • Upload files to be indexed to populate your searchable database.

  • Send search queries with a photo, 3D model, 2D drawing, or text as input.

  • Get back a set of visual search results.

Delivery

VizSeek's APIs are REST APIs delivered over HTTP in JSON format. They are independent of your operating system, database system or development language. Libraries and language bindings to support REST and JSON are available in all major languages and platforms.

Access tokens

We use OAth 2.0 for authentication. That means an access token, either user or app, must be included in the header of every API call. The difference between a user access token and an app access token is that user access tokens are used when a login is required. For example, the API to upload a file (File PUT) requires a user access token, but the API to get the list of allowed files (ValidUploadFileTypes GET) only needs an app access token. The API Reference page specifies which APIs require a user access token. The rest require an app access token.

Note: A call made without an access token, or without the correct access token, will result in a 401 (Unauthorized) status.

Client ID

A client id is required to identify your application. Contact us to get an assigned client id.