Pinecone · Schema

APIKeyWithSecret

The details of an API key, including the secret. Only returned on API key creation.

Vector DatabasesArtificial IntelligenceEmbeddingsRAG

Properties

Name	Type	Description
key	object
value	string	The value to use as an API key. New keys will have the format `"pckey__"`. The entire string should be used when authenticating.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/APIKeyWithSecret",
  "title": "APIKeyWithSecret",
  "description": "The details of an API key, including the secret. Only returned on API key creation.\n",
  "type": "object",
  "properties": {
    "key": {
      "$ref": "#/components/schemas/APIKey"
    },
    "value": {
      "description": "The value to use as an API key. New keys will have the format `\"pckey_<public-label>_<unique-key>\"`. The entire string should be used when authenticating.\n",
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}