Session Providers

Session providers represent the providers that are actively connected to a session. Each session can have multiple providers, and providers can be added or removed during the session lifecycle.

Session Providers object

Attributes

object

String

String representing the object's type

id

String

Unique session provider identifier

name

StringNullable

Display name

description

StringNullable

Description

status

StringNullable

Provider status

metadata

ObjectNullable

Custom key-value pairs

session_id

String

Parent session ID

provider_id

String

Provider ID

provider_deployment_id

StringNullable

Provider deployment ID

created_at

Date

Timestamp when created

updated_at

Date

Timestamp when last updated

{
  "object": "session.provider",
  "id": "spr_3cDeFgHjKlMnPqRs",
  "name": "GitHub Provider",
  "description": "Active GitHub provider instance",
  "status": "active",
  "metadata": {
    "version": "1.0"
  },
  "session_id": "ses_4dEfGhJkLmNpQrSt",
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "provider_deployment_id": "pde_1aBcDeFgHjKlMnPq",
  "created_at": "2025-09-15T10:30:00.000Z",
  "updated_at": "2026-01-10T14:45:00.000Z"
}

List session providers

Returns a paginated list of providers connected to a session.

URL Parameters

session_id

String

The unique identifier for the session

Query Parameters

limit

NumberOptional

Maximum number of items to return (1-100)

after

StringOptional

Return items after this ID

before

StringOptional

Return items before this ID

cursor

StringOptional

Pagination cursor from a previous response

order

EnumOptional

Sort order for results

provider_id

UnionOptional

Filter by provider ID(s)

status

StringOptional

Filter by provider status

GEThttp://api.metorial.com/sessions/:session_id/providers
curl -X GET "https://api.metorial.com/sessions/ses_Rm4Mnheq2bfEPhBhP7SY/providers" \
  -H "Authorization: Bearer metorial_sk_..."

Get session provider

Retrieves a specific provider connected to a session.

URL Parameters

session_id

String

The unique identifier for the session

session_provider_id

String

The unique identifier for the session_provider

GEThttp://api.metorial.com/sessions/:session_id/providers/:session_provider_id
curl -X GET "https://api.metorial.com/sessions/ses_Rm4Mnheq2bfEPhBhP7SY/providers/ses_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create session provider

Adds a new provider to an active session.

URL Parameters

session_id

String

The unique identifier for the session

Request Body

name

StringOptional

description

StringOptional

metadata

ObjectOptional

Custom key-value pairs

provider_deployment

Object

provider_config

ObjectOptional

provider_auth_config

ObjectOptional

tool_filters

ObjectOptional
POSThttp://api.metorial.com/sessions/:session_id/providers
curl -X POST "https://api.metorial.com/sessions/ses_Rm4Mnheq2bfEPhBhP7SY/providers" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "provider_deployment": {
    "type": "example_type",
    "provider_deployment_id": "example_provider_deployment_id"
  },
  "provider_config": {
    "type": "example_type",
    "provider_config_id": "example_provider_config_id"
  },
  "provider_auth_config": {
    "type": "example_type",
    "provider_auth_config_id": "example_provider_auth_config_id"
  },
  "tool_filters": {
    "tool_keys": [
      "example_item"
    ]
  }
}'

Update session provider

Updates a provider connected to a session.

URL Parameters

session_id

String

The unique identifier for the session

session_provider_id

String

The unique identifier for the session_provider

Request Body

name

StringOptional

description

StringOptional

metadata

ObjectOptional

Custom key-value pairs

PATCHhttp://api.metorial.com/sessions/:session_id/providers/:session_provider_id
curl -X PATCH "https://api.metorial.com/sessions/ses_Rm4Mnheq2bfEPhBhP7SY/providers/ses_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {}
}'

Delete session provider

Removes a provider from a session.

URL Parameters

session_id

String

The unique identifier for the session

session_provider_id

String

The unique identifier for the session_provider

DELETEhttp://api.metorial.com/sessions/:session_id/providers/:session_provider_id
curl -X DELETE "https://api.metorial.com/sessions/ses_Rm4Mnheq2bfEPhBhP7SY/providers/ses_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."