GET
/v1/schemas/fal/audio/xai/grok-voice
Accept:
| field | recorded source |
|---|---|
| schema | Source linked above. upstream-spec Source traceb1ffdf559aef2a90b567b048e89e9f51a7b306a88460e92bf2163c2287257789{
"fetchedAt": 1794286801,
"extractorVersion": "2",
"verifiedAt": null
} |
Request body
5 properties · 1 required · 5 $defs| property | type | description | constraints |
|---|---|---|---|
| audio_url* | string | URL of the audio containing the user's speech. The Grok agent listens to it and replies with speech. Most common audio formats are supported; the audio is converted to 16-bit 24 kHz mono PCM before being sent to Grok. Maximum duration 10 minutes, maximum file … | |
| voice | enum | Built-in xAI voice for the agent's reply. Uses Grok's default voice when omitted. | carina | zagan | helix | orion | luna | iris · +22 more · nullable |
| prompt | string | Optional system instructions describing the agent's persona and conversation context. Uses Grok's default persona when omitted. | length ≤ 20000 · nullable |
| tools | GrokToolsConfiguration | Server-side tools available to the agent. Web, X, and remote MCP tools are supported; every tool is disabled by default. file_search/collections are unsupported by the typed configuration due to ZDR. | |
| enable_safety_checker | boolean | Authorized callers may set false to request relaxed screening. | default: true |
Types
5 $defsGrokRemoteMCPToolobject
A caller-selected remote MCP server that xAI will connect to.
| server_description | string | Description of the capabilities exposed by this server. | length ≤ 2000 · nullable |
| server_url* | string | Caller-selected HTTP(S) MCP endpoint. xAI makes the remote connection and supports Streaming HTTP/SSE transports. Use at your own risk; fal does not connect to or SSRF-fetch this URL. | length ≥ 1 · format: uri |
| authorization | string | Sensitive authorization value forwarded only to xAI. | format: password · nullable |
| enabled | boolean | False omits this server. | default: true |
| server_label* | string | Label xAI uses to identify and prefix this server's tools. | length ≥ 1 · length ≤ 128 |
| allowed_tools | string[] | Optional allow-list of tool names exposed from this server. | items ≥ 1 · nullable |
| headers | object | Sensitive MCP request headers forwarded only to xAI. | nullable |
GrokSearchLocationobject
| city | string | City used to localize web-search results. | length ≥ 1 · length ≤ 128 · nullable |
| timezone | string | IANA timezone name, for example America/New_York. | length ≥ 1 · length ≤ 128 · nullable |
| country | string | Country used to localize web-search results. | length ≥ 1 · length ≤ 128 · nullable |
| region | string | Region used to localize web-search results. | length ≥ 1 · length ≤ 128 · nullable |
GrokToolsConfigurationobject
Typed xAI tools supported by this app's convenience configuration.
| x_search | GrokXSearchTool | xAI-managed X search; off unless enabled is set true. | |
| mcp_servers | GrokRemoteMCPTool[] | Remote MCP servers that xAI connects to and executes. | |
| web_search | GrokWebSearchTool | xAI-managed web search; off unless enabled is set true. |
GrokWebSearchToolobject
Configuration for one xAI web_search tool declaration.
| enable_image_understanding | boolean | Allow the agent to inspect images found during web search. | nullable |
| enabled | boolean | Whether to include web_search in session.tools. Disabled by default; set true to let the agent search the web. | default: false |
| excluded_domains | string[] | Exclude results from at most five domains, without protocol or path. | items ≥ 1 · items ≤ 5 · nullable |
| allowed_domains | string[] | Restrict results to at most five domains, without protocol or path. | items ≥ 1 · items ≤ 5 · nullable |
| location | GrokSearchLocation | Optional location used to localize search results. | nullable |
GrokXSearchToolobject
Configuration for one xAI x_search tool declaration.
| excluded_x_handles | string[] | Exclude posts from at most 20 X handles. | items ≥ 1 · items ≤ 20 · nullable |
| enable_image_understanding | boolean | Allow the agent to inspect images found on X. | nullable |
| from_date | string | Earliest post date, as ISO YYYY-MM-DD. | format: date · nullable |
| enabled | boolean | Whether to include x_search in session.tools. Disabled by default; set true to let the agent search X posts. | default: false |
| enable_video_understanding | boolean | Allow the agent to inspect videos found on X. | nullable |
| to_date | string | Latest post date, as ISO YYYY-MM-DD. | format: date · nullable |
| allowed_x_handles | string[] | Restrict results to posts from at most 20 X handles. | items ≥ 1 · items ≤ 20 · nullable |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"fal","endpointId":"xai/grok-voice","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}