---
title: "Create session provider"
method: POST
path: "/session-providers"
tags: ["Session Providers"]
---

# Create session provider

`POST /session-providers`

## Request

- Base URL: `https://api.metorial.com`
- URL: `https://api.metorial.com/session-providers`
- Auth: HTTP bearer

Adds a new provider to an active session.

## Headers

- `Metorial-Version` string

## Request body

- BodyRequest46
  - `session_id` string, required
  - `tool_filters` union
    - object
      - `type` 'tool_keys', required
      - `keys` string[], required
    - object
      - `type` 'tool_categories', required
      - `keys` string[], required
    - object
      - `type` 'tool_regex', required
      - `pattern` string, required
    - object
      - `type` 'resource_regex', required
      - `pattern` string, required
    - object
      - `type` 'resource_uris', required
      - `uris` string[], required
    - object
      - `type` 'prompt_keys', required
      - `keys` string[], required
    - object
      - `type` 'prompt_regex', required
      - `pattern` string, required
    - union[]
      - union
        - object
          - `type` 'tool_keys', required
          - `keys` string[], required
        - object
          - `type` 'tool_categories', required
          - `keys` string[], required
        - object
          - `type` 'tool_regex', required
          - `pattern` string, required
        - object
          - `type` 'resource_regex', required
          - `pattern` string, required
        - object
          - `type` 'resource_uris', required
          - `uris` string[], required
        - object
          - `type` 'prompt_keys', required
          - `keys` string[], required
        - object
          - `type` 'prompt_regex', required
          - `pattern` string, required
  - `provider_deployment_id` string: Existing provider deployment ID
  - `provider_deployment` ProviderDeployment
    - `provider_id` string, required: Provider ID
    - `name` string
    - `description` string
    - `metadata` object: Custom key-value pairs for storing additional information
    - `locked_provider_version_id` string: Locked provider version ID to ensure consistent behavior
  - `provider_config_id` string: Existing provider config ID
  - `provider_config` union
    - object
      - `name` string
      - `value` object, required: Provider-specific configuration values
    - ProviderConfig
      - `name` string
      - `provider_config_vault_id` string, required: Provider config vault ID
      - `provider_id` string: Explicitly specify provider ID to associate with this auth config
  - `provider_auth_config_id` string: Existing provider auth config ID
  - `provider_auth_config` ProviderAuthConfig2
    - `name` string
    - `provider_auth_method_id` string, required: The authentication method to use (e.g., OAuth flow)
    - `credentials` object, required: Provider-specific authentication credentials
    - `provider_id` string: Explicitly specify provider ID to associate with this auth config

## Response `200`

Successful response

- SessionProvider
  - `object` 'session.provider', required: String representing the object's type
  - `id` string, required: Unique session provider identifier
  - `status` 'active' | 'archived' | 'deleted', required: Provider status
  - `usage` Usage2, required: Usage statistics
    - `total_productive_client_message_count` number, required: Total productive client messages
    - `total_productive_provider_message_count` number, required: Total productive provider messages
  - `tool_filter` union, required: Tool filter configuration
    - object
      - `type` 'allow_all', required
      - `ignore_parent_filters` boolean, required
    - ToolFilter
      - `type` 'filter', required
      - `filters` union[], required
        - union
          - object
            - `type` 'tool_keys', required
            - `keys` string[], required
          - object
            - `type` 'tool_categories', required
            - `keys` string[], required
          - object
            - `type` 'tool_regex', required
            - `pattern` string, required
          - object
            - `type` 'resource_regex', required
            - `pattern` string, required
          - object
            - `type` 'resource_uris', required
            - `uris` string[], required
          - object
            - `type` 'prompt_keys', required
            - `keys` string[], required
          - object
            - `type` 'prompt_regex', required
            - `pattern` string, required
      - `ignore_parent_filters` boolean, required
  - `provider_id` string, required: Provider ID
  - `session_id` string, required: Parent session ID
  - `from_template_id` string, nullable, required: Source template ID
  - `from_template_provider_id` string, nullable, required: Source template provider ID
  - `deployment` Deployment2, required
    - `object` 'provider.deployment#preview', required: String representing the object's type
    - `id` string, required: Deployment ID
    - `is_default` boolean, required: Whether this is the default deployment
    - `name` string, nullable, required: Deployment name
    - `description` string, nullable, required: Description
    - `metadata` object, nullable, required: Custom key-value pairs for storing additional information
    - `provider_id` string, required: Provider ID
    - `created_at` string, date-time, required: Timestamp when created
    - `updated_at` string, date-time, required: Timestamp when last updated
  - `config` Config3, required
    - `object` 'provider.config#preview', required: String representing the object's type
    - `id` string, required: Config ID
    - `is_default` boolean, required: Whether this is the default config
    - `name` string, nullable, required: Config name
    - `description` string, nullable, required: Description
    - `metadata` object, nullable, required: Custom key-value pairs for storing additional information
    - `provider_id` string, required: Provider ID
    - `created_at` string, date-time, required: Timestamp when created
    - `updated_at` string, date-time, required: Timestamp when last updated
  - `auth_config` object, nullable, required
    - `object` 'provider.auth_config#preview', required
    - `id` string, required
  - `created_at` string, date-time, required: Timestamp when created
  - `updated_at` string, date-time, required: Timestamp when last updated

## Other responses

- `400`: Invalid parameters or action
- `401`: Missing or invalid API key
- `403`: The key lacks permission for this resource
- `404`: No such resource
- `422`: Validation failed
- `429`: Rate limit exceeded
- `500`: Unexpected server error

---

[API](https://skmtc.dev/metorial/apis/metorial-api.md) - [All operations](https://skmtc.dev/metorial/apis/metorial-api/llms.txt) - [OpenAPI document](https://skmtc.dev/metorial/apis/metorial-api/revisions/10ccc89f3eac?raw)