LLM Providers

get

Retrieves multiple LLM provider options.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves all available LLM models.

application/json
aiLabstringRequired
artificialAnalysisReferencestringRequired
costinteger · min: 1Required
labelstringRequired
namestring · enumRequiredPossible values:
providerstring · enumRequiredPossible values:
get
/api/v1/llm-providers/options
get

Retrieves multiple LLM providers.

Query parameters
pageNumbernumber · min: 1Optional

The page number.

Default: 1
pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10
typesany ofOptionalDefault: []
or
string · enumOptionalPossible values:
Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves all LLM providers for the workspace.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired
updatedAtstring · date-timeRequired
apiKeystring · min: 1 · max: 500Required

The API key used to authenticate with the LLM provider.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the LLM provider configuration.

namestring · min: 3 · max: 50Required

The display name of the LLM provider configuration.

referenceIdstring · uuid · nullableRequired

The optional reference ID associated with the LLM provider configuration.

typestring · enumRequired

The upstream LLM provider type configured for this record.

Possible values:
workspaceIdstring · uuidRequired

The workspace ID that owns the LLM provider configuration.

get
/api/v1/llm-providers
post

Creates a new LLM provider.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
apiKeystring · min: 1 · max: 500Required

The API key used to authenticate with the LLM provider.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the LLM provider configuration.

namestring · min: 3 · max: 50Required

The display name of the LLM provider configuration.

typestring · enumRequired

The upstream LLM provider type configured for this record.

Possible values:
Responses
200

The LLM provider was created.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired
updatedAtstring · date-timeRequired
apiKeystring · min: 1 · max: 500Required

The API key used to authenticate with the LLM provider.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the LLM provider configuration.

namestring · min: 3 · max: 50Required

The display name of the LLM provider configuration.

referenceIdstring · uuid · nullableRequired

The optional reference ID associated with the LLM provider configuration.

typestring · enumRequired

The upstream LLM provider type configured for this record.

Possible values:
workspaceIdstring · uuidRequired

The workspace ID that owns the LLM provider configuration.

post
/api/v1/llm-providers
get
Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves an LLM provider.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired
updatedAtstring · date-timeRequired
apiKeystring · min: 1 · max: 500Required

The API key used to authenticate with the LLM provider.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the LLM provider configuration.

namestring · min: 3 · max: 50Required

The display name of the LLM provider configuration.

referenceIdstring · uuid · nullableRequired

The optional reference ID associated with the LLM provider configuration.

typestring · enumRequired

The upstream LLM provider type configured for this record.

Possible values:
workspaceIdstring · uuidRequired

The workspace ID that owns the LLM provider configuration.

get
/api/v1/llm-providers/{id}
delete

Removes an LLM provider.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

The LLM provider was removed.

application/json
messagestringRequired

An informative message for a call that has no effective result to be returned.

delete
/api/v1/llm-providers/{id}
patch

Updates an LLM provider.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
apiKeystring · min: 1 · max: 500Optional

The API key used to authenticate with the LLM provider.

descriptionstring · min: 3 · max: 250 · nullableOptional

The internal description of the LLM provider configuration.

namestring · min: 3 · max: 50Optional

The display name of the LLM provider configuration.

referenceIdstring · uuid · nullableOptional

The optional reference ID associated with the LLM provider configuration.

Responses
200

The LLM provider was updated.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired
updatedAtstring · date-timeRequired
apiKeystring · min: 1 · max: 500Required

The API key used to authenticate with the LLM provider.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the LLM provider configuration.

namestring · min: 3 · max: 50Required

The display name of the LLM provider configuration.

referenceIdstring · uuid · nullableRequired

The optional reference ID associated with the LLM provider configuration.

typestring · enumRequired

The upstream LLM provider type configured for this record.

Possible values:
workspaceIdstring · uuidRequired

The workspace ID that owns the LLM provider configuration.

patch
/api/v1/llm-providers/{id}

Last updated