Update namespace settings

client.data.updateSettings(, , ?): DataUpdateSettingsResponse { namespace, status }

put/v1/data/{namespace}/settings

Create or replace settings for a namespace, primarily used to change the schema associated with the namespace.

ParametersExpand Collapse

namespace: string

The namespace to ingest data into

body: DataUpdateSettingsParams { schema }

schema: Record<string, Schema>

Schema mapping field names to their definitions. Use content_type to specify which fields contain URLs that should be processed (images, videos, or websites), datetime fields, or 'metadata' for fields that should be stored but not indexed. Use display_hint to provide UI rendering hints.

content_type?: "image_url" | "video_url" | "website_url" | 2 more

The type of content (image_url, video_url, website_url, datetime, or metadata). When specified as a URL type, SafetyKit will process the URL. Use 'metadata' for fields that should be stored but not indexed.

Accepts one of the following:

"image_url"

"video_url"

"website_url"

"datetime"

"metadata"

display_hint?: DisplayHint { type }

Display hint for UI rendering of this field

type: "title" | "subtitle" | "description" | 13 more

The display hint type

Accepts one of the following:

"title"

"subtitle"

"description"

"primary_image_url"

"video_url"

"location"

"compact_text"

"markdown"

"html"

"email.reply_to"

"email.body"

"email.subject"

"email.body_image"

"email.logo_image"

"email.event"

"email.footer"

field_limit?: number

Maximum amount of this field to include when sending to AI models. For text fields, this is the character limit. For array fields (e.g. image URLs), this is the maximum number of items.

minimum0

exclusiveMinimum

namespace_ref?: string

The namespace which an id refers to, creating a parent-child relationship with that namespace.

ReturnsExpand Collapse

DataUpdateSettingsResponse { namespace, status }

Namespace configuration was stored.

namespace: string

status: "updated"

Update namespace settings

import Safetykit from 'safetykit';

const client = new Safetykit({
  apiKey: process.env['SAFETYKIT_API_KEY'], // This is the default and can be omitted
});

const response = await client.data.updateSettings('namespace', {
  schema: { profile_image: {}, cover_photo: {}, website: {} },
});

console.log(response.namespace);

{
  "namespace": "users",
  "status": "updated"
}

Returns Examples

{
  "namespace": "users",
  "status": "updated"
}