Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/openmined/syft-space/llms.txt

Use this file to discover all available pages before exploring further.

Update a model’s name, summary, or tags. This is a partial update operation - you only need to include the fields you want to change. Configuration cannot be updated after creation.
Model configuration is immutable after creation. To change configuration, delete the model and create a new one.

​
Path parameters

​
name
string
required
The current name of the model to update.

​
Request

At least one field must be provided.
​
name
string
New unique name for the model. Must not conflict with existing models in your tenant.
​
summary
string
Updated description of the model.
​
tags
string
Updated comma-separated tags.Example: openai,gpt-4,production

​
Response

​
id
uuid
Unique identifier (unchanged).
​
name
string
Updated model name.
​
dtype
string
Model type (unchanged).
​
configuration
object
Model configuration (unchanged).
​
summary
string
Updated summary.
​
tags
string
Updated tags.
​
created_at
datetime
Original creation timestamp.
​
updated_at
datetime
Updated timestamp reflecting this change.
​
connected_endpoints
array
Array of connected endpoints.
curl -X PATCH https://your-server.com/api/v1/models/gpt-4-assistant \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "summary": "GPT-4 model optimized for customer support",
    "tags": "openai,gpt-4,support,production"
  }'

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "gpt-4-assistant",
  "dtype": "openai",
  "configuration": {
    "api_key": "sk-...",
    "model": "gpt-4",
    "base_url": "https://api.openai.com/v1",
    "system_prompt": "You are a helpful AI assistant."
  },
  "summary": "GPT-4 model optimized for customer support",
  "tags": "openai,gpt-4,support,production",
  "created_at": "2024-03-15T10:30:00Z",
  "updated_at": "2024-03-15T15:45:00Z",
  "connected_endpoints": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "name": "Support Assistant",
      "slug": "support-assistant"
    }
  ]
}

​
Endpoint

PATCH