> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# azure-ai

> Azure AI API

**Server path:** `/azure-ai` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                      | Description                                                  |
| --------------------------------------------------------- | ------------------------------------------------------------ |
| [`azure_ai_image_generation`](#azure_ai_image_generation) | Generate images using an Azure OpenAI DALL-E deployment      |
| [`azure_ai_create_response`](#azure_ai_create_response)   | Create a model response using the Azure OpenAI Responses API |
| [`azure_ai_get_response`](#azure_ai_get_response)         | Get a model response by ID                                   |
| [`azure_ai_delete_response`](#azure_ai_delete_response)   | Delete a model response                                      |
| [`azure_ai_cancel_response`](#azure_ai_cancel_response)   | Cancel an in-progress response                               |

***

## azure\_ai\_image\_generation

Generate images using an Azure OpenAI DALL-E deployment

**Parameters:**

| Parameter    | Type   | Required | Default        | Description                                    |
| ------------ | ------ | -------- | -------------- | ---------------------------------------------- |
| `deployment` | string | Yes      | —              | Azure OpenAI deployment name (e.g., dall-e-3)  |
| `apiVersion` | string | No       | `"2024-10-21"` | Azure OpenAI API version (default: 2024-10-21) |
| `prompt`     | string | Yes      | —              | Text description of the image to generate      |
| `n`          | number | No       | `1`            | Number of images to generate                   |
| `size`       | string | No       | `"1024x1024"`  | Image size                                     |
| `quality`    | string | No       | —              | Image quality (DALL-E 3 only)                  |
| `style`      | string | No       | —              | Image style (DALL-E 3 only)                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "deployment": {
        "type": "string",
        "description": "Azure OpenAI deployment name (e.g., dall-e-3)"
      },
      "apiVersion": {
        "type": "string",
        "default": "2024-10-21",
        "description": "Azure OpenAI API version (default: 2024-10-21)"
      },
      "prompt": {
        "type": "string",
        "description": "Text description of the image to generate"
      },
      "n": {
        "type": "number",
        "default": 1,
        "description": "Number of images to generate"
      },
      "size": {
        "type": "string",
        "enum": [
          "1024x1024",
          "1024x1792",
          "1792x1024"
        ],
        "default": "1024x1024",
        "description": "Image size"
      },
      "quality": {
        "type": "string",
        "enum": [
          "standard",
          "hd"
        ],
        "description": "Image quality (DALL-E 3 only)"
      },
      "style": {
        "type": "string",
        "enum": [
          "natural",
          "vivid"
        ],
        "description": "Image style (DALL-E 3 only)"
      }
    },
    "required": [
      "PCID",
      "deployment",
      "prompt"
    ]
  }
  ```
</Expandable>

***

## azure\_ai\_create\_response

Create a model response using the Azure OpenAI Responses API

**Parameters:**

| Parameter        | Type      | Required | Default     | Description                                                                  |
| ---------------- | --------- | -------- | ----------- | ---------------------------------------------------------------------------- |
| `model`          | string    | No       | `"gpt-4.1"` | Model to use (e.g., gpt-5.4, gpt-5.2, gpt-5.1, gpt-5, gpt-4.1, gpt-4.1-mini) |
| `messages`       | object\[] | Yes      | —           | Array of conversation messages                                               |
| `temperature`    | number    | No       | `1`         | Sampling temperature (0-2)                                                   |
| `maxTokens`      | number    | No       | —           | Maximum tokens to generate                                                   |
| `topP`           | number    | No       | —           | Nucleus sampling parameter                                                   |
| `tools`          | object\[] | No       | —           | Tools available to the model                                                 |
| `toolChoice`     | string    | No       | —           | Tool choice configuration                                                    |
| `responseFormat` | object    | No       | —           | Response format specification                                                |
| `metadata`       | object    | No       | —           | Custom metadata for the response                                             |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "model": {
        "type": "string",
        "default": "gpt-4.1",
        "description": "Model to use (e.g., gpt-5.4, gpt-5.2, gpt-5.1, gpt-5, gpt-4.1, gpt-4.1-mini)"
      },
      "messages": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "role": {
              "type": "string",
              "enum": [
                "system",
                "user",
                "assistant",
                "tool"
              ],
              "description": "Message role"
            },
            "content": {
              "type": "string",
              "description": "Message content"
            }
          }
        },
        "description": "Array of conversation messages"
      },
      "temperature": {
        "type": "number",
        "default": 1,
        "description": "Sampling temperature (0-2)"
      },
      "maxTokens": {
        "type": "number",
        "description": "Maximum tokens to generate"
      },
      "topP": {
        "type": "number",
        "description": "Nucleus sampling parameter"
      },
      "tools": {
        "type": "array",
        "items": {
          "type": "object",
          "additionalProperties": true
        },
        "description": "Tools available to the model"
      },
      "toolChoice": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "object",
            "additionalProperties": true
          }
        ],
        "description": "Tool choice configuration"
      },
      "responseFormat": {
        "type": "object",
        "additionalProperties": true,
        "description": "Response format specification"
      },
      "metadata": {
        "type": "object",
        "additionalProperties": true,
        "description": "Custom metadata for the response"
      }
    },
    "required": [
      "PCID",
      "messages"
    ]
  }
  ```
</Expandable>

***

## azure\_ai\_get\_response

Get a model response by ID

**Parameters:**

| Parameter    | Type   | Required | Default | Description             |
| ------------ | ------ | -------- | ------- | ----------------------- |
| `responseId` | string | Yes      | —       | Response ID to retrieve |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "responseId": {
        "type": "string",
        "description": "Response ID to retrieve"
      }
    },
    "required": [
      "PCID",
      "responseId"
    ]
  }
  ```
</Expandable>

***

## azure\_ai\_delete\_response

Delete a model response

**Parameters:**

| Parameter    | Type   | Required | Default | Description           |
| ------------ | ------ | -------- | ------- | --------------------- |
| `responseId` | string | Yes      | —       | Response ID to delete |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "responseId": {
        "type": "string",
        "description": "Response ID to delete"
      }
    },
    "required": [
      "PCID",
      "responseId"
    ]
  }
  ```
</Expandable>

***

## azure\_ai\_cancel\_response

Cancel an in-progress response

**Parameters:**

| Parameter    | Type   | Required | Default | Description           |
| ------------ | ------ | -------- | ------- | --------------------- |
| `responseId` | string | Yes      | —       | Response ID to cancel |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "responseId": {
        "type": "string",
        "description": "Response ID to cancel"
      }
    },
    "required": [
      "PCID",
      "responseId"
    ]
  }
  ```
</Expandable>