Models

API Reference

Models

List Available Models

client.models.list(ModelListParams { page, per_page, public_only, usecases } query?, RequestOptionsoptions?): ModelListResponse { links, meta, models }

get/v2/gen-ai/models

ModelsExpand Collapse

APIAgreement { description, name, url, uuid }

Agreement Description

description?: string

name?: string

url?: string

uuid?: string

APIModel { id, agreement, created_at, 8 more }

A machine learning model stored on the GenAI platform

id?: string

Human-readable model identifier

agreement?: APIAgreement { description, name, url, uuid }

Agreement Description

description?: string

name?: string

url?: string

uuid?: string

created_at?: string

Creation date / time

formatdate-time

is_foundational?: boolean

True if it is a foundational model provided by do

name?: string

Display name of the model

parent_uuid?: string

Unique id of the model, this model is based on

updated_at?: string

Last modified

formatdate-time

upload_complete?: boolean

Model has been fully uploaded

url?: string

Download url

uuid?: string

Unique id

version?: APIModelVersion { major, minor, patch }

Version Information about a Model

major?: number

Major version number

formatint64

minor?: number

Minor version number

formatint64

patch?: number

Patch version number

formatint64

APIModelVersion { major, minor, patch }

Version Information about a Model

major?: number

Major version number

formatint64

minor?: number

Minor version number

formatint64

patch?: number

Patch version number

formatint64

ModelsProviders

ModelsProvidersAnthropic

Create Anthropic API Key

client.models.providers.anthropic.create(AnthropicCreateParams { api_key, name } body?, RequestOptionsoptions?): AnthropicCreateResponse { api_key_info }

post/v2/gen-ai/anthropic/keys

Delete Anthropic API Key

client.models.providers.anthropic.delete(stringapiKeyUuid, RequestOptionsoptions?): AnthropicDeleteResponse { api_key_info }

delete/v2/gen-ai/anthropic/keys/{api_key_uuid}

List Anthropic API Keys

client.models.providers.anthropic.list(AnthropicListParams { page, per_page } query?, RequestOptionsoptions?): AnthropicListResponse { api_key_infos, links, meta }

get/v2/gen-ai/anthropic/keys

List agents by Anthropic key

client.models.providers.anthropic.listAgents(stringuuid, AnthropicListAgentsParams { page, per_page } query?, RequestOptionsoptions?): AnthropicListAgentsResponse { agents, links, meta }

get/v2/gen-ai/anthropic/keys/{uuid}/agents

Get Anthropic API Key

client.models.providers.anthropic.retrieve(stringapiKeyUuid, RequestOptionsoptions?): AnthropicRetrieveResponse { api_key_info }

get/v2/gen-ai/anthropic/keys/{api_key_uuid}

Update Anthropic API Key

client.models.providers.anthropic.update(stringapiKeyUuid, AnthropicUpdateParams { api_key, api_key_uuid, name } body?, RequestOptionsoptions?): AnthropicUpdateResponse { api_key_info }

put/v2/gen-ai/anthropic/keys/{api_key_uuid}

ModelsProvidersOpenAI

Create OpenAI API Key

client.models.providers.openai.create(OpenAICreateParams { api_key, name } body?, RequestOptionsoptions?): OpenAICreateResponse { api_key_info }

post/v2/gen-ai/openai/keys

Delete OpenAI API Key

client.models.providers.openai.delete(stringapiKeyUuid, RequestOptionsoptions?): OpenAIDeleteResponse { api_key_info }

delete/v2/gen-ai/openai/keys/{api_key_uuid}

List OpenAI API Keys

client.models.providers.openai.list(OpenAIListParams { page, per_page } query?, RequestOptionsoptions?): OpenAIListResponse { api_key_infos, links, meta }

get/v2/gen-ai/openai/keys

Get OpenAI API Key

client.models.providers.openai.retrieve(stringapiKeyUuid, RequestOptionsoptions?): OpenAIRetrieveResponse { api_key_info }

get/v2/gen-ai/openai/keys/{api_key_uuid}

List agents by OpenAI key

client.models.providers.openai.retrieveAgents(stringuuid, OpenAIRetrieveAgentsParams { page, per_page } query?, RequestOptionsoptions?): OpenAIRetrieveAgentsResponse { agents, links, meta }

get/v2/gen-ai/openai/keys/{uuid}/agents

Update OpenAI API Key

client.models.providers.openai.update(stringapiKeyUuid, OpenAIUpdateParams { api_key, api_key_uuid, name } body?, RequestOptionsoptions?): OpenAIUpdateResponse { api_key_info }

put/v2/gen-ai/openai/keys/{api_key_uuid}