Create browser session

POST

browser_sessions

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.browserSessions.create({
  policy: {},
});

console.log(response.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.browser_sessions.create(
    policy={},
)
print(response.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	browserSession, err := client.BrowserSessions.New(
		context.TODO(),
		telnyx.BrowserSessionNewParams{
			Policy: "policy",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", browserSession.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.browserSessions.BrowserSessionCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        BrowserSessionCreateParams params = BrowserSessionCreateParams.builder()
            .policy(null)
            .build();
        var response = client.browserSessions().create(params);
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->browserSessions->create(
    policy: [],
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request POST \
  --url https://api.telnyx.com/v2/browser_sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "policy": {
    "allowed_domains": [
      "example.com"
    ]
  }
}
'

{
  "data": {
    "id": "bsess_3b108e10-906a-486e-9132-196726ba7979",
    "status": "provisioning",
    "failure_reason": "<string>",
    "policy": {
      "allowed_domains": [
        "<string>"
      ]
    },
    "limits": {
      "lifetime_s": 123,
      "idle_timeout_s": 123
    },
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "ready_at": "2023-11-07T05:31:56Z",
    "last_activity_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "invalid request: policy.allowed_domains must have at least 1 item(s)",
    "retryable": false
  }
}

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "Could not find any usable credentials in the request.",
      "source": {
        "pointer": "/"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

{
  "error": {
    "code": "idempotency_conflict",
    "message": "idempotency key reused with a different request",
    "retryable": false
  }
}

{
  "error": {
    "code": "quota_exceeded",
    "message": "organization concurrent-session limit reached",
    "retryable": true
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "failed to provision browser session",
    "retryable": true
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

policy

object

required

Show child attributes

limits

object

Show child attributes

metadata

object

Arbitrary key-value metadata.

idempotency_key

string

Scoped to the organization. The same key and identical normalized policy, limits, and metadata replay the existing session (HTTP 201); a different request returns 409 idempotency_conflict. Replays do not restart terminal sessions.

Required string length: 1 - 255

Response

Session created

data

object

Show child attributes

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.browserSessions.create({
  policy: {},
});

console.log(response.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.browser_sessions.create(
    policy={},
)
print(response.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	browserSession, err := client.BrowserSessions.New(
		context.TODO(),
		telnyx.BrowserSessionNewParams{
			Policy: "policy",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", browserSession.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.browserSessions.BrowserSessionCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        BrowserSessionCreateParams params = BrowserSessionCreateParams.builder()
            .policy(null)
            .build();
        var response = client.browserSessions().create(params);
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->browserSessions->create(
    policy: [],
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request POST \
  --url https://api.telnyx.com/v2/browser_sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "policy": {
    "allowed_domains": [
      "example.com"
    ]
  }
}
'

{
  "data": {
    "id": "bsess_3b108e10-906a-486e-9132-196726ba7979",
    "status": "provisioning",
    "failure_reason": "<string>",
    "policy": {
      "allowed_domains": [
        "<string>"
      ]
    },
    "limits": {
      "lifetime_s": 123,
      "idle_timeout_s": 123
    },
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "ready_at": "2023-11-07T05:31:56Z",
    "last_activity_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "invalid request: policy.allowed_domains must have at least 1 item(s)",
    "retryable": false
  }
}

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "Could not find any usable credentials in the request.",
      "source": {
        "pointer": "/"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

{
  "error": {
    "code": "idempotency_conflict",
    "message": "idempotency key reused with a different request",
    "retryable": false
  }
}

{
  "error": {
    "code": "quota_exceeded",
    "message": "organization concurrent-session limit reached",
    "retryable": true
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "failed to provision browser session",
    "retryable": true
  }
}

Agent Browser

Features

API Reference

For AI Agents

Create browser session

Authorizations

Body

Response