SAMApiPlugin

SAM model of the ApiPlugin kind, generated from the Smarter platform’s JSON Schema.

Do not edit: run scripts/generate_sam_models.py. See smarter.models.sam.

class smarter.models.sam.apiplugin.ParameterType(*values)[source]

Bases: Enum

Enum for parameter types.

class smarter.models.sam.apiplugin.RequestHeader(*, name: str, value: str | int | float | bool, **extra_data: Any)[source]

Bases: SAMModel

Model for storing HTTP request headers.

name: str: The name of the HTTP header.

value: str | int | float | bool: The value of the HTTP header.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}: Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.apiplugin.SAMDependency(*, kind: str, name: str, **extra_data: Any)[source]

Bases: SAMModel

A resource that depends on the resource that a manifest describes.

kind: str

Kind[String]: The SAM kind of the resource that depends on this resource, e.g. LLMClient.

Read only.

name: str

Name[String]: The name of the resource that depends on this resource.

Read only.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}: Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

Bases: SAMModel

Smarter API Plugin Manifest - common Metadata class.

The manifest annotations.

Used for storing arbitrary metadata as: key-value pairs. Example: [{‘smarter.sh/test-manifest/project-name’: ‘Scooby dooby do’}]. The key should be a valid url-friendly string. The value accepts multi-line string values (YAML block scalars) and various scalar types including str, int, float, bool, datetime.date, datetime.datetime, decimal.Decimal, uuid.UUID, bytes, list, dict.

description: str | None

The description for this resource.

Be brief. Keep it under 255 characters.

name: str: The camelCase name of the manifest resource.

pluginClass: str

The class of the plugin.

one of: [‘api’, ‘imagesearch’, ‘skill’, ‘sql’, ‘static’, ‘websearch’]

tags: list[str] | None

The tags of the manifest.

Used for generic resource categorization and search. Example: [‘tag1’, ‘tag2’]

version: str | None

The semantic version of the manifest.

Example: 0.1.0

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}: Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.apiplugin.SAMPluginCommonSpecPrompt(*, maxTokens: Annotated[int, Gt(gt=0)] | None = 2048, model: str | None = 'gpt-6-luna', provider: str | None = 'openai', systemRole: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=32768, pattern=None, ascii_only=None)], temperature: Annotated[float, None, Interval(gt=None, ge=0.0, lt=None, le=1.0), None, None] | None = 1.0, **extra_data: Any)[source]

Bases: SAMModel

Smarter API Plugin Manifest - Spec - Prompt class.

maxTokens: PositiveInt | None

Plugin.spec.prompt.maxTokens[int].

Optional. The maxTokens of the Plugin. Defaults to 2048. The maximum number of tokens the LLM should generate in the prompt response.

model: str | None

Plugin.spec.prompt.model[str] Optional.

The model of the Plugin. Defaults to gpt-6-luna. Must be one of: [‘chat-latest’, ‘gpt-4.1’, ‘gpt-4.1-2025-04-14’, ‘gpt-4.1-mini’, ‘gpt-4.1-mini-2025-04-14’, ‘gpt-4o’, ‘gpt-4o-2024-08-06’, ‘gpt-4o-2024-11-20’, ‘gpt-4o-mini’, ‘gpt-4o-mini-2024-07-18’, ‘gpt-5-search-api’, ‘gpt-5-search-api-2025-10-14’, ‘gpt-5.2’, ‘gpt-5.2-2025-12-11’, ‘gpt-5.4’, ‘gpt-5.4-2026-03-05’, ‘gpt-5.4-mini’, ‘gpt-5.4-mini-2026-03-17’, ‘gpt-5.5’, ‘gpt-5.5-2026-04-23’, ‘gpt-5.6-luna’, ‘gpt-5.6-sol’, ‘gpt-5.6-terra’, ‘gpt-6-astra’, ‘gpt-6-luna’, ‘gpt-6-sol’, ‘gpt-6.1-sol’]

provider: str | None

Plugin.spec.prompt.provider[str].

Optional. The provider of the LLM. Defaults to openai. The provider is the vendor name for the LLM service that will be used to generate the prompt response.

systemRole: constr(max_length=32768)

Plugin.spec.prompt.systemRole[str].

Required. The system role that the Plugin will use for the LLM text completion prompt. Be verbose and specific. Ensure that systemRole accurately conveys to the LLM how you want it to use the Plugin data that is returned. The maximum length is 32768 characters.

temperature: confloat(ge=0.0, le=1.0) | None

Plugin.spec.prompt.temperature[float] Optional.

The temperature of the Plugin. Defaults to 1.0. Should be between 0 and 1.0. The higher the temperature, the more creative the response. The lower the temperature, the more predictable the response.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}: Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.apiplugin.SAMPluginCommonSpecSelector(*, directive: str, searchTerms: list[str] | None = None, **extra_data: Any)[source]

Bases: SAMModel

Smarter API Plugin Manifest - Spec - Selector class.

directive: str

Plugin.spec.selector.directive[str]: Required.

the kind of selector directive to use for the Plugin. Must be one of: [‘search_terms’, ‘always’, ‘llm’]

searchTerms: list[str] | None

Plugin.spec.selector.searchTerms[list].

Optional. The keyword search terms to use when the Plugin directive is ‘search_terms’. Keywords are most effective when constrained to 1 or 2 words each and lists are limited to a few dozen items.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}: Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.apiplugin.SAMPluginCommonStatus(*, accountNumber: str, created: datetime, dependencies: list[SAMDependency] | None = None, modified: datetime, recordLocator: str, username: str, **extra_data: Any)[source]

Bases: SAMModel

Smarter API Plugin Manifest - Status class.

accountNumber: str

Plugin.status.account_number: The account owner of this Plugin.

Read only.

created: datetime

The date in which this resource was created.

Read only.

dependencies: list[SAMDependency] | None

Dependencies[List]: The resources that depend on this resource, and that must be deleted, or stop referring to it, before it can be deleted.

Lists only the resources that you can read. Read only.

modified: datetime

The date in which this resource was most recently changed.

Read only.

recordLocator: str

RecordLocator[String]: An optional identifier used to locate the resource record associated with this manifest.

Read only.

username: str

Plugin.status.account_number: The Smarter user who created this Plugin.

Read only.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}: Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.apiplugin.TestValue(*, name: str, value: Any, **extra_data: Any)[source]

Bases: SAMModel

TestValue class for SqlPlugin and ApiPlugin test values.

name: str: The name of the parameter being tested.

value: Any: The test value for the parameter.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}: Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.apiplugin.UrlParam(*, key: str, value: str | int | float | bool, **extra_data: Any)[source]

Bases: SAMModel

Model for storing url param k-v pairs.

key: str: The key (ie ‘name’) of the url param.

value: str | int | float | bool: The value for the key.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}: Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.apiplugin.Parameter(*, default: Any | None = None, description: str | None = None, enum: list[str] | None = None, name: str, required: bool | None = False, type: ParameterType, **extra_data: Any)[source]

Bases: SAMModel

Parameter class for parameterized Plugins.

This structure is intended to match that which is used in the OpenAPI function calling specification. It is used to define the parameters that a plugin can accept, and also for creating the function calling prompt api.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}: Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

default: Any | None: The default value of the parameter, if any.

description: str | None: A description of the parameter.

enum: list[str] | None

A list of allowed values for the parameter.

Example: [‘Celsius’, ‘Fahrenheit’]

name: str: The name of the parameter.

required: bool | None: Whether the parameter is required.

type: ParameterType: The data type of the parameter (one of: string, number, integer, boolean, object, array, null).

class smarter.models.sam.apiplugin.ApiData(*, body: dict[str, Any] | list | None = None, endpoint: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=255, pattern=None, ascii_only=None)], headers: list[RequestHeader] | None = None, limit: Annotated[int, None, Interval(gt=1, ge=None, lt=None, le=None), None] | None = 100, method: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=10, pattern=None, ascii_only=None)] | None = 'GET', parameters: list[Parameter] | None = None, testValues: list[TestValue] | None = None, urlParams: list[UrlParam] | None = None, **extra_data: Any)[source]

Bases: SAMModel

Smarter API - apiData class.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}: Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

body: dict[str, Any] | list | None: Any valid JSON object containing the body of the API request, if applicable.

endpoint: constr(max_length=255)

The endpoint path for the API.

Example: ‘/v1/weather’.

headers: list[RequestHeader] | None

A list of JSON dict containing headers to be sent with the API request.

Example: {‘Authorization’: ‘Bearer <token>’}

limit: conint(gt=1) | None

The maximum number of records to return from the API.

Default is 100.

method: constr(max_length=10) | None

The HTTP method to use for the API request.

Default is ‘GET’.

parameters: list[Parameter] | None

A JSON dict containing parameter names and data types.

Example: {‘city’: {‘type’: ‘string’, ‘description’: ‘City name’}}

testValues: list[TestValue] | None

A JSON dict containing test values for each parameter.

Example: {‘city’: ‘San Francisco’}

urlParams: list[UrlParam] | None

A list of URL parameters to be included in the API request.

Example: {‘city’: ‘San Francisco’}

class smarter.models.sam.apiplugin.SAMApiPluginSpec(*, apiData: ApiData, connection: str, prompt: SAMPluginCommonSpecPrompt, selector: SAMPluginCommonSpecSelector, **extra_data: Any)[source]

Bases: SAMModel

Smarter API Manifest ApiConnection.spec.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}: Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

apiData: ApiData: ApiPlugin.spec.selector[obj]: the ApiData to use for the ApiPlugin.

connection: str: ApiPlugin.spec.selector[obj]: the name of an existing ApiConnection to use for the ApiPlugin.

prompt: SAMPluginCommonSpecPrompt: Plugin.spec.prompt[obj]: the LLM prompt engineering to apply to the Plugin.

selector: SAMPluginCommonSpecSelector: Plugin.spec.selector[obj]: the selector logic to use for the Plugin.

class smarter.models.sam.apiplugin.SAMApiPlugin(*, apiVersion: str, kind: str, metadata: SAMPluginCommonMetadata, spec: SAMApiPluginSpec, status: SAMPluginCommonStatus | None = None, **extra_data: Any)[source]

Bases: SAMModel

Smarter API Manifest - ApiPlugin Model.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}: Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

apiVersion: str

ApiVersion[String]: Required.

The API version of the AbstractSAMBase.

kind: str

Kind[String]: Required.

The kind of resource described by the manifest.

metadata: SAMPluginCommonMetadata: Plugin.metadata[obj]: Required, the Plugin metadata.

spec: SAMApiPluginSpec: ApiPlugin.spec[obj]: Required, the ApiPlugin specification.

status: SAMPluginCommonStatus | None

Plugin.status[obj]: Optional, Read-only.

Stateful status information about the Plugin.