List agent environment templates | Sample - OpenAI API

3 parameters

limitintegeroptional

The maximum number of resources to return, between 1 and 100. Defaults to 20.

Default:20

orderstringoptional

The order in which resources are returned. Defaults to `desc`.

Allowed:ascdescDefault:desc

afterstringoptional

Return resources after this resource ID in the selected order.

7 status codes

200A page of environment templates.

objectstringrequired

The object type, which is always `list`.

Allowed:listDefault:list

dataarray<object>required

The resources returned in this page, in the requested sort order.

first_idstringrequired

The ID of the first resource in `data`, or `null` if the page is empty.

last_idstringrequired

The ID of the last resource in `data`, or `null` if the page is empty. Pass this as `after` with the same order and filters.

has_morebooleanrequired

Whether there are more resources to retrieve after this page.

400The request was invalid.

errorobjectrequired

The error returned by the API.

401Authentication or project context was missing.

errorobjectrequired

The error returned by the API.

403The API key lacks the required management permission.

errorobjectrequired

The error returned by the API.

404The requested environment definition was not found.

errorobjectrequired

The error returned by the API.

500An internal error occurred.

errorobjectrequired

The error returned by the API.

503The service is temporarily unavailable.

errorobjectrequired

The error returned by the API.

Error handling

A 400 is returned: The request was invalid. A 401 is returned: Authentication or project context was missing. A 403 is returned: The API key lacks the required management permission. A 404 is returned: The requested environment definition was not found. A 500 is returned: An internal error occurred. A 503 is returned: The service is temporarily unavailable.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.templates.list({
  limit: 20,
  order: "example",
  after: "example",
});

{
  "object": "list",
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name",
      "object": "agent.environment.template",
      "created_at": 1,
      "updated_at": "2026-01-15T09:00:00Z",
      "packages": {
        "python": [
          "example_value"
        ],
        "system": [
          "example_value"
        ],
        "npm": [
          "example_value"
        ]
      },
      "network": {
        "access": "enabled",
        "allowed_domains": [
          "example_value"
        ]
      },
      "capability_directories": [
        "example_value"
      ],
      "skills": [
        {
          "type": "skill_reference",
          "skill_id": "550e8400-e29b-41d4-a716-446655440000",
          "version": "example_value"
        }
      ],
      "plugins": [
        {
          "type": "inline",
          "name": "Example Name",
          "description": "Example description"
        }
      ],
      "files": [
        {
          "type": "file_id",
          "file_id": "550e8400-e29b-41d4-a716-446655440000",
          "path": "example_value"
        }
      ]
    }
  ],
  "first_id": "550e8400-e29b-41d4-a716-446655440000",
  "last_id": "550e8400-e29b-41d4-a716-446655440000",
  "has_more": true
}