Endpoint

View as Markdown

Endpoint object

namestring: Name of the AI Search endpoint
Example: docs-endpoint

creatorstring: Creator of the endpoint
Example: john@example.com

creation_timestampint64: Timestamp of endpoint creation
Example: 1702013512061

last_updated_timestampint64: Timestamp of last update to the endpoint
Example: 1702013512061

endpoint_typestring

Type of endpoint

Values:

STORAGE_OPTIMIZED
STANDARD

last_updated_userstring: User who last updated the endpoint
Example: john@example.com

idstring: Unique identifier of the endpoint
Example: c56bf0a9-4929-4bd4-8bd5-d82ca62f9c76

endpoint_statusobject

Current status of the endpoint

Show child attributesHide child attributes

statestring

Current state of the endpoint

Values:

PROVISIONING
ONLINE
OFFLINE
RED_STATE
YELLOW_STATE
DELETED

Example: PROVISIONING

messagestring: Additional status message

num_indexesint32: Number of indexes on the endpoint

budget_policy_idstringPublic Preview: The user-selected budget policy id for the endpoint.

effective_budget_policy_idstringPublic Preview: The budget policy id applied to the endpoint
Example: 8b0444ff-8b60-48b0-9d31-e391f6126e0f

scaling_infoobjectGA

Scaling information for the endpoint

Show child attributesHide child attributes

statestringBeta

The current state of the scaling change request.

Values:

SCALING_CHANGE_UNSPECIFIED
SCALING_CHANGE_APPLIED
SCALING_CHANGE_IN_PROGRESS

Example: SCALING_CHANGE_APPLIED

requested_target_qpsint64GA: The requested QPS target for the endpoint. Best-effort; the system does not guarantee this QPS will be achieved.
Example: 500

estimated_completion_timestampint64Beta: Estimated time at which the in-progress scaling change will complete, in milliseconds since the Unix epoch. The estimate may change as the scaling change progresses. Unset when no scaling change is in progress, when no estimate is available, or when the change is delayed (see delayed_reason).
Example: 1791136800000

phasestringBeta

Current phase of the in-progress scaling change. Unset when no scaling change is in progress or the phase is not available.

Values:

ADJUSTING_CAPACITY
INITIALIZING_INDEX
ESTIMATING

Example: INITIALIZING_INDEX

index_initialization_percentageint32Beta: Percentage of index initialization completed, from 0 to 100. Set only during the INITIALIZING_INDEX phase; unset in other phases or when progress is not available.
Example: 40

delayed_reasonstringBeta

Reason the in-progress scaling change is delayed. When set, estimated_completion_timestamp is unset. Unset when the change is not delayed or no scaling change is in progress.

Values:

CAPACITY_UNAVAILABLE
SCALE_DOWN_BLOCKED
TAKING_LONGER_THAN_EXPECTED

Example: CAPACITY_UNAVAILABLE

target_qps_change_allowed_after_timestampint64Beta: Earliest time a new Target QPS change is accepted, in milliseconds since the Unix epoch. Set only while a scaling change is in progress, the change lock is on, and the endpoint has a recorded last throughput change; may be in the past once the lock has expired.
Example: 1791136800000

View as Markdown

The Endpoint object

{
  "name": "docs-endpoint",
  "creator": "john@example.com",
  "creation_timestamp": 1702013512061,
  "last_updated_timestamp": 1702013512061,
  "endpoint_type": "STORAGE_OPTIMIZED",
  "last_updated_user": "john@example.com",
  "id": "c56bf0a9-4929-4bd4-8bd5-d82ca62f9c76",
  "endpoint_status": {
    "state": "PROVISIONING",
    "message": "string"
  },
  "num_indexes": 0,
  "budget_policy_id": "string",
  "effective_budget_policy_id": "8b0444ff-8b60-48b0-9d31-e391f6126e0f",
  "scaling_info": {
    "state": "SCALING_CHANGE_APPLIED",
    "requested_target_qps": 500,
    "estimated_completion_timestamp": 1791136800000,
    "phase": "INITIALIZING_INDEX",
    "index_initialization_percentage": 40,
    "delayed_reason": "CAPACITY_UNAVAILABLE",
    "target_qps_change_allowed_after_timestamp": 1791136800000
  }
}

Get an endpoint GA

GET /api/2.0/vector-search/endpoints/{name}

Get details for a single AI Search endpoint.

API scopes: vector-search

Parameters

namestringRequiredpath: Name of the endpoint

Response

Returns the Endpoint object.

View as Markdown

Response

{
  "name": "docs-endpoint",
  "creator": "john@example.com",
  "creation_timestamp": 1702013512061,
  "last_updated_timestamp": 1702013512061,
  "endpoint_type": "STORAGE_OPTIMIZED",
  "last_updated_user": "john@example.com",
  "id": "c56bf0a9-4929-4bd4-8bd5-d82ca62f9c76",
  "endpoint_status": {
    "state": "PROVISIONING",
    "message": "string"
  },
  "num_indexes": 0,
  "budget_policy_id": "string",
  "effective_budget_policy_id": "8b0444ff-8b60-48b0-9d31-e391f6126e0f",
  "scaling_info": {
    "state": "SCALING_CHANGE_APPLIED",
    "requested_target_qps": 500,
    "estimated_completion_timestamp": 1791136800000,
    "phase": "INITIALIZING_INDEX",
    "index_initialization_percentage": 40,
    "delayed_reason": "CAPACITY_UNAVAILABLE",
    "target_qps_change_allowed_after_timestamp": 1791136800000
  }
}

List all endpoints GA

GET /api/2.0/vector-search/endpoints

List all AI Search endpoints in the workspace.

API scopes: vector-search

Parameters

page_tokenstringquery: Token for pagination

Response

Returns a list of Endpoint objects.

View as Markdown

Response

{
  "endpoints": [
    {
      "name": "docs-endpoint",
      "creator": "john@example.com",
      "creation_timestamp": 1702013512061,
      "last_updated_timestamp": 1702013512061,
      "endpoint_type": "STORAGE_OPTIMIZED",
      "last_updated_user": "john@example.com",
      "id": "c56bf0a9-4929-4bd4-8bd5-d82ca62f9c76",
      "endpoint_status": {},
      "num_indexes": 0,
      "budget_policy_id": "string",
      "effective_budget_policy_id": "8b0444ff-8b60-48b0-9d31-e391f6126e0f",
      "scaling_info": {}
    }
  ],
  "next_page_token": "string"
}

Create an endpoint GA

POST /api/2.0/vector-search/endpoints

Create a new endpoint.

API scopes: vector-search

Request body

namestringRequired: Name of the AI Search endpoint
Example: docs-endpoint

endpoint_typestringRequired

Type of endpoint

Values:

STORAGE_OPTIMIZED
STANDARD

budget_policy_idstringPublic Preview: The budget policy id to be applied
Example: 8b0444ff-8b60-48b0-9d31-e391f6126e0f

target_qpsint64: Target QPS for the endpoint. Mutually exclusive with num_replicas. The actual replica count is calculated at index creation/sync time based on this value. Best-effort target; the system does not guarantee this QPS will be achieved.
Example: 100

Response

Returns the Endpoint object.

View as Markdown

Request

Create a Standard endpoint

{
  "budget_policy_id": "8b0444ff-8b60-48b0-9d31-e391f6126e0f",
  "endpoint_type": "STANDARD",
  "name": "docs-endpoint"
}

Response

Successful response

{
  "creation_timestamp": 1702013512061,
  "creator": "john@example.com",
  "effective_budget_policy_id": "8b0444ff-8b60-48b0-9d31-e391f6126e0f",
  "endpoint_status": {
    "state": "PROVISIONING"
  },
  "endpoint_type": "STANDARD",
  "id": "c56bf0a9-4929-4bd4-8bd5-d82ca62f9c76",
  "last_updated_timestamp": 1702013512061,
  "last_updated_user": "john@example.com",
  "name": "docs-endpoint"
}

Update the budget policy of an endpoint Public Preview

PATCH /api/2.0/vector-search/endpoints/{name}/budget-policy

Update the budget policy of an endpoint

API scopes: vector-search

Parameters

namestringRequiredpath: Name of the AI Search endpoint

Request body

budget_policy_idstringRequired: The budget policy id to be applied
Example: 8b0444ff-8b60-48b0-9d31-e391f6126e0f

Response

budget_policy_idstring

effective_budget_policy_idstring: The budget policy applied to the AI Search endpoint.

Delete an endpoint GA

DELETE /api/2.0/vector-search/endpoints/{name}

Delete an AI Search endpoint.

API scopes: vector-search

Parameters

namestringRequiredpath: Name of the AI Search endpoint

Update an endpoint Public Preview

PATCH /api/2.0/vector-search/endpoints/{name}

Update an endpoint

API scopes: vector-search

Parameters

namestringRequiredpath: Name of the AI Search endpoint
Example: docs-endpoint

Request body

target_qpsint64: Target QPS for the endpoint. Best-effort; the system does not guarantee this QPS will be achieved.
Example: 100

Response

Returns the Endpoint object.

View as Markdown

Request

{
  "target_qps": 100
}

Response

{
  "name": "docs-endpoint",
  "creator": "john@example.com",
  "creation_timestamp": 1702013512061,
  "last_updated_timestamp": 1702013512061,
  "endpoint_type": "STORAGE_OPTIMIZED",
  "last_updated_user": "john@example.com",
  "id": "c56bf0a9-4929-4bd4-8bd5-d82ca62f9c76",
  "endpoint_status": {
    "state": "PROVISIONING",
    "message": "string"
  },
  "num_indexes": 0,
  "budget_policy_id": "string",
  "effective_budget_policy_id": "8b0444ff-8b60-48b0-9d31-e391f6126e0f",
  "scaling_info": {
    "state": "SCALING_CHANGE_APPLIED",
    "requested_target_qps": 500,
    "estimated_completion_timestamp": 1791136800000,
    "phase": "INITIALIZING_INDEX",
    "index_initialization_percentage": 40,
    "delayed_reason": "CAPACITY_UNAVAILABLE",
    "target_qps_change_allowed_after_timestamp": 1791136800000
  }
}

Endpoint object​

Get an endpoint GA​

Parameters​

Response​

List all endpoints GA​

Parameters​

Response​

Create an endpoint GA​

Request body​

Response​

Update the budget policy of an endpoint Public Preview​

Parameters​

Request body​

Response​

Delete an endpoint GA​

Parameters​

Update an endpoint Public Preview​

Parameters​

Request body​

Response​

Endpoint object

Get an endpoint GA

Parameters

Response

List all endpoints GA

Parameters

Response

Create an endpoint GA

Request body

Response

Update the budget policy of an endpoint Public Preview

Parameters

Request body

Response

Delete an endpoint GA

Parameters

Update an endpoint Public Preview

Parameters

Request body

Response