Environments
Environments endpoints of the Ellipsis REST API.
| Method | Path |
|---|---|
| POST | /v1/environments |
To define it in a repository instead, commit a `kind: environment` YAML under an agents directory. 409 when another live environment already holds the name.
curl -X POST "https://api.ellipsis.dev/v1/environments" \
-H "Authorization: Bearer $ELLIPSIS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"environment":"..."}'import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.environments.create("...")
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.environments.create({ environment: '...' });
console.log(result);Request
Body parameters
The environment's definition.
Response
| Method | Path |
|---|---|
| GET | /v1/environments |
curl "https://api.ellipsis.dev/v1/environments" \
-H "Authorization: Bearer $ELLIPSIS_API_KEY"import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.environments.list()
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.environments.list();
console.log(result);Request
Response
| Method | Path |
|---|---|
| GET | /v1/environments/{environment_id} |
Path parameters
curl "https://api.ellipsis.dev/v1/environments/{environment_id}" \
-H "Authorization: Bearer $ELLIPSIS_API_KEY"import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.environments.get("...")
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.environments.get('...');
console.log(result);Request
Response
| Method | Path |
|---|---|
| PUT | /v1/environments/{environment_id} |
The whole definition is replaced, live at once — future sessions resolve the new body; running sessions keep the one frozen at their start. Only for environments managed through this API: one defined by a repository file is a 409.
Path parameters
curl -X PUT "https://api.ellipsis.dev/v1/environments/{environment_id}" \
-H "Authorization: Bearer $ELLIPSIS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"environment":"..."}'import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.environments.update("...", "...")
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.environments.update('...', { environment: '...' });
console.log(result);Request
Body parameters
The environment's new definition. Replaces the previous one wholesale — this is not a partial update.
Response
| Method | Path |
|---|---|
| DELETE | /v1/environments/{environment_id} |
Always succeeds, even while agents still reference it — their next session start fails with a clear error naming the missing environment. Past sessions remain readable. Only for environments managed through this API — delete the file to remove one defined by a repository.
Path parameters
curl -X DELETE "https://api.ellipsis.dev/v1/environments/{environment_id}" \
-H "Authorization: Bearer $ELLIPSIS_API_KEY"import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.environments.delete("...")
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.environments.delete('...');
console.log(result);