Example Usage
import { Intern } from "@openrouter/sdk/models";
let value: Intern = {
attachedVaultId: null,
createdAt: "2026-09-16T08:30:00.000Z",
description: "Researches customer questions",
hostname: "research-assistant.openrouter.ai",
id: "7c9e6679-7425-40de-944b-e07fc1f90ae7",
instructions: null,
lastFailureMessage: null,
model: "openai/gpt-5.4",
name: "research-assistant",
progress: null,
status: "running",
updatedAt: "2026-09-16T08:45:00.000Z",
vaultId: "b431c59d-6eed-41ac-bc89-9a89be79a121",
workspaceId: "89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb",
};
Fields
| Field | Type | Required | Description |
|---|---|---|---|
attachedVaultId | string | ✔️ | Vault the intern borrows from another intern, or null when it borrows none. |
canEdit | boolean | ➖ | Whether this key may change the intern (update, provision, suspend, delete). Present on list and retrieve; false while lifecycle writes are closed for the account. |
createdAt | string | ✔️ | ISO 8601 creation time. |
createdByYou | boolean | ➖ | Whether the user behind the key created the intern. Present on list and retrieve; absent for organization keys, which act for no user. |
description | string | ✔️ | Free-form description. |
hostname | string | ✔️ | Public hostname the intern is reachable at, or null until provisioning has assigned one. |
iconSha256 | string | ➖ | SHA-256 of the intern icon, or null when it has none. Present on list and retrieve; fetch the bytes from GET /api/v1/interns/{intern_id}/icon. |
id | string | ✔️ | Intern id. |
instructions | string | ✔️ | Standing instructions the intern boots with. |
lastFailureMessage | string | ✔️ | Why the last provisioning attempt failed, when status is failed. |
model | string | ✔️ | OpenRouter model slug the intern runs, or null for the workspace default. |
name | string | ✔️ | Intern name, unique per creator within a workspace. |
progress | models.Progress | ✔️ | Active provisioning step, or null once provisioning has settled. |
status | models.InternStatus | ✔️ | Lifecycle status. |
updatedAt | string | ✔️ | ISO 8601 last update time. |
vaultId | string | ✔️ | Vault the intern owns, or null before it has been created. |
workspaceId | string | ✔️ | Workspace that owns the intern and scopes its secrets. |