v66

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04176310979.2 KB

services

Create Service

Create a new service.

post/api/v1/services/

Request body

namestring required

The name of the service

descriptionstring required

The description of the service

auth_type'basic' | 'bearer' | 'custom_headers' | 'oauth2'

{"stackTrail":"components:schemas:ServiceCreateRequest:properties:auth_values:anyOf","oasType":"schema","type":"unknown","title":"Auth Values","description":"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":{"password":"my-password","username":"my-username"},"nullable":true}

Example request

{
  "name": "Weather tools",
  "description": "Service containing tools for fetching weather information",
  "auth_values": {
    "password": "my-password",
    "username": "my-username"
  }
}

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"
  ]
}