Pinecone · Example Payload

Pinecone Create Collection Example

Vector DatabasesAIEmbeddingsRAG

Pinecone Create Collection Example is an example object payload from Pinecone, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "create_collection",
  "method": "POST",
  "path": "/collections",
  "summary": "Create a collection",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "creating-collection",
      "example": {
        "name": "example-collection",
        "source": "example-source-index"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "400",
      "contentType": "application/json",
      "name": "index-metric-validation-error",
      "example": {
        "error": {
          "code": "INVALID_ARGUMENT",
          "message": "Bad request. The request body included invalid request parameters."
        },
        "status": 400
      }
    },
    {
      "status": "401",
      "contentType": "application/json",
      "name": "unauthorized",
      "example": {
        "error": {
          "code": "UNAUTHENTICATED",
          "message": "Invalid API key."
        },
        "status": 401
      }
    },
    {
      "status": "402",
      "contentType": "application/json",
      "name": "payment-required",
      "example": {
        "error": {
          "code": "PAYMENT_REQUIRED",
          "message": "Request failed. Pay all past due invoices to lift restrictions on your account."
        },
        "status": 402
      }
    },
    {
      "status": "403",
      "contentType": "application/json",
      "name": "unauthorized",
      "example": {
        "error": {
          "code": "FORBIDDEN",
          "message": "Collection exceeds quota. Maximum allowed on your account is 1. Currently have 1."
        },
        "status": 403
      }
    },
    {
      "status": "409",
      "contentType": "application/json",
      "name": "collection-name-already-exists",
      "example": {
        "error": {
          "code": "ALREADY_EXISTS",
          "message": "Resource already exists."
        },
        "status": 409
      }
    },
    {
      "status": "422",
      "contentType": "application/json",
      "name": "missing-field",
      "example": {
        "error": {
          "code": "UNPROCESSABLE_ENTITY",
          "message": "Failed to deserialize the JSON body into the target type: missing field `metric` at line 1 column 16"
        },
        "status": 422
      }
    },
    {
      "status": "500",
      "contentType": "application/json",
      "name": "internal-server-error",
      "example": {
        "error": {
          "code": "UNKNOWN",
          "message": "Internal server error"
        },
        "status": 500
      }
    }
  ]
}