GRgrepr
S3 Vector Index Integration

Update an S3 Vector Index integration

Updates an existing S3 Vector Index integration. Note: dimensions and distanceMetric are immutable after creation.

put/v1/integrations/s3-vector-index/{id}

Request

  • Base URL
    https://docs.grepr.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header GREPR-API-KEY
    • or OpenID Connect (https://grepr-prod.us.auth0.com/.well-known/openid-configuration)

Path parameters

idstring required

Request body

namestring required

Name of the integration.

teamIdsstring[]

The team IDs that this integration is associated with.

type's3-vector-index' required

The type of the integration. This is used to determine the payload type.

versioninteger required

Version of the integration. Should be increased by one for every new update in order for the write to succeed. Otherwise, a '409 Conflict' will be returned.

Example request

{
  "name": "my_integration",
  "payload": {
    "dimensions": 1536,
    "distanceMetric": "cosine"
  }
}

Response

S3 Vector Index integration updated successfully

createdAtstring date-time required

Timestamp when the integration was created.

idstring required

The integration id

jobIdsstring[] required

List of job IDs associated with the integration.

namestring required

Name of the integration.

organizationIdstring required

Organization ID of the integration.

teamIdsstring[]

The team IDs that this integration is associated with.

type's3-vector-index' required

The type of the integration. This is used to determine the payload type.

updatedAtstring date-time required

Timestamp when the integration was last updated.

versioninteger required

Version of the integration. Should be increased by one for every new update in order for the write to succeed. Otherwise, a '409 Conflict' will be returned.

Example response

{
  "name": "my_integration",
  "payload": {
    "dimensions": 1536,
    "distanceMetric": "cosine"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.