Providers

Prompty uses a provider system to connect to different LLM backends. Each provider has an executor (sends requests to the API) and a processor (extracts results from responses). You set the provider in your .prompty file’s model section.

model:
  id: gpt-4o
  provider: openai        # ← provider key
  apiType: chat
  connection:
    kind: key
    endpoint: ${env:OPENAI_ENDPOINT}
    apiKey: ${env:OPENAI_API_KEY}

---

OpenAI

Direct access to the OpenAI API.

Provider key: openai

Supported API types: chat, responses, embedding, image

Connection

model:
  id: gpt-4o
  provider: openai
  apiType: chat
  connection:
    kind: key
    endpoint: https://api.openai.com/v1
    apiKey: ${env:OPENAI_API_KEY}
  options:
    temperature: 0.7
    maxOutputTokens: 1000

Embedding

model:
  id: text-embedding-3-small
  provider: openai
  apiType: embedding
  connection:
    kind: key
    apiKey: ${env:OPENAI_API_KEY}

Image

model:
  id: dall-e-3
  provider: openai
  apiType: image
  connection:
    kind: key
    apiKey: ${env:OPENAI_API_KEY}
  options:
    additionalProperties:
      size: "1024x1024"
      quality: standard

Tip

The endpoint defaults to https://api.openai.com/v1 and can be omitted for standard OpenAI usage.

Notes

• Uses the official openai Python package
• Supports streaming via PromptyStream / AsyncPromptyStream
• Structured output is supported via outputSchema → response_format
• Agent mode is available via execute_agent() — it uses apiType: chat with an automatic tool-calling loop

---

Microsoft Foundry

Connect to models deployed through Microsoft Foundry (Azure AI Services). This provider covers both Foundry project endpoints (the recommended approach) and classic Azure OpenAI endpoints (legacy).

Provider key: foundry

Supported API types: chat, responses, embedding, image

Project Endpoint (API Key)

model:
  id: gpt-4o
  provider: foundry
  apiType: chat
  connection:
    kind: key
    endpoint: ${env:AZURE_AI_PROJECT_ENDPOINT}
    apiKey: ${env:AZURE_AI_PROJECT_KEY}
  options:
    temperature: 0.7

Project Endpoint (Azure AD)

model:
  id: gpt-4o
  provider: foundry
  apiType: chat
  connection:
    kind: foundry
    endpoint: ${env:AZURE_AI_PROJECT_ENDPOINT}

Classic Endpoint (API Key)

model:
  id: gpt-4o                # your deployment name
  provider: foundry
  apiType: chat
  connection:
    kind: key
    endpoint: ${env:AZURE_OPENAI_ENDPOINT}
    apiKey: ${env:AZURE_OPENAI_API_KEY}
  options:
    temperature: 0.7

Embedding

model:
  id: text-embedding-3-small  # your deployment name
  provider: foundry
  apiType: embedding
  connection:
    kind: key
    endpoint: ${env:AZURE_AI_PROJECT_ENDPOINT}
    apiKey: ${env:AZURE_AI_PROJECT_KEY}

Migrating from Azure OpenAI?

If your .prompty files use provider: azure, they still work — it’s a deprecated alias for provider: foundry. Update when convenient.

Note

The model.id field maps to your deployment name, not the underlying model name. For example, if you deployed gpt-4o as my-gpt4o-deployment, use id: my-gpt4o-deployment.

Endpoint Patterns

Endpoint Pattern	Example	Notes
Foundry project (recommended)	https://<resource>.services.ai.azure.com/api/projects/<project>	New-style Foundry project endpoint
Classic Azure OpenAI (legacy)	https://<resource>.openai.azure.com/	Still supported via provider: foundry

Notes

• Uses the openai Python package with Azure-specific configuration
• Requires the azure-identity package for Azure AD authentication
• Supports both API key and Azure AD (managed identity / DefaultAzureCredential)
• Supports the same features as the OpenAI provider (streaming, structured output, agent mode)
• Model deployments are managed through the Azure AI Foundry portal

---

Anthropic

Access Anthropic Claude models directly.

Provider key: anthropic

Supported API types: chat

Connection

model:
  id: claude-sonnet-4-6
  provider: anthropic
  apiType: chat
  connection:
    kind: key
    endpoint: https://api.anthropic.com
    apiKey: ${env:ANTHROPIC_API_KEY}
  options:
    temperature: 0.7
    maxOutputTokens: 1024

Notes

• Uses the anthropic Python package
• The endpoint defaults to https://api.anthropic.com and can typically be omitted
• Tool calling is supported through Anthropic’s native tool use API

---

Provider Comparison

Feature	OpenAI	Microsoft Foundry	Anthropic
chat	✅	✅	✅
responses	✅	✅	❌
embedding	✅	✅	❌
image	✅	✅	❌
agent (tool loop)	✅	✅	❌
Streaming	✅	✅	✅
Structured output	✅	✅	✅
Azure AD auth	❌	✅	❌

---

Custom Providers

The provider system is extensible. You can create your own provider by implementing the executor and processor protocols, then registering them as Python entry points.

1. Implement the Protocols

from prompty.core.protocols import ExecutorProtocol, ProcessorProtocol
from prompty.core.types import Message

class MyExecutor:
    def execute(self, agent, messages: list[Message], **kwargs):
        # Call your LLM API here
        ...

    async def execute_async(self, agent, messages: list[Message], **kwargs):
        # Async variant
        ...

class MyProcessor:
    def process(self, agent, response, **kwargs):
        # Extract content from the API response
        ...

    async def process_async(self, agent, response, **kwargs):
        ...

2. Register Entry Points

In your package’s pyproject.toml:

[project.entry-points."prompty.executors"]
myprovider = "my_package.executor:MyExecutor"

[project.entry-points."prompty.processors"]
myprovider = "my_package.processor:MyProcessor"

3. Use in .prompty Files

model:
  id: my-model
  provider: myprovider
  connection:
    kind: key
    endpoint: ${env:MY_ENDPOINT}
    apiKey: ${env:MY_API_KEY}

After installing your package, the Prompty runtime discovers your provider automatically via the entry point system — no changes to the Prompty codebase are needed.

Tip

See the pipeline documentation for details on how executors and processors fit into the overall execution flow.