Pular para o conteúdo
ZaiaZaiaZaia

/api/v1/llm-providers/{id} (PATCH)

PATCH
/api/v1/llm-providers/{id}
curl --request PATCH \
  --url https://api.endless.zaia.app/api/v1/llm-providers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "apiKey": "example", "description": "example", "name": "example", "referenceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Updates an LLM provider.

Parameters

Seção intitulada “Parameters”

Path Parameters

Seção intitulada “Path Parameters”
id
required

A UUID v4 string that identifies an entity.

string format: uuid

A UUID v4 string that identifies an entity.

Request Bodyrequired

Seção intitulada “Request Bodyrequired”
Media typeapplication/json
object
apiKey

The API key used to authenticate with the LLM provider.

string
>= 1 characters <= 500 characters
description

The internal description of the LLM provider configuration.

string
nullable >= 3 characters <= 250 characters
name

The display name of the LLM provider configuration.

string
>= 3 characters <= 50 characters
referenceId

The optional reference ID associated with the LLM provider configuration.

string format: uuid
nullable
Examplegenerated
{
  "apiKey": "example",
  "description": "example",
  "name": "example",
  "referenceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

The LLM provider was updated.

Media typeapplication/json
object
createdAt
required
string format: date-time
id
required

A UUID v4 string that identifies an entity.

string format: uuid
isRemoved
required
boolean
updatedAt
required
string format: date-time
apiKey
required

The API key used to authenticate with the LLM provider.

string
>= 1 characters <= 500 characters
description
required

The internal description of the LLM provider configuration.

string
nullable >= 3 characters <= 250 characters
name
required

The display name of the LLM provider configuration.

string
>= 3 characters <= 50 characters
referenceId
required

The optional reference ID associated with the LLM provider configuration.

string format: uuid
nullable
type
required

The upstream LLM provider type configured for this record.

string
Allowed values: openai anthropic google-ai openrouter xai
workspaceId
required

The workspace ID that owns the LLM provider configuration.

string format: uuid
Example
{
  "type": "openai"
}

401

Seção intitulada “401”

Unauthorized.

Media typeapplication/json

The description of a known exception.

object
code

The error code.

string
cta

The error call-to-action.

object
type
required
string
Allowed values: support-contact
url
required
string format: uri
feedback
required

The error feedback.

object
enUs
string
esEs
string
ptBr
string
message
required

The error message.

string
name
required

The error name.

string
Example
{
  "cta": {
    "type": "support-contact"
  }
}

404

Seção intitulada “404”

LLM provider not found.

Media typeapplication/json

The description of a known exception.

object
code

The error code.

string
cta

The error call-to-action.

object
type
required
string
Allowed values: support-contact
url
required
string format: uri
feedback
required

The error feedback.

object
enUs
string
esEs
string
ptBr
string
message
required

The error message.

string
name
required

The error name.

string
Example
{
  "cta": {
    "type": "support-contact"
  }
}