Skip to main content
GET
/
settings
/
aisearchendpoints
Error
A valid request URL is required to generate request examples
[
  {
    "id": "<string>",
    "endpoint": "<string>",
    "createdBy": "<string>",
    "isPublic": true,
    "owners": [
      {
        "id": "<string>",
        "displayName": "<string>",
        "mail": "<string>",
        "securityEnabled": true,
        "mailEnabled": true,
        "groupTypes": [
          "<string>"
        ],
        "groupType": "<string>",
        "userPrincipalName": "<string>",
        "jobTitle": "<string>",
        "department": "<string>",
        "officeLocation": "<string>"
      }
    ],
    "contributors": [
      {
        "id": "<string>",
        "displayName": "<string>",
        "mail": "<string>",
        "securityEnabled": true,
        "mailEnabled": true,
        "groupTypes": [
          "<string>"
        ],
        "groupType": "<string>",
        "userPrincipalName": "<string>",
        "jobTitle": "<string>",
        "department": "<string>",
        "officeLocation": "<string>"
      }
    ],
    "users": [
      {
        "id": "<string>",
        "displayName": "<string>",
        "mail": "<string>",
        "securityEnabled": true,
        "mailEnabled": true,
        "groupTypes": [
          "<string>"
        ],
        "groupType": "<string>",
        "userPrincipalName": "<string>",
        "jobTitle": "<string>",
        "department": "<string>",
        "officeLocation": "<string>"
      }
    ],
    "inheritEntitlements": true,
    "hideFromCatalog": true,
    "createdAt": "<string>",
    "updatedBy": "<string>",
    "updatedAt": "<string>",
    "key": "<string>",
    "apiVersion": "<string>",
    "maxFailedItems": 123,
    "textEmbeddingModelEndpointId": "<string>",
    "multiServicesEndpoint": "<string>",
    "multiServicesKey": "<string>",
    "documentIntelligenceEndpoint": "<string>",
    "isDefault": true,
    "isEnabled": true,
    "availableSearchTypes": [],
    "semanticConfigurationName": "<string>",
    "vectorFieldName": "<string>"
  }
]

Authorizations

Authorization
string
header
required

Azure AD access token obtained via MSAL

Response

200 - application/json

Array of search endpoint objects

id
string
required
endpoint
string
required

Azure AI Search service URL

scope
enum<string>

Access control model

Available options:
personal,
shared
createdBy
string

UPN of the creator

isPublic
boolean

Allow public read access

owners
object[]
contributors
object[]
users
object[]
inheritEntitlements
hideFromCatalog
boolean

Hide entity from user-facing recommendations and catalog/search surfaces (still accessible to owners/contributors/admins)

createdAt
string

ISO-8601 creation timestamp

updatedBy
string
updatedAt
string

ISO-8601 update timestamp

authType
enum<string>
Available options:
managedSystemIdentity,
apiKey,
connectionString
key
string

API key (redacted in responses)

apiVersion
string
maxFailedItems
integer
textEmbeddingModelEndpointId
string

Reference to AI model endpoint for embeddings

multiServicesAuthType
enum<string>
Available options:
managedSystemIdentity,
apiKey
multiServicesEndpoint
string
multiServicesKey
string
documentIntelligenceEndpoint
string
documentIntelligenceAuthType
enum<string>
Available options:
managedSystemIdentity,
apiKey
isDefault
boolean
isEnabled
boolean
availableSearchTypes
enum<string>[]
Available options:
simple,
semantic,
vector,
vector_simple_hybrid,
vector_semantic_hybrid
defaultSearchType
enum<string>
Available options:
simple,
semantic,
vector,
vector_simple_hybrid,
vector_semantic_hybrid
semanticConfigurationName
string
searchLevel
enum<string> | null
Available options:
basic,
premium
vectorFieldName
string