Pinecone · Example Payload

Pinecone Describe Backup Example

Vector DatabasesAIEmbeddingsRAG

Pinecone Describe Backup 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": "describe_backup",
  "method": "GET",
  "path": "/backups/{backup_id}",
  "summary": "Describe a backup",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "backup",
      "example": {
        "backup_id": "670e8400-e29b-41d4-a716-446655440000",
        "cloud": "aws",
        "created_at": "2024-03-15 10:30:00+00:00",
        "description": "Monthly backup of production index",
        "dimension": 1536,
        "metric": "cosine",
        "name": "backup_2024_03_15",
        "namespace_count": 3,
        "record_count": 120000,
        "region": "us-east-1",
        "schema": {
          "fields": {
            "genre": {
              "filterable": true
            },
            "title": {
              "filterable": true
            }
          }
        },
        "size_bytes": 10000000,
        "source_index_id": "670e8400-e29b-41d4-a716-446655440001",
        "source_index_name": "my-index",
        "status": "Ready",
        "tags": {
          "environment": "production",
          "type": "monthly"
        }
      }
    },
    {
      "status": "401",
      "contentType": "application/json",
      "name": "unauthorized",
      "example": {
        "error": {
          "code": "UNAUTHENTICATED",
          "message": "Invalid API key."
        },
        "status": 401
      }
    },
    {
      "status": "404",
      "contentType": "application/json",
      "name": "backup-not-found",
      "example": {
        "error": {
          "code": "NOT_FOUND",
          "message": "Backup bkp_123abc not found."
        },
        "status": 404
      }
    },
    {
      "status": "500",
      "contentType": "application/json",
      "name": "internal-server-error",
      "example": {
        "error": {
          "code": "UNKNOWN",
          "message": "Internal server error"
        },
        "status": 500
      }
    }
  ]
}