Skip to main content
POST
/
api
/
pty
Create PTY session
curl --request POST \
  --url https://api.example.com/api/pty \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "<string>",
  "args": [
    "<string>"
  ],
  "cwd": "<string>",
  "title": "<string>",
  "env": {}
}
'
import requests

url = "https://api.example.com/api/pty"

payload = {
    "command": "<string>",
    "args": ["<string>"],
    "cwd": "<string>",
    "title": "<string>",
    "env": {}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    command: '<string>',
    args: ['<string>'],
    cwd: '<string>',
    title: '<string>',
    env: {}
  })
};

fetch('https://api.example.com/api/pty', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/pty",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'command' => '<string>',
    'args' => [
        '<string>'
    ],
    'cwd' => '<string>',
    'title' => '<string>',
    'env' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/pty"

	payload := strings.NewReader("{\n  \"command\": \"<string>\",\n  \"args\": [\n    \"<string>\"\n  ],\n  \"cwd\": \"<string>\",\n  \"title\": \"<string>\",\n  \"env\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/pty")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"<string>\",\n  \"args\": [\n    \"<string>\"\n  ],\n  \"cwd\": \"<string>\",\n  \"title\": \"<string>\",\n  \"env\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/pty")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"command\": \"<string>\",\n  \"args\": [\n    \"<string>\"\n  ],\n  \"cwd\": \"<string>\",\n  \"title\": \"<string>\",\n  \"env\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "location": {
    "directory": "<string>",
    "project": {
      "id": "<string>",
      "directory": "<string>"
    },
    "workspaceID": "<string>"
  },
  "data": {
    "id": "<string>",
    "title": "<string>",
    "command": "<string>",
    "args": [
      "<string>"
    ],
    "cwd": "<string>",
    "pid": 1,
    "exitCode": 1
  }
}
{
  "_tag": "InvalidRequestError",
  "message": "<string>",
  "kind": "<string>",
  "field": "<string>"
}
{
  "_tag": "UnauthorizedError",
  "message": "<string>"
}

Query Parameters

​
location
object | null

Body

application/json
​
command
string
​
args
string[]
​
cwd
string
​
title
string
​
env
object

Response

Success

​
location
object
required
​
data
object
required