MetorialDocs

Provider Runs

Provider runs track the execution of provider operations within a session. This read-only resource provides visibility into provider activity.

The Provider Run object

provider_run.json
{
  "object": "session.provider_run",
  "id": "prn_8hJkLmNpQrStUvWx",
  "status": "running",
  "session_id": "ses_4dEfGhJkLmNpQrSt",
  "session_provider_id": "spr_3cDeFgHjKlMnPqRs",
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "connection_id": "scn_8hJkLmNpQrStUvWx",
  "completed_at": "2025-09-15T10:30:05.000Z",
  "created_at": "2025-09-15T10:30:00.000Z",
  "updated_at": "2026-01-10T14:45:00.000Z"
}
object"session.provider_run"required
idstringrequired
status"running" | "stopped"required
session_idstringrequired
session_provider_idstringrequired
provider_idstringrequired
connection_idstringrequired
completed_atdaterequirednullable
created_atdaterequired
updated_atdaterequired

Endpoints

List all provider runs

GET/provider-runs

Returns a paginated list of provider runs across all sessions.

Query parameters

status"running" | "stopped" or "running" | "stopped"[]optional

Filter by run status

idstring or string[]optional

Filter by provider run ID(s)

session_idstring or string[]optional

Filter by session ID(s)

provider_idstring or string[]optional

Filter by provider ID(s)

session_provider_idstring or string[]optional

Filter by session provider ID(s)

session_connection_idstring or string[]optional

Filter by session connection ID(s)

provider_version_idstring or string[]optional

Filter by provider version ID(s)

Example request

curl -X GET "https://api.metorial.com/provider-runs" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Get provider run

GET/provider-runs/:provider_run_id

Retrieves a specific provider run by ID.

Path parameters

provider_run_idstringrequired

The unique identifier for the provider_run

Example request

curl -X GET "https://api.metorial.com/provider-runs/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Get provider run logs

GET/provider-runs/:provider_run_id/logs

Retrieves the logs for a specific provider run.

Path parameters

provider_run_idstringrequired

The unique identifier for the provider_run

Example request

curl -X GET "https://api.metorial.com/provider-runs/pro_Rm4Mnheq2bfEPhBhP7SY/logs" \
  -H "Authorization: Bearer metorial_sk_io2h4..."