Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Describe a workspace

Get a description of a workspace.

GET /workspaces/{workspace_name}

  • X-Pinecone-Api-Version (header, string, required) — Required date-based version header
  • workspace_name (path, string, required) — The name of the workspace to be described.
  • 200 — Configuration information and status of the workspace.
  • 401 — Unauthorized. Possible causes: Invalid API key.
  • 404 — Workspace not found.
  • 500 — Internal server error.
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu