> For the complete documentation index, see [llms.txt](https://docs.computesdk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.computesdk.com/providers/collimate.md).

# Collimate

Collimate provider for ComputeSDK.

## Installation & Setup

```bash
npm install @computesdk/collimate
```

Add your Collimate credentials to a `.env` file:

```bash
COLLIMATE_API_KEY=your_collimate_api_key
```

Get your key at <https://collimate.ai>.

## Usage

Collimate sandboxes are created from a template, so a `templateId` is required — pass it in the provider config or in the `create()` options.

```typescript
import { collimate } from '@computesdk/collimate';

const compute = collimate({
  apiKey: process.env.COLLIMATE_API_KEY,
  templateId: 'python',
});

// Create sandbox
const sandbox = await compute.sandbox.create();

// Run a command
const result = await sandbox.runCommand('echo "Hello from Collimate!"');
console.log(result.stdout); // "Hello from Collimate!"

// Clean up
await sandbox.destroy();
```

### Configuration Options

```typescript
interface CollimateConfig {
  /** Collimate API server URL. Default: "https://api.collimate.ai" */
  serverUrl?: string;
  /** API key. Falls back to COLLIMATE_API_KEY env var. */
  apiKey?: string;
  /** Default template ID for sandbox creation. */
  templateId?: string;
  /** Default execution timeout in seconds. Default: 900 */
  timeout?: number;
}
```

### Supported Operations

| Method       | Supported | Notes                                                                                             |
| ------------ | --------- | ------------------------------------------------------------------------------------------------- |
| `create`     | ✅         | Requires a `templateId` from config or create options.                                            |
| `getById`    | ✅         | Returns `null` when the session no longer exists.                                                 |
| `list`       | ✅         | Lists sessions visible to the API key.                                                            |
| `destroy`    | ✅         | Deletes the session.                                                                              |
| `runCommand` | ✅         | Executes via the Collimate exec API (`bash -lc`).                                                 |
| `getInfo`    | ✅         |                                                                                                   |
| `getUrl`     | ❌         | Throws — sandboxes are accessed through the exec API, not a per-port public URL.                  |
| `filesystem` | ✅         | Implemented against the exec API (`writeFile` uploads file specs; reads/dirs use shell commands). |

### Notes

* `timeout` is expressed in **seconds** (default 900) and is converted to milliseconds internally.
* `getUrl` is not supported and throws for the requested port.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.computesdk.com/providers/collimate.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.