API Reference

Beta

Agents

Vaults

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve a vault

client.Beta.Agents.Vaults.Get(ctx, vaultID) (*Vault, error)

GET/vaults/{vault_id}

Retrieves a vault by its ID. See vaults.

ParametersExpand Collapse

vaultID string

minLength0

maxLength1048576

ReturnsExpand Collapse

type Vault struct{…}

A collection of credentials that agent tools can use to authenticate to MCP servers.

ID string

The ID of the vault.

minLength0

CreatedAt int64

The Unix timestamp, in seconds, when the vault was created.

formatint64

Metadata map[string, string]

Key-value pairs associated with the vault, such as an application or team identifier.

Name string

The human-readable name of the vault, if set.

minLength0

Object Vault

The object type. Always vault.

Retrieve a vault

Go

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  vault, err := client.Beta.Agents.Vaults.Get(context.TODO(), "vault_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", vault.ID)
}

200 example

{
  "id": "id",
  "created_at": 0,
  "metadata": {
    "foo": "string"
  },
  "name": "name",
  "object": "vault"
}

Returns Examples

200 example

{
  "id": "id",
  "created_at": 0,
  "metadata": {
    "foo": "string"
  },
  "name": "name",
  "object": "vault"
}