Create an environment

⚠️

Preview — this feature is being built; the design below is the spec.

POST https://app.syntic.ai/v1/environments

Define a container image for an agent’s code tools and start building it. The response arrives with build.status: "queued"; poll the environment or subscribe to the environment.build.succeeded and environment.build.failed webhooks.

For how this fits into a full workflow, see Environments.

Headers

Header	Required	Value
`Authorization`	Yes	`Bearer <key>`: a private inference key (`sk_live_...`). See Authentication.
`syntic-beta`	Yes, while in preview	`agents-2026-11-01`. Without it the call fails with `400 beta_required`. See Versioning.
`Content-Type`	Yes	`application/json`
`Idempotency-Key`	No	Up to 255 characters. Retrying with the same key within 24 hours returns the first result instead of creating a duplicate. See Idempotency.

Body parameters

Parameter	Type	Required	Notes
`name`	string	Yes	Unique in the workspace, up to 64 characters.
`base_image`	string	No	`syntic/base` (default), `syntic/python:3.12`, `syntic/node:22` or `syntic/full`.
`packages`	object	No	`apt`, `pip` and `npm` lists; up to 200 packages in total. Pin versions for repeatable builds.
`setup_script`	string	No	Shell run once at build time, up to 16 KB.
`files`	array	No	`{file_id, path}` copied in under `/workspace`; up to 50 files, 500 MB.
`network`	object	No	`mode`: `none` (default), `allowlist` with `allowed_hosts`, or `open`.
`resources`	object	No	`cpu` 1-8, `memory_mb` 512-16384, `disk_mb` 1024-51200.
`timeouts`	object	No	`command_seconds` (max 3600), `idle_minutes`, `max_lifetime_minutes` (max 1440).
`env_vars`	object	No	Plain variables, readable through the API. Never secrets.
`vault_secrets`	array	No	`{vault_id, name}` injected as environment variables at container start.

Response

201 Created, Content-Type: application/json

{
  "id": "env_01JC5B2D4F6H8K0M2P4R",
  "type": "environment",
  "name": "data-analysis",
  "base_image": "syntic/python:3.12",
  "packages": {
    "apt": [
      "git"
    ],
    "pip": [
      "pandas==2.2.3",
      "matplotlib"
    ],
    "npm": []
  },
  "setup_script": "mkdir -p /workspace/out",
  "files": [],
  "network": {
    "mode": "none",
    "allowed_hosts": []
  },
  "resources": {
    "cpu": 2,
    "memory_mb": 4096,
    "disk_mb": 10240
  },
  "timeouts": {
    "command_seconds": 300,
    "idle_minutes": 15,
    "max_lifetime_minutes": 240
  },
  "env_vars": {
    "TZ": "UTC"
  },
  "vault_secrets": [],
  "build": {
    "status": "queued",
    "image_digest": null,
    "finished_at": null,
    "error": null
  },
  "created_at": "2026-11-04T08:10:02Z",
  "updated_at": "2026-11-04T08:10:02Z"
}

Examples

curl -sS https://app.syntic.ai/v1/environments \
  -H "Authorization: Bearer $SYNTIC_API_KEY" \
  -H "syntic-beta: agents-2026-11-01" \
  -H "Idempotency-Key: 8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69" \
  -H "Content-Type: application/json" \
  -d '{
      "name": "data-analysis",
      "base_image": "syntic/python:3.12",
      "packages": {
        "pip": [
          "pandas==2.2.3",
          "matplotlib"
        ]
      },
      "network": {
        "mode": "none"
      },
      "resources": {
        "cpu": 2,
        "memory_mb": 4096
      }
    }'

import os
 
import requests
 
resp = requests.post(
    "https://app.syntic.ai/v1/environments",
    headers={
        "Authorization": f"Bearer {os.environ['SYNTIC_API_KEY']}",
        "syntic-beta": "agents-2026-11-01",
        "Idempotency-Key": "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69",
    },
    json={
        "name": "data-analysis",
        "base_image": "syntic/python:3.12",
        "packages": {
            "pip": ["pandas==2.2.3", "matplotlib"],
        },
        "network": {
            "mode": "none",
        },
        "resources": {
            "cpu": 2,
            "memory_mb": 4096,
        },
    },
    timeout=60,
)
data = resp.json()
if not resp.ok:
    raise RuntimeError(f"{resp.status_code} {data['error']['code']}: {data['error']['message']}")
print(data)

const res = await fetch('https://app.syntic.ai/v1/environments', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SYNTIC_API_KEY}`,
    'syntic-beta': 'agents-2026-11-01',
    'Idempotency-Key': '8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "data-analysis",
    "base_image": "syntic/python:3.12",
    "packages": {
      "pip": [
        "pandas==2.2.3",
        "matplotlib"
      ]
    },
    "network": {
      "mode": "none"
    },
    "resources": {
      "cpu": 2,
      "memory_mb": 4096
    }
  }),
})
const data = await res.json()
if (!res.ok) throw new Error(`${res.status} ${data.error.code}: ${data.error.message}`)
console.log(data)

package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)
 
func main() {
	body := strings.NewReader(`{
  "name": "data-analysis",
  "base_image": "syntic/python:3.12",
  "packages": {
    "pip": [
      "pandas==2.2.3",
      "matplotlib"
    ]
  },
  "network": {
    "mode": "none"
  },
  "resources": {
    "cpu": 2,
    "memory_mb": 4096
  }
}`)
	req, err := http.NewRequest("POST", "https://app.syntic.ai/v1/environments", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("SYNTIC_API_KEY"))
	req.Header.Set("syntic-beta", "agents-2026-11-01")
	req.Header.Set("Idempotency-Key", "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69")
	req.Header.Set("Content-Type", "application/json")
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, _ := io.ReadAll(resp.Body)
	if resp.StatusCode >= 300 {
		panic(fmt.Sprintf("%d: %s", resp.StatusCode, out))
	}
	fmt.Println(string(out))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "name": "data-analysis",
              "base_image": "syntic/python:3.12",
              "packages": {
                "pip": [
                  "pandas==2.2.3",
                  "matplotlib"
                ]
              },
              "network": {
                "mode": "none"
              },
              "resources": {
                "cpu": 2,
                "memory_mb": 4096
              }
            }
            """;
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://app.syntic.ai/v1/environments"))
            .header("Authorization", "Bearer " + System.getenv("SYNTIC_API_KEY"))
            .header("syntic-beta", "agents-2026-11-01")
            .header("Idempotency-Key", "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        if (response.statusCode() >= 300) {
            throw new RuntimeException(response.statusCode() + ": " + response.body());
        }
        System.out.println(response.body());
    }
}

using System.Net.Http.Headers;
using System.Text;
 
using var http = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("POST"), "https://app.syntic.ai/v1/environments");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("SYNTIC_API_KEY"));
request.Headers.Add("syntic-beta", "agents-2026-11-01");
request.Headers.Add("Idempotency-Key", "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69");
request.Content = new StringContent("""
    {
      "name": "data-analysis",
      "base_image": "syntic/python:3.12",
      "packages": {
        "pip": [
          "pandas==2.2.3",
          "matplotlib"
        ]
      },
      "network": {
        "mode": "none"
      },
      "resources": {
        "cpu": 2,
        "memory_mb": 4096
      }
    }
    """, Encoding.UTF8, "application/json");
 
using var response = await http.SendAsync(request);
var text = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode) throw new Exception($"{(int)response.StatusCode}: {text}");
Console.WriteLine(text);

<?php
$body = <<<'JSON'
{
  "name": "data-analysis",
  "base_image": "syntic/python:3.12",
  "packages": {
    "pip": [
      "pandas==2.2.3",
      "matplotlib"
    ]
  },
  "network": {
    "mode": "none"
  },
  "resources": {
    "cpu": 2,
    "memory_mb": 4096
  }
}
JSON;
 
$ch = curl_init('https://app.syntic.ai/v1/environments');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('SYNTIC_API_KEY'),
        'syntic-beta: agents-2026-11-01',
        'Idempotency-Key: 8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);
 
if ($status >= 300) {
    throw new RuntimeException("$status: $response");
}
print_r(json_decode($response, true));

require "json"
require "net/http"
require "uri"
 
uri = URI("https://app.syntic.ai/v1/environments")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch('SYNTIC_API_KEY')}"
req["syntic-beta"] = "agents-2026-11-01"
req["Idempotency-Key"] = "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69"
req["Content-Type"] = "application/json"
req.body = <<~'JSON'
  {
    "name": "data-analysis",
    "base_image": "syntic/python:3.12",
    "packages": {
      "pip": [
        "pandas==2.2.3",
        "matplotlib"
      ]
    },
    "network": {
      "mode": "none"
    },
    "resources": {
      "cpu": 2,
      "memory_mb": 4096
    }
  }
JSON
 
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
raise "#{res.code}: #{res.body}" unless res.is_a?(Net::HTTPSuccess)
puts JSON.pretty_generate(JSON.parse(res.body))

Errors

Errors use the error envelope and carry a request_id. Codes specific to this operation:

Status	`type`	`code`	When
400	`invalid_request_error`	`beta_required`	The `syntic-beta` header is missing.
400	`invalid_request_error`	`unknown_base_image`	`base_image` is not offered.
400	`invalid_request_error`	`resource_out_of_range`	A resource or timeout is outside its range.
400	`invalid_request_error`	`invalid_host_pattern`	An `allowed_hosts` entry is not a host or `*.` wildcard.
409	`conflict_error`	`name_taken`	Another environment uses this name.
401	`authentication_error`	`invalid_api_key`	The key is missing, unknown, revoked or expired.
429	`rate_limit_error`	`rate_limited`	Too many requests; wait for `Retry-After`. See Rate-limit headers.

Delete List

Was this page helpful?