ASasksyllable
services

Update Service

Update an existing service.

put/api/v1/services/

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/services/
  • Auth
    API key in header Syllable-API-Key

Request body

namestring required

The name of the service

descriptionstring required

The description of the service

auth_type'basic' | 'bearer' | 'custom_headers' | 'oauth2'
auth_valuesunknown
idinteger required

The internal ID of the service

last_updated_commentsstring nullable

Free text providing comment about what was updated

Example request

{
  "name": "Weather tools",
  "description": "Service containing tools for fetching weather information",
  "auth_values": {
    "password": "my-password",
    "username": "my-username"
  },
  "id": 1,
  "last_updated_comments": "Updated description to correct typo"
}

Response

Successful Response

idinteger required

The internal ID of the service

namestring required

The name of the service

descriptionstring required

The description of the service

auth_type'basic' | 'bearer' | 'custom_headers' | 'oauth2'
auth_value_keysstring[] nullable

Auth value keys (values omitted for security)

last_updated_commentsstring nullable

Free text providing comment about what was updated

last_updatedstring date-time required

The timestamp of the most recent update to the service

last_updated_bystring required

The email of the user who last updated the service

toolsstring[] required

Names of tools that belong to the service

Example response

{
  "id": 1,
  "name": "Weather tools",
  "description": "Service containing tools for fetching weather information",
  "auth_value_keys": [
    "username",
    "password"
  ],
  "last_updated_comments": "Updated description to correct typo",
  "last_updated": "2024-01-01T12:00:00Z",
  "last_updated_by": "user@email.com",
  "tools": [
    "hangup",
    "summary"
  ]
}

Changes

No operation changes recorded.