Create a session

Creates a new session with the specified configuration. This feature is enabled for selected organizations only.

POST /api/v0/sessions

Create a session

cURL

curl --request POST \
  --url https://api.factory.ai/api/v0/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "computerId": "<string>",
  "cwd": "<string>",
  "sessionSettings": {
    "model": "<string>",
    "specModeModel": "<string>",
    "providerLockTimestamp": "<string>",
    "assistantActiveTimeMs": 123,
    "childInclusiveTokenUsageBySessionId": {},
    "archivedAt": "<string>",
    "tags": [
      {
        "name": "<string>",
        "metadata": {}
      }
    ],
    "enabledToolIds": [
      "<string>"
    ],
    "disabledToolIds": [
      "<string>"
    ]
  }
}
'

import requests

url = "https://api.factory.ai/api/v0/sessions"

payload = {
    "computerId": "<string>",
    "cwd": "<string>",
    "sessionSettings": {
        "model": "<string>",
        "specModeModel": "<string>",
        "providerLockTimestamp": "<string>",
        "assistantActiveTimeMs": 123,
        "childInclusiveTokenUsageBySessionId": {},
        "archivedAt": "<string>",
        "tags": [
            {
                "name": "<string>",
                "metadata": {}
            }
        ],
        "enabledToolIds": ["<string>"],
        "disabledToolIds": ["<string>"]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    computerId: '<string>',
    cwd: '<string>',
    sessionSettings: {
      model: '<string>',
      specModeModel: '<string>',
      providerLockTimestamp: '<string>',
      assistantActiveTimeMs: 123,
      childInclusiveTokenUsageBySessionId: {},
      archivedAt: '<string>',
      tags: [{name: '<string>', metadata: {}}],
      enabledToolIds: ['<string>'],
      disabledToolIds: ['<string>']
    }
  })
};

fetch('https://api.factory.ai/api/v0/sessions', 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.factory.ai/api/v0/sessions",
  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([
    'computerId' => '<string>',
    'cwd' => '<string>',
    'sessionSettings' => [
        'model' => '<string>',
        'specModeModel' => '<string>',
        'providerLockTimestamp' => '<string>',
        'assistantActiveTimeMs' => 123,
        'childInclusiveTokenUsageBySessionId' => [
                
        ],
        'archivedAt' => '<string>',
        'tags' => [
                [
                                'name' => '<string>',
                                'metadata' => [
                                                                
                                ]
                ]
        ],
        'enabledToolIds' => [
                '<string>'
        ],
        'disabledToolIds' => [
                '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.factory.ai/api/v0/sessions"

	payload := strings.NewReader("{\n  \"computerId\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"sessionSettings\": {\n    \"model\": \"<string>\",\n    \"specModeModel\": \"<string>\",\n    \"providerLockTimestamp\": \"<string>\",\n    \"assistantActiveTimeMs\": 123,\n    \"childInclusiveTokenUsageBySessionId\": {},\n    \"archivedAt\": \"<string>\",\n    \"tags\": [\n      {\n        \"name\": \"<string>\",\n        \"metadata\": {}\n      }\n    ],\n    \"enabledToolIds\": [\n      \"<string>\"\n    ],\n    \"disabledToolIds\": [\n      \"<string>\"\n    ]\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.factory.ai/api/v0/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"computerId\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"sessionSettings\": {\n    \"model\": \"<string>\",\n    \"specModeModel\": \"<string>\",\n    \"providerLockTimestamp\": \"<string>\",\n    \"assistantActiveTimeMs\": 123,\n    \"childInclusiveTokenUsageBySessionId\": {},\n    \"archivedAt\": \"<string>\",\n    \"tags\": [\n      {\n        \"name\": \"<string>\",\n        \"metadata\": {}\n      }\n    ],\n    \"enabledToolIds\": [\n      \"<string>\"\n    ],\n    \"disabledToolIds\": [\n      \"<string>\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.factory.ai/api/v0/sessions")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"computerId\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"sessionSettings\": {\n    \"model\": \"<string>\",\n    \"specModeModel\": \"<string>\",\n    \"providerLockTimestamp\": \"<string>\",\n    \"assistantActiveTimeMs\": 123,\n    \"childInclusiveTokenUsageBySessionId\": {},\n    \"archivedAt\": \"<string>\",\n    \"tags\": [\n      {\n        \"name\": \"<string>\",\n        \"metadata\": {}\n      }\n    ],\n    \"enabledToolIds\": [\n      \"<string>\"\n    ],\n    \"disabledToolIds\": [\n      \"<string>\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

201

{
  "sessionId": "<string>",
  "messageCount": 123,
  "createdAt": 123,
  "updatedAt": 123,
  "title": "<string>",
  "completedAt": 123,
  "computerId": "<string>",
  "sessionSettings": {
    "model": "<string>",
    "specModeModel": "<string>",
    "providerLockTimestamp": "<string>",
    "assistantActiveTimeMs": 123,
    "tokenUsage": {
      "inputTokens": 123,
      "outputTokens": 123,
      "cacheCreationTokens": 123,
      "cacheReadTokens": 123,
      "thinkingTokens": 123,
      "factoryCredits": 123
    },
    "inclusiveTokenUsage": {
      "inputTokens": 123,
      "outputTokens": 123,
      "cacheCreationTokens": 123,
      "cacheReadTokens": 123,
      "thinkingTokens": 123,
      "factoryCredits": 123
    },
    "childInclusiveTokenUsageBySessionId": {},
    "archivedAt": "<string>",
    "tags": [
      {
        "name": "<string>",
        "metadata": {}
      }
    ],
    "enabledToolIds": [
      "<string>"
    ],
    "disabledToolIds": [
      "<string>"
    ]
  }
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

Authorizations

Authorization · string · header · required

Factory API key or JWT token for authentication

Body

application/json

computerId · string · required

Computer ID to connect

cwd · string

Working directory for the session on the computer.

Required string length: 1 - 4096

sessionSettings · object

Show child attributes

Response

201

application/json

Response for status 201

sessionId · string · required

Session ID

status · enum<string> · required

Current session execution status

Available options: idle, pending, running

messageCount · integer · required

Number of messages in session

createdAt · integer · required

Creation timestamp (Unix ms)

updatedAt · integer · required

Last update timestamp (Unix ms)

title · string

Session title

completedAt · integer

Completion timestamp (Unix ms)

computerId · string

Connected computer ID

sessionSettings · object

Show child attributes