AnalyzeBatchDocumentsRequest

Batch document analysis parameters.

Artificial IntelligenceGenerative AIAI AgentsFoundation ModelsMachine LearningCloudMicrosoft AzureA2A

Properties

Name Type Description
azureBlobSource object Azure Blob Storage location containing the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.
azureBlobFileListSource object Azure Blob Storage file list specifying the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.
resultContainerUrl string Azure Blob Storage container URL where analyze result files will be stored.
resultPrefix string Blob name prefix of result files.
overwriteExisting boolean Overwrite existing analyze result files?
View JSON Schema on GitHub

JSON Schema

azure-ai-foundry-analyze-batch-documents-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-ai-foundry/json-schema/azure-ai-foundry-analyze-batch-documents-request-schema.json",
  "title": "AnalyzeBatchDocumentsRequest",
  "description": "Batch document analysis parameters.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azure-ai-foundry-document-models-api-openapi.yml#/components/schemas/AnalyzeBatchDocumentsRequest",
  "type": "object",
  "properties": {
    "azureBlobSource": {
      "$ref": "#/$defs/AzureBlobContentSource",
      "description": "Azure Blob Storage location containing the batch documents.  Either\nazureBlobSource or azureBlobFileListSource must be specified."
    },
    "azureBlobFileListSource": {
      "$ref": "#/$defs/AzureBlobFileListContentSource",
      "description": "Azure Blob Storage file list specifying the batch documents.  Either\nazureBlobSource or azureBlobFileListSource must be specified."
    },
    "resultContainerUrl": {
      "type": "string",
      "format": "uri",
      "description": "Azure Blob Storage container URL where analyze result files will be stored."
    },
    "resultPrefix": {
      "type": "string",
      "description": "Blob name prefix of result files."
    },
    "overwriteExisting": {
      "type": "boolean",
      "description": "Overwrite existing analyze result files?",
      "default": false
    }
  },
  "required": [
    "resultContainerUrl"
  ],
  "$defs": {
    "AzureBlobContentSource": {
      "type": "object",
      "description": "Azure Blob Storage content.",
      "properties": {
        "containerUrl": {
          "type": "string",
          "format": "uri",
          "description": "Azure Blob Storage container URL."
        },
        "prefix": {
          "type": "string",
          "description": "Blob name prefix."
        }
      },
      "required": [
        "containerUrl"
      ]
    },
    "AzureBlobFileListContentSource": {
      "type": "object",
      "description": "File list in Azure Blob Storage.",
      "properties": {
        "containerUrl": {
          "type": "string",
          "format": "uri",
          "description": "Azure Blob Storage container URL."
        },
        "fileList": {
          "type": "string",
          "description": "Path to a JSONL file within the container specifying a subset of documents."
        }
      },
      "required": [
        "containerUrl",
        "fileList"
      ]
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/azure-ai-foundry-analyze-batch-documents-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.

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