Skip to main content
GET
Describe a workspace

Authorizations

Api-Key
string
header
required

An API Key is required to call Pinecone APIs. Get yours from the console.

Headers

X-Pinecone-Api-Version
string
default:2026-07
required

Required date-based version header

Path Parameters

workspace_name
string
required

The name of the workspace to be described. The name of the workspace. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

Required string length: 1 - 45
Example:

"example-workspace"

Response

Configuration information and status of the workspace.

Describes a workspace, a project-scoped grouping of contexts.

name
string
required

The name of the workspace. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

Required string length: 1 - 45
Example:

"example-workspace"

spec
object
required

The spec object defines the environment in which the workspace's contexts are created. Workspaces are created in a customer-managed BYOC (Bring Your Own Cloud) environment.

host
string
required

The URL address where the workspace is hosted.

Example:

"production-c01b5b5.wksp.prod.pinecone.io"

created_at
string<date-time>
required

The date and time the workspace was created.

Example:

"2026-06-21T00:00:00.000Z"

updated_at
string<date-time>
required

The date and time the workspace was last updated.

Example:

"2026-06-21T00:00:00.000Z"

status
object
required

The current status of the workspace.

Example: