Microsoft Azure AI Foundry

Microsoft Azure AI Foundry Indexes API

The Indexes API from Microsoft Azure AI Foundry — 3 operation(s) for indexes.

GitHub OpenAPI

Operations 5

GET /indexes Indexes list latest #
GET /indexes/{name}/versions Indexes list versions #
GET /indexes/{name}/versions/{version} Indexes get version #
PATCH /indexes/{name}/versions/{version} Indexes create or update version #
DELETE /indexes/{name}/versions/{version} Indexes delete version #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/azureml/
📖
APIReference
https://learn.microsoft.com/en-us/azure/ai-foundry/
📖
Authentication
https://learn.microsoft.com/en-us/azure/ai-foundry/concepts/rbac-azure-ai-foundry
📖
Documentation
https://learn.microsoft.com/en-us/azure/foundry/foundry-models/how-to/use-foundry-models-microsoft-decision

Specifications

⚙
OpenAPI
https://artifacts.apis.io/azure-ai-foundry/openapi/azure-ai-foundry-indexes-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/azure-ai-foundry/json-schema/azure-ai-foundry-index-schema.json
📊
JSONSchema
https://artifacts.apis.io/azure-ai-foundry/json-schema/azure-ai-foundry-paged-index-schema.json

Other Resources

🔗
SDKs
https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/ai
🔗
Blog
https://commandline.microsoft.com/microsoft-decision-1-model-foundry/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/azure-ai-foundry:azure-ai-foundry-indexes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

azure-ai-foundry-indexes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Azure AI Indexes API
  version: v1
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- OAuth2Auth:
  - https://ai.azure.com/.default
tags:
- name: Indexes
paths:
  /indexes:
    get:
      operationId: Indexes_ListLatest
      description: List the latest version of each Index
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedIndex'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Indexes
      summary: Indexes list latest
      x-summary-source: derived
  /indexes/{name}/versions:
    get:
      operationId: Indexes_ListVersions
      description: List all versions of the given Index
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: The name of the resource
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedIndex'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Indexes
      summary: Indexes list versions
      x-summary-source: derived
  /indexes/{name}/versions/{version}:
    get:
      operationId: Indexes_GetVersion
      description: Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: The name of the resource
        required: true
        schema:
          type: string
      - name: version
        in: path
        description: The specific version id of the Index to retrieve.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Index'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      tags:
      - Indexes
      summary: Indexes get version
      x-summary-source: derived
    patch:
      operationId: Indexes_CreateOrUpdateVersion
      description: Create a new or update an existing Index with the given version id
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: The name of the resource
        required: true
        schema:
          type: string
      - name: version
        in: path
        description: The specific version id of the Index to create or update.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Index'
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Index'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/Index'
        description: The Index to create or update.
        required: true
      tags:
      - Indexes
      summary: Indexes create or update version
      x-summary-source: derived
    delete:
      operationId: Indexes_DeleteVersion
      description: Delete the specific version of the Index. The service returns 204 No Content if the Index was deleted successfully or if the Index does not exist.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: The name of the resource
        required: true
        schema:
          type: string
      - name: version
        in: path
        description: The version of the Index to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: There is no content to send for this request, but the headers may be useful.
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      tags:
      - Indexes
      summary: Indexes delete version
      x-summary-source: derived
components:
  schemas:
    Azure.Core.Foundations.InnerError:
      type: object
      description: An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: Inner error.
    Azure.Core.Foundations.Error:
      type: object
      description: The error object.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        message:
          type: string
          description: A human-readable representation of the error.
        target:
          type: string
          description: The target of the error.
        details:
          type: array
          description: An array of details about specific errors that led to this reported error.
          items:
            $ref: '#/components/schemas/Azure.Core.Foundations.Error'
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: An object containing more specific information than the current object about the error.
      required:
      - code
      - message
    Azure.Core.Foundations.ErrorResponse:
      type: object
      description: A response containing error details.
      properties:
        error:
          $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          description: The error object.
      required:
      - error
    Index:
      type: object
      description: Index resource Definition
      properties:
        type:
          $ref: '#/components/schemas/IndexType'
          description: Type of index
        id:
          type: string
          description: Asset ID, a unique identifier for the asset
          readOnly: true
        name:
          type: string
          description: The name of the resource
          readOnly: true
        version:
          type: string
          description: The version of the resource
          readOnly: true
        description:
          type: string
          description: The asset description text.
          x-ms-mutability:
          - update
          - create
        tags:
          type: object
          description: Tag dictionary. Tags can be added, removed, and updated.
          additionalProperties:
            type: string
          x-ms-mutability:
          - update
          - create
      discriminator:
        propertyName: type
      required:
      - type
      - name
      - version
    PagedIndex:
      type: object
      description: Paged collection of Index items
      properties:
        value:
          type: array
          description: The Index items on this page
          items:
            $ref: '#/components/schemas/Index'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    IndexType:
      type: string
      enum:
      - AzureSearch
      - CosmosDBNoSqlVectorStore
      - ManagedAzureSearch
      x-ms-enum:
        name: IndexType
        modelAsString: true
        values:
        - name: azureSearch
          value: AzureSearch
          description: Azure search
        - name: cosmosDB
          value: CosmosDBNoSqlVectorStore
          description: CosmosDB
        - name: managedAzureSearch
          value: ManagedAzureSearch
          description: Managed Azure Search
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
  securitySchemes:
    OAuth2Auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://ai.azure.com/.default: ''
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: 'Foundry Project endpoint in the form

      "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}".

      If you only have one Project in your Foundry Hub, or to target the default Project

      in your Hub, use the form

      "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"'
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true