{"openapi":"3.1.0","info":{"title":"Azure Document Intelligence (BYOK) API","version":"0.1.0","description":"Azure Document Intelligence (BYOK) lets an AI assistant read your own Azure Document Intelligence data through the Azure Document Intelligence API with a key you supply (Azure AI Document Intelligence resource key (Keys and Endpoint page of the resource)). Read-only: 7 tools (get_resource_info, list_document_models, get_document_model, list_document_classifiers, get_document_classifier,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-azure-document-intelligence.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-azure-document-intelligence/docs"},"termsOfService":"https://connectorbay.com/byok-azure-document-intelligence/terms"},"servers":[{"url":"https://byok-azure-document-intelligence.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-azure-document-intelligence/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_resource_info":{"post":{"operationId":"get_resource_info","summary":"Show how many custom document models the resource has and its limit. Does not analyze any document. Use for \"How many cu","description":"Show how many custom document models the resource has and its limit. Does not analyze any document. Use for \"How many custom models does my Document Intelligence resource have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"resource":{"description":"Your Azure AI Document Intelligence resource name: the part before .cognitiveservices.azure.com, for example 'contoso-docs'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Resource","type":"string"},"api_version":{"anyOf":[{"const":"2024-11-30","type":"string"},{"type":"null"}],"default":"2024-11-30","description":"Document Intelligence API version; this connector supports 2024-11-30.","title":"Api Version"}},"required":["resource"],"title":"get_resource_infoArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_document_models":{"post":{"operationId":"list_document_models","summary":"List the document models available to the resource (custom and prebuilt) with id, description, build mode, creation and ","description":"List the document models available to the resource (custom and prebuilt) with id, description, build mode, creation and expiry time. One page; nextLink shows whether more exist. Use for \"Which document models are available in my Document Intelligence resource\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"resource":{"description":"Your Azure AI Document Intelligence resource name: the part before .cognitiveservices.azure.com, for example 'contoso-docs'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Resource","type":"string"},"api_version":{"anyOf":[{"const":"2024-11-30","type":"string"},{"type":"null"}],"default":"2024-11-30","description":"Document Intelligence API version; this connector supports 2024-11-30.","title":"Api Version"}},"required":["resource"],"title":"list_document_modelsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_document_model":{"post":{"operationId":"get_document_model","summary":"Get one document model by id: description, build mode, dates, tags, document types it extracts and warnings. Use for \"Sh","description":"Get one document model by id: description, build mode, dates, tags, document types it extracts and warnings. Use for \"Show details of Document Intelligence model prebuilt-invoice\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"resource":{"description":"Your Azure AI Document Intelligence resource name: the part before .cognitiveservices.azure.com, for example 'contoso-docs'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Resource","type":"string"},"model_id":{"description":"Model id, for example 'prebuilt-invoice' or the id of a custom model.","maxLength":64,"title":"Model Id","type":"string"},"api_version":{"anyOf":[{"const":"2024-11-30","type":"string"},{"type":"null"}],"default":"2024-11-30","description":"Document Intelligence API version; this connector supports 2024-11-30.","title":"Api Version"}},"required":["resource","model_id"],"title":"get_document_modelArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_document_classifiers":{"post":{"operationId":"list_document_classifiers","summary":"List the custom document classifiers with id, description, base classifier, dates and warnings. One page; nextLink shows","description":"List the custom document classifiers with id, description, base classifier, dates and warnings. One page; nextLink shows whether more exist. Use for \"Which custom document classifiers do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"resource":{"description":"Your Azure AI Document Intelligence resource name: the part before .cognitiveservices.azure.com, for example 'contoso-docs'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Resource","type":"string"},"api_version":{"anyOf":[{"const":"2024-11-30","type":"string"},{"type":"null"}],"default":"2024-11-30","description":"Document Intelligence API version; this connector supports 2024-11-30.","title":"Api Version"}},"required":["resource"],"title":"list_document_classifiersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_document_classifier":{"post":{"operationId":"get_document_classifier","summary":"Get one custom classifier by id with its description, dates, document types and warnings. Use for \"Show details of the D","description":"Get one custom classifier by id with its description, dates, document types and warnings. Use for \"Show details of the Document Intelligence classifier my-classifier\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"resource":{"description":"Your Azure AI Document Intelligence resource name: the part before .cognitiveservices.azure.com, for example 'contoso-docs'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Resource","type":"string"},"classifier_id":{"description":"Classifier id, for example 'my-classifier'.","maxLength":64,"title":"Classifier Id","type":"string"},"api_version":{"anyOf":[{"const":"2024-11-30","type":"string"},{"type":"null"}],"default":"2024-11-30","description":"Document Intelligence API version; this connector supports 2024-11-30.","title":"Api Version"}},"required":["resource","classifier_id"],"title":"get_document_classifierArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_operations":{"post":{"operationId":"list_operations","summary":"List recent long-running operations (model builds, copies, classifier builds) with id, kind, status, progress and dates.","description":"List recent long-running operations (model builds, copies, classifier builds) with id, kind, status, progress and dates. Use for \"What model build operations ran on my Document Intelligence resource\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"resource":{"description":"Your Azure AI Document Intelligence resource name: the part before .cognitiveservices.azure.com, for example 'contoso-docs'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Resource","type":"string"},"api_version":{"anyOf":[{"const":"2024-11-30","type":"string"},{"type":"null"}],"default":"2024-11-30","description":"Document Intelligence API version; this connector supports 2024-11-30.","title":"Api Version"}},"required":["resource"],"title":"list_operationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_operation":{"post":{"operationId":"get_operation","summary":"Get one long-running operation by id with status, progress, kind, dates and any error. Use for \"What is the status of Do","description":"Get one long-running operation by id with status, progress, kind, dates and any error. Use for \"What is the status of Document Intelligence operation b6a1e8c2\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"resource":{"description":"Your Azure AI Document Intelligence resource name: the part before .cognitiveservices.azure.com, for example 'contoso-docs'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Resource","type":"string"},"operation_id":{"description":"Operation id from list_operations.","maxLength":128,"title":"Operation Id","type":"string"},"api_version":{"anyOf":[{"const":"2024-11-30","type":"string"},{"type":"null"}],"default":"2024-11-30","description":"Document Intelligence API version; this connector supports 2024-11-30.","title":"Api Version"}},"required":["resource","operation_id"],"title":"get_operationArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}