Returns the specified Vectorize Index.
/accounts/{account_identifier}/vectorize/indexes/{index_name}
get
VectorizeIndex
vectorize-get-vectorize-index
null{
"enum": [
"com.cloudflare.edge.vectorize.index.read"
]
}[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "index_name",
"required": true,
"schema": {
"example": "example-index",
"pattern": "^([a-z]+[a-z0-9_-]*[a-z0-9]+)$",
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"nullable": true,
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"config": {
"properties": {
"dimensions": {
"description": "Specifies the number of dimensions for the index",
"example": 768,
"maximum": 1536,
"minimum": 1,
"type": "integer"
},
"metric": {
"description": "Specifies the type of metric to use calculating distance.",
"enum": [
"cosine",
"euclidean",
"dot-product"
],
"type": "string"
}
},
"required": [
"dimensions",
"metric"
],
"type": "object"
},
"created_on": {
"description": "Specifies the timestamp the resource was created as an ISO8601 string.",
"example": "2022-11-15T18:25:44.442097Z",
"readOnly": true
},
"description": {
"description": "Specifies the description of the index.",
"example": "This is my example index.",
"type": "string"
},
"modified_on": {
"description": "Specifies the timestamp the resource was modified as an ISO8601 string.",
"example": "2022-11-15T18:25:44.442097Z",
"readOnly": true
},
"name": {
"example": "example-index",
"pattern": "^([a-z]+[a-z0-9_-]*[a-z0-9]+)$",
"type": "string"
}
},
"type": "object"
}
}
}
]
}
}
},
"description": "Get Vectorize Index Response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"nullable": true,
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"nullable": true,
"type": "object"
}
},
"type": "object"
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Get Vectorize Index Failure"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]