AGagentarea
v1
protected
model-instances

List Model Instances

Changed on

List model instances, optionally only those whose model is of kind.

get/v1/workspaces/{workspace}/model-instances/

Request

Path parameters

workspacestring required

Slug of the workspace the request acts in

Query parameters

provider_config_idstring uuid nullable
model_spec_idstring uuid nullable
is_activeboolean nullable
kind'chat' | 'embedding' | 'image' | 'video' | 'decision'

What a model produces, which decides every surface it may be bound to.

An agent's main model is chat; the media toolset takes image and video; the decide toolset and decision-backed trigger conditions take decision. A model has exactly one kind.

Response

Successful Response

config_namestring nullable
created_atstring date-time required
descriptionstring nullable required
idstring required
is_activeboolean required
is_publicboolean required
managed_bystring nullable
model_display_namestring nullable
model_kind'chat' | 'embedding' | 'image' | 'video' | 'decision'

What a model produces, which decides every surface it may be bound to.

An agent's main model is chat; the media toolset takes image and video; the decide toolset and decision-backed trigger conditions take decision. A model has exactly one kind.

model_namestring nullable
model_spec_idstring required
namestring required
provider_config_idstring required
provider_icon_urlstring nullable
provider_keystring nullable
provider_namestring nullable
tagsstring[]
updated_atstring date-time required

Changes

  • 0fe6217a1ba4Revision changes
    • info

      added the new optional query request parameter kind

    • info

      added the optional property / to the response with the status

  • 1989f8c406ecRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status