Skip to main content

​
Azure AI Projects API Reference

Welcome to the Azure AI Projects API reference documentation. This API provides comprehensive access to Azure AI Foundry project resources and operations.
🎮 Interactive API Playground: Each endpoint includes an interactive playground where you can test API calls directly from the documentation. No setup required!

​
API Overview

The Azure AI Projects API enables you to:
  • 🔗 Manage Connections: Create and manage connections to various Azure services including Azure OpenAI, Cognitive Search, and more
  • 📊 Handle Datasets: Upload, version, and manage datasets for your AI projects with full lifecycle support
  • 🤖 Deploy Models: Deploy and manage AI models in your project with comprehensive deployment options
  • 🧪 Run Evaluations: Execute evaluations and assessments on your AI models, including agent evaluations
  • 🔍 Manage Indexes: Create and maintain vector indexes for search capabilities (Azure AI Search, CosmosDB)
  • 🛡️ Red Team Operations: Conduct security assessments and red team exercises with various attack strategies

​
Base URL

All API requests should be made to: 
https://{your-ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}
Where:
  • {your-ai-services-account-name} is your Azure AI Services account name
  • {project-name} is your specific project name (or use _project for the default project)

​
Authentication

This API uses OAuth 2.0 authentication with Azure Active Directory. Include a valid Bearer token in the Authorization header: 
Authorization: Bearer {your-access-token}

​
Getting an Access Token

You can obtain an access token using the Azure CLI: 
az account get-access-token --resource https://ai.azure.com

​
API Version

Current API version: 2025-05-15-preview Include the API version in all requests as a query parameter: 
?api-version=2025-05-15-preview

​
Response Format

All API responses follow a consistent JSON structure with proper HTTP status codes:
  • 2xx: Success responses
  • 4xx: Client errors (authentication, validation, etc.)
  • 5xx: Server errors
Error responses include detailed error information following Azure’s standard error format.

​
Rate Limits

Please refer to Azure AI Foundry documentation for current rate limits and throttling policies.

​
Key Endpoints

Our API is organized into the following main categories:
CategoryDescriptionKey Operations
ConnectionsManage service connectionsList, Get, Get with credentials
DatasetsHandle data assetsCreate, List, Get, Upload, Delete
DeploymentsModel deploymentsList, Get deployment details
EvaluationsModel evaluationsCreate, List, Get evaluation results
IndexesVector search indexesCreate, Update, List, Delete
Red TeamsSecurity assessmentsCreate, List, Get red team runs

​
SDKs Available

For easier integration, consider using our official SDKs:

​
Examples

# List all connections
curl -X GET "https://your-account.services.ai.azure.com/api/projects/your-project/connections?api-version=2025-05-15-preview" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Support

For API support and questions: