description: To show information about an existing vector database, send a GET request
to `/v2/vector-databases/{id}`. The response body contains a JSON object with a
`vector_db` key holding the standard vector database attributes, including an embedded
`endpoints` object with the connection information needed to access the database.
operationId: vectorDatabases_get
parameters:
- description: ID of the vector database.
example: '"example string"'
in: path
name: id
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: ./definitions.yml#/vectordbGetVectorDBResponse
description: A successful response.
headers:
ratelimit-limit:
$ref: ../../shared/headers.yml#/ratelimit-limit
ratelimit-remaining:
$ref: ../../shared/headers.yml#/ratelimit-remaining
ratelimit-reset:
$ref: ../../shared/headers.yml#/ratelimit-reset
"401":
$ref: ../../shared/responses/unauthorized.yml
"404":
$ref: ../../shared/responses/not_found.yml
"429":
$ref: ../../shared/responses/too_many_requests.yml
"500":
$ref: ../../shared/responses/server_error.yml
default:
$ref: ../../shared/responses/unexpected_error.yml
security:
- bearer_auth:
- database:read
summary: Retrieve an Existing Vector Database
tags:
- Vector Databases
x-codeSamples:
- $ref: examples/curl/vector_databases_get.yml