GET
/v1/schemas/perplexity/chat/v1%2Fagent
Accept:
Request body
22 properties · 1 required · 45 $defs| property | type | description | constraints |
|---|---|---|---|
| input* | string | InputItem[] | Input content - either a string or array of input items | |
| background | boolean | Run the response asynchronously. With `stream: false`, the request returns immediately with `status: "queued"`; poll `GET /v1/responses/{id}` until the response reaches a terminal status. Background runs are durable, so you can also stream them and reconnect a… | |
| instructions | string | System instructions for the model | |
| language_preference | string | ISO 639-1 language code for response language | |
| max_output_tokens | integer | Optional total output-token budget across the run, including for Anthropic models. When neither the request nor its effort level or saved profile supplies a budget, each generation can produce up to 128,000 output tokens, capped by the model's supported limit. | n ≥ 1 · format: int32 |
| max_steps | integer | Maximum number of research loop steps. If provided, overrides the effort level's max_steps value. For requests that specify model or models without an effort level, the default is 1. Set max_steps to at least 3 when using finance_search with a direct model so … | 1 ≤ n ≤ 500 · format: int32 |
| model | string | Model ID in provider/model format (e.g., "openai/gpt-5.6-terra", "anthropic/claude-sonnet-5-5"). If models is also provided, models takes precedence. Required if neither models nor effort is provided. | |
| models | string[] | Model fallback chain. Each model is in provider/model format. Models are tried in order until one succeeds. Max 5 models allowed. If set, takes precedence over single model field. The response.model will reflect the model that actually succeeded. | items ≥ 1 · items ≤ 5 |
| effort | string | Effort to run, as `name`, `name@latest`, or `name@<version>` (e.g., "fast", "low", "fast@2026-09-29.0"). An effort level is a pre-configured model with system prompt and search parameters. `name` and `name@latest` run the active version. `name@<version>` runs … | |
| profile | ProfileReference | Saved, versioned configuration to run with. The version is resolved when the request is admitted. Cannot be combined with effort. | |
| previous_response_id | string | OpenAI-compatible previous response id for multi-turn response chains. When set, the new response continues from the completed prior response's saved state. The prior response must belong to the same account and have completed. | |
| prompt_cache_key | string | Stable key for prompt cache affinity. Send the same key on requests that share a prompt prefix, including retries and multi-turn conversations, so later requests can read the cached prefix. The key is scoped to your account and does not affect model routing. S… | |
| prompt_cache_options | PromptCacheOptions | Prompt cache options. `implicit` (default) keeps the default cache breakpoints and provider automatic caching. `explicit` turns both off, so only `input_text` parts marked with `prompt_cache_breakpoint` are cached; with no marks, the request makes no cache wri… | |
| reasoning | ReasoningConfig | ||
| response_format | ResponseFormat | Specifies the desired output format for the model response | |
| store | boolean | OpenAI-compatible storage toggle. When false, the response is hidden from later retrieve calls, and the echoed response reports `store: false`. It can still be used as a `previous_response_id` continuation source. | |
| stream | boolean | If true, returns SSE stream instead of JSON | |
| tools | Tool[] | Tools available to the model | |
| tool_choice | enum | object | Tool choice strategy. Use `{"type":"image_search"}` to force image search. | |
| skills | Skill[] | Built-in, request-scoped inline, and organization-owned custom skills available to the model. Skill metadata is disclosed to the model up front; full instructions are loaded on demand through the load_skill tool. Selecting any skill enables the sandbox tool fo… | items ≤ 16 |
| temperature | number | OpenAI-compatible sampling temperature forwarded to generation. | 0 ≤ n ≤ 2 · format: double |
| top_p | number | OpenAI-compatible nucleus sampling parameter forwarded to generation. | 0 ≤ n ≤ 1 · format: double |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"perplexity","endpointId":"v1/agent","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}