ReferenceΒΆ

/about/

get

Retrieve basic information about the geometric search endpoint, like the version

get

Get the version of the service

Schema (application/json)
PropertyTypeDescription
version string

The current version of the service


Example: '"1.4"'
Responses
Status CodeDescription
200

The request was successful

/indexed-model/

get post

This resource is for interacting with indexed models. An indexed model is a model that has been properly ingested so that queries to the service will search the model for features that are similar to the search model. This process is designed to be synchronous and can take a long time, some times up to minutes long. You may need to tune your HTTP library accordingly to avoid timeouts to get a response in time

get

List all instances of /indexed-model

Schema (application/json)
PropertyTypeDescription
description string

The description of the indexed model. Meaningful only to the client


Example: '"Version 1.8 of the turbofin"'
error string

Any errors that ocurred during processing


Example: '"Failed to feature extract: I\'m a teapot"'
model_uri URL

The model to index. This URL should point to a valid model resource that has already been uploaded and provides a content property


Example: '"https://models.authentise.com/model/456/"'
name string

The name of the indexed model. Meaningful only to the client


Example: '"turbofin-v1.8"'
status string

The current status of the indexed model


Choices
  • complete
  • error
  • indexing
  • new
  • queued
Example: '"queued"'
uri URI

The URI of the /indexed-model/ resource


Example: '"https://geometricsearch.authentise.com/indexed-model/123/"'
Responses
Status CodeDescription
200

The request was successful

400

The model resource at the provided URI did not have a content paramter

The system could not download the content of the model provided

The model resource at the provided URI returned with a non-200 level status code

The model resource returned a non-200 status code when we initiated a GET request against the URI provided.

409

The model URI you provided has already been indexed with a different name and description than the one provided

500

Unable to communicate with Geolus. You should try the request again later

post

Create a new /indexed-model/ resource. The model will be indexed synchronously during the handling of this request. This operation may take several minutes to complete, so be patient and configure your client accordingly. The endpoint will return a Location header that can be used to query for information on the indexing process or to remove models from the index at a later time.

If the model has already been index this endpoint will return a 409 status code unless the name and description are identical to the original index operation

Schema (application/json)
PropertyTypeDescription
description string

The description of the indexed model. Meaningful only to the client


Required
Example: '"Version 1.8 of the turbofin"'
error string

Any errors that ocurred during processing


Default: None
Example: '"Failed to feature extract: I\'m a teapot"'
model_uri URL

The model to index. This URL should point to a valid model resource that has already been uploaded and provides a content property


Required
Example: '"https://models.authentise.com/model/456/"'
name string

The name of the indexed model. Meaningful only to the client


Required
Example: '"turbofin-v1.8"'
status string

The current status of the indexed model


Default: None
Choices
  • complete
  • error
  • indexing
  • new
  • queued
Example: '"queued"'
uri URI

The URI of the /indexed-model/ resource


Default: None
Example: '"https://geometricsearch.authentise.com/indexed-model/123/"'
* These properties are required when POSTing
Responses
Status CodeDescription
204

The request was successful

400

The model resource at the provided URI did not have a content paramter

The system could not download the content of the model provided

The model resource at the provided URI returned with a non-200 level status code

The model resource returned a non-200 status code when we initiated a GET request against the URI provided.

409

The model URI you provided has already been indexed with a different name and description than the one provided

500

Unable to communicate with Geolus. You should try the request again later

This resource is for interacting with indexed models. An indexed model is a model that has been properly ingested so that queries to the service will search the model for features that are similar to the search model. This process is designed to be synchronous and can take a long time, some times up to minutes long. You may need to tune your HTTP library accordingly to avoid timeouts to get a response in time

get

Get a single instance of /indexed-model/

Schema (application/json)
PropertyTypeDescription
description string

The description of the indexed model. Meaningful only to the client


Example: '"Version 1.8 of the turbofin"'
error string

Any errors that ocurred during processing


Example: '"Failed to feature extract: I\'m a teapot"'
model_uri URL

The model to index. This URL should point to a valid model resource that has already been uploaded and provides a content property


Example: '"https://models.authentise.com/model/456/"'
name string

The name of the indexed model. Meaningful only to the client


Example: '"turbofin-v1.8"'
status string

The current status of the indexed model


Choices
  • complete
  • error
  • indexing
  • new
  • queued
Example: '"queued"'
uri URI

The URI of the /indexed-model/ resource


Example: '"https://geometricsearch.authentise.com/indexed-model/123/"'
Responses
Status CodeDescription
200

The request was successful

400

The model resource at the provided URI did not have a content paramter

The system could not download the content of the model provided

The model resource at the provided URI returned with a non-200 level status code

The model resource returned a non-200 status code when we initiated a GET request against the URI provided.

409

The model URI you provided has already been indexed with a different name and description than the one provided

500

Unable to communicate with Geolus. You should try the request again later

This endpoint is how to query the system for models that are similar to a provided search model. The user should first index some models using POST /indexed-model/. After they should GET from this resource and provide paramters via query arguments. That would be of the form GET /similar-models/?filter[model]=https://.../&filter[tolerance]=2&.... Results of this query will be returned nested inside a {"resources": [{...}]}

get
No description provided
Schema (application/json)
PropertyTypeDescription
max_percentage string

The maximum percentage similarity to match to the search model


min_percentage string

The minimum percentage similarity to match to the search model


model URL

The model to use as the basis for a similarity search


number_of_results string

The number of results to return


results array none available
Example: '[{}]'
tolerance string

The tolerance value for similarity search. May be 1, 2, or 3


Choices
  • identical
  • very_similar
  • similar
Example: '"identical|very_similar|similar"'
Responses
Status CodeDescription
200

The request was successful

400

The model resource returned by the URI did not contain a content property

The request to download the model content failed

The request to download the model resource from the URI returned a non-200 status code

The model resource returned a non-200 status code when we made a GET request against it.

500

Communication with geolus failed