API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Vals

Vals are a collaborative folder of runnable JavaScript, TypeScript, and JSX modules

List

client.vals.list(ValListParams { limit, cursor, privacy, user_id } query, RequestOptionsoptions?): Cursor<Val { id, author, createdAt, 5 more } >

get/v2/vals

Create

client.vals.create(ValCreateParams { name, privacy, description, orgId } body, RequestOptionsoptions?): Val { id, author, createdAt, 5 more }

post/v2/vals

Retrieve

client.vals.retrieve(stringvalID, RequestOptionsoptions?): Val { id, author, createdAt, 5 more }

get/v2/vals/{val_id}

Delete

client.vals.delete(stringvalID, RequestOptionsoptions?): void

delete/v2/vals/{val_id}

ValsBranches

List

client.vals.branches.list(stringvalID, BranchListParams { limit, offset } query, RequestOptionsoptions?): PageCursorURL<BranchListResponse { id, createdAt, forkedBranchId, 4 more } >

get/v2/vals/{val_id}/branches

Retrieve

client.vals.branches.retrieve(stringbranchID, BranchRetrieveParams { val_id } params, RequestOptionsoptions?): BranchRetrieveResponse { id, createdAt, forkedBranchId, 4 more }

get/v2/vals/{val_id}/branches/{branch_id}

Create

client.vals.branches.create(stringvalID, BranchCreateParams { name, branchId } body, RequestOptionsoptions?): BranchCreateResponse { id, createdAt, forkedBranchId, 4 more }

post/v2/vals/{val_id}/branches

Delete

client.vals.branches.delete(stringbranchID, BranchDeleteParams { val_id } params, RequestOptionsoptions?): void

delete/v2/vals/{val_id}/branches/{branch_id}

ValsFiles

Retrieve

client.vals.files.retrieve(stringvalID, FileRetrieveParams { limit, offset, path_, 3 more } query, RequestOptionsoptions?): PageCursorURL<FileRetrieveResponse { id, links, name, 4 more } >

get/v2/vals/{val_id}/files

Get Content

client.vals.files.getContent(stringvalID, FileGetContentParams { path_, branch_id, version, 5 more } params, RequestOptionsoptions?): Response

get/v2/vals/{val_id}/files/content

Update

client.vals.files.update(stringvalID, FileUpdateParams { path_, branch_id, content, 3 more } params, RequestOptionsoptions?): FileUpdateResponse { id, links, name, 4 more }

put/v2/vals/{val_id}/files

Create

client.vals.files.create(stringvalID, FileCreateParamsparams, RequestOptionsoptions?): FileCreateResponse { id, links, name, 4 more }

post/v2/vals/{val_id}/files

Delete

client.vals.files.delete(stringvalID, FileDeleteParams { path_, recursive, branch_id } params, RequestOptionsoptions?): void

delete/v2/vals/{val_id}/files

ValsEnvironment Variables

Settings and secrets for Vals

List

client.vals.environmentVariables.list(stringvalID, EnvironmentVariableListParams { limit, offset } query, RequestOptionsoptions?): PageCursorURL<EnvironmentVariableListResponse { createdAt, description, key, updatedAt } >

get/v2/vals/{val_id}/environment_variables

Create

client.vals.environmentVariables.create(stringvalID, EnvironmentVariableCreateParams { key, value, description } body, RequestOptionsoptions?): EnvironmentVariableCreateResponse { createdAt, description, key, updatedAt }

post/v2/vals/{val_id}/environment_variables

Update

client.vals.environmentVariables.update(stringkey, EnvironmentVariableUpdateParams { val_id, value, description } params, RequestOptionsoptions?): EnvironmentVariableUpdateResponse { createdAt, description, key, updatedAt }

put/v2/vals/{val_id}/environment_variables/{key}

Delete

client.vals.environmentVariables.delete(stringkey, EnvironmentVariableDeleteParams { val_id } params, RequestOptionsoptions?): void

delete/v2/vals/{val_id}/environment_variables/{key}