API ReferenceManage engines

Retrieve an engine

This method retrieves an engine.

Path parameters

engine-idstringRequired

The identifier of the engine to retrieve. The following engines are available:

  • Embedding: These engines are proficient at performing tasks such as search and classification, enabling enhanced video understanding.

    • marengo2.6

  • Generative: These engines generate text based on your videos.

    • pegasus1.1

For details about the features of each engine, see the Video understanding engines page.

Headers

x-api-keystringRequired

Response

The specified engine has successfully been retrieved

_idstringOptional

A string representing the identifier of the engine.

allowed_engine_optionslist of stringsOptional

An array of strings representing the supported engine options for each engine. For details, see the Engine options page.

authorstringOptional

A string indicating who created the index.

created_atstringOptional

A string representing the date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), that the engine was created.

updated_atstringOptional

A string representing the date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), that the engine was updated.

finetunebooleanOptional

A boolean indicating whether this engine supports fine-tunning.

readybooleanOptional

A boolean specifying whether this engine is ready to be used.

Errors