Skip to main content
PUT
Typescript (SDK)

Authorizations

Syllable-API-Key
string
header
required

Body

application/json

Request model to update an existing service.

name
string
required

The name of the service

Example:

"Weather tools"

description
string
required

The description of the service

Example:

"Service containing tools for fetching weather information"

id
integer
required

The internal ID of the service

Example:

1

auth_type
enum<string> | null

The type of authentication to use for the service's tools

Available options:
basic,
bearer,
custom_headers,
oauth2
Example:

"basic"

auth_values
any | null

The values to use for the authentication, as a dict. Should contain "username" and "password" keys if auth type is basic, "token" key if auth type is bearer, arbitrary header keys if auth type is custom_headers. or "client_id", "client_secret", and "auth_url" keys if auth type is oauth2. On an update, leave a value for a given key null and the value in the database will not be updated. (If a key is omitted entirely, any existing value for that key will be removed.)

Example:
last_updated_comments
string | null

Free text providing comment about what was updated

Example:

"Updated description to correct typo"

Response

Successful Response

Response model for service operations. A service is a collection of tools.

id
integer
required

The internal ID of the service

Example:

1

name
string
required

The name of the service

Example:

"Weather tools"

description
string
required

The description of the service

Example:

"Service containing tools for fetching weather information"

last_updated
string<date-time>
required

The timestamp of the most recent update to the service

Example:

"2024-01-01T12:00:00Z"

last_updated_by
string
required

The email of the user who last updated the service

Example:

"user@email.com"

tools
string[]
required

Names of tools that belong to the service

Example:
auth_type
enum<string> | null

The type of authentication to use for the service's tools

Available options:
basic,
bearer,
custom_headers,
oauth2
Example:

"basic"

auth_value_keys
string[] | null

Auth value keys (values omitted for security)

Example:
last_updated_comments
string | null

Free text providing comment about what was updated

Example:

"Updated description to correct typo"