Execute browser action

POST

browser_sessions

{id}

actions

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.actions.create('id');

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.actions.create(
    id="id",
)
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"),
	)
	action, err := client.BrowserSessions.Actions.New(
		context.TODO(),
		"id",
		telnyx.BrowserSessionActionNewParams{
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", action.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.actions.ActionCreateParams;

public final class Main {
    private Main() {}

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

        ActionCreateParams params = ActionCreateParams.builder()
            .build();
        var response = client.browserSessions().actions().create("id", 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->actions->create(
    'id',
  );

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

curl --request POST \
  --url https://api.telnyx.com/v2/browser_sessions/{id}/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "navigate",
  "url": "https://example.com/"
}
'

{
  "data": {
    "id": "bact_075cfdc9-...",
    "session_id": "<string>",
    "seq": 123,
    "type": "<string>",
    "status": "queued",
    "result": {
      "url": "<string>",
      "title": "<string>",
      "observation": {
        "observation_id": "<string>",
        "url": "<string>",
        "title": "<string>",
        "refs": {},
        "tree": "<string>",
        "truncated": true,
        "ref_count": 123
      },
      "artifact": {
        "artifact_id": "<string>",
        "content_type": "<string>",
        "size_bytes": 123
      },
      "results": [
        {}
      ]
    },
    "request": {},
    "error": {
      "code": "<string>",
      "retryable": true
    },
    "created_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  }
}

{
  "data": {
    "id": "bact_075cfdc9-...",
    "session_id": "<string>",
    "seq": 123,
    "type": "<string>",
    "status": "queued",
    "result": {
      "url": "<string>",
      "title": "<string>",
      "observation": {
        "observation_id": "<string>",
        "url": "<string>",
        "title": "<string>",
        "refs": {},
        "tree": "<string>",
        "truncated": true,
        "ref_count": 123
      },
      "artifact": {
        "artifact_id": "<string>",
        "content_type": "<string>",
        "size_bytes": 123
      },
      "results": [
        {}
      ]
    },
    "request": {},
    "error": {
      "code": "<string>",
      "retryable": true
    },
    "created_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_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": "not_found",
    "message": "session not found",
    "retryable": false
  }
}

{
  "error": {
    "code": "session_not_ready",
    "message": "session is provisioning",
    "retryable": true
  }
}

{
  "error": {
    "code": "execution_lost",
    "message": "Request could not be completed reliably",
    "retryable": true
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Query Parameters

wait_seconds

integer

default:10

Maximum seconds the submission request waits for completion, not an execution timeout. If still queued or running, returns 202 without cancelling execution; poll the returned action ID.

Required range: 0 <= x <= 25

Body

application/json

Discriminated union on type. Variants are strict: unknown fields are rejected with 400. Reusing an idempotency_key with an identical request replays the original resource; with a different request it returns 409 idempotency_conflict.

type

any

required

url

string<uri>

required

Maximum string length: 2048

wait_until

enum<string>

default:load

Available options:

load,

dom_stable,

none

include_observation

boolean

default:false

idempotency_key

string

Required string length: 1 - 255

Response

Terminal action: succeeded, failed, or unknown. Inspect data.status and data.error; HTTP 200 does not imply successful execution.

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.actions.create('id');

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.actions.create(
    id="id",
)
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"),
	)
	action, err := client.BrowserSessions.Actions.New(
		context.TODO(),
		"id",
		telnyx.BrowserSessionActionNewParams{
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", action.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.actions.ActionCreateParams;

public final class Main {
    private Main() {}

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

        ActionCreateParams params = ActionCreateParams.builder()
            .build();
        var response = client.browserSessions().actions().create("id", 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->actions->create(
    'id',
  );

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

curl --request POST \
  --url https://api.telnyx.com/v2/browser_sessions/{id}/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "navigate",
  "url": "https://example.com/"
}
'

{
  "data": {
    "id": "bact_075cfdc9-...",
    "session_id": "<string>",
    "seq": 123,
    "type": "<string>",
    "status": "queued",
    "result": {
      "url": "<string>",
      "title": "<string>",
      "observation": {
        "observation_id": "<string>",
        "url": "<string>",
        "title": "<string>",
        "refs": {},
        "tree": "<string>",
        "truncated": true,
        "ref_count": 123
      },
      "artifact": {
        "artifact_id": "<string>",
        "content_type": "<string>",
        "size_bytes": 123
      },
      "results": [
        {}
      ]
    },
    "request": {},
    "error": {
      "code": "<string>",
      "retryable": true
    },
    "created_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  }
}

{
  "data": {
    "id": "bact_075cfdc9-...",
    "session_id": "<string>",
    "seq": 123,
    "type": "<string>",
    "status": "queued",
    "result": {
      "url": "<string>",
      "title": "<string>",
      "observation": {
        "observation_id": "<string>",
        "url": "<string>",
        "title": "<string>",
        "refs": {},
        "tree": "<string>",
        "truncated": true,
        "ref_count": 123
      },
      "artifact": {
        "artifact_id": "<string>",
        "content_type": "<string>",
        "size_bytes": 123
      },
      "results": [
        {}
      ]
    },
    "request": {},
    "error": {
      "code": "<string>",
      "retryable": true
    },
    "created_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_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": "not_found",
    "message": "session not found",
    "retryable": false
  }
}

{
  "error": {
    "code": "session_not_ready",
    "message": "session is provisioning",
    "retryable": true
  }
}

{
  "error": {
    "code": "execution_lost",
    "message": "Request could not be completed reliably",
    "retryable": true
  }
}

Agent Browser

Features

API Reference

For AI Agents

Execute browser action

Authorizations

Path Parameters

Query Parameters

Body

Response