---
title: "Convert French words to IPA (International Phonetic Alphabet) transcription. Accepts either a single word string or a…"
method: POST
path: "/api/french-to-ipa-agent"
tags: ["AI Agents"]
---

# Convert French words to IPA (International Phonetic Alphabet) transcription. Accepts either a single word string or a…

`POST /api/french-to-ipa-agent`

## Request

- Base URL: `https://platform.vocametrix.com`
- URL: `https://platform.vocametrix.com/api/french-to-ipa-agent`
- Auth: API key in header `X-API-Key`

## Request body

- object
  - `phoneticInput` object[], required: REQUIRED. Either a single French word as a string, OR a JSON-stringified array of up to 20 strings. The server detects which by attempting JSON.parse.
  - `threadId` string: Optional. Thread ID for multi-turn continuity.
  - `email` string: Optional. Used by the credit-validation flow.

## Response `200`

Successful response

- object
  - `success` boolean: Boolean.
  - `result` object: Object OR array of objects, mirroring the input shape. Each entry has the form { word, ipa: [...], ... }. The server checks `result.ipa.length` to count transcriptions; the rest of the shape is determined by the agent.
  - `threadId` string: Thread ID.
  - `agentName` string: Agent identifier.
  - `remaining_credits` number: Number.

## Other responses

- `400`: Bad request — missing or invalid parameter
- `401`: Unauthorized — missing or invalid API key
- `429`: Rate limit exceeded
- `500`: Server error

---

[API](https://skmtc.dev/vocametrix/apis/vocametrix-api.md) · [All operations](https://skmtc.dev/vocametrix/apis/vocametrix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vocametrix/apis/vocametrix-api/revisions/8a54d01bcc81?raw)