Create run
AI21 Maestro is currently in beta and available exclusively to early access users.
Request body
A list of conversational turns, alternating between the user and the assistant, or a single instruction string.
Please note that there are two different options for the input.
show possible types
show possible types
Text input string
A plain instruction string for AI21 Maestro. Equivalent to a single message with the user role.
Input messages object []
A list of message objects representing a multi-turn conversation alternating between the user and the assistant.
Explicit requirements for the output. The requirements can be in terms of content, style, format, genre, point of view, and various guardrails AI21 Maestro will allocate resources to maintain all requirements throughout the run. At the end of the run, the score for each requirement and the overall score will be returned. Users can specify up to 10 requirements.
Show properties
Show properties
The requirement’s name, which allows users to reference it in their applications later.
The requirement’s description in natural language. This will influence our result scoring and budget allocation. The maximum length for each description is 128 words.
Default: false.
If set to true
, and the associated requirement is not fully satisfied, the overall requirements_result score will be 0.
Examples of requirements:
- “Write up to 3 paragraphs”
- “Output only the answer”
- “Don’t mention a word about the company’s CEO”
- “Use a friendly tone”
Note:
Requirements only work if no tools are selected.
Avoid conflicting requirements
Conflicts may reduce run quality or prevent fulfillment.
An array of objects.
Show properties
Show properties
Supported values are file_search
and web_search
.
A set of resources used by AI21 Maestro’s tools.
Show properties
Show properties
When provided, this object defines filters that AI21 Maestro will apply whenever it performs a file search.
When provided, this object defines filters that AI21 Maestro will apply whenever it performs a web search.
Show properties
Show properties
Restrict web search to the specified URL prefixes. The following formats are valid:
https://example.com
– limits to URLs that start withwww.example.com
example.com
– limits to URLs that start withwww.example.com
example.com/page
– limits to URLs that start withwww.example.com/page
sub.example.com
– limits to URLs that start with the specified subdomain (e.g.,docs.example.com
,blog.example.com
)
If not provided, search is not restricted to specific domains.
defaults to null.
Specify a single model to be used for the run. Choose from the following:
First-Party Models:
jamba-large
jamba-mini
Third-Party Models:
gpt-4.1-large
gpt-4.1-mini
gpt-4o
claude-3.5-sonnet
claude-3.7-sonnet
gemini-2.5-pro
Controls how many resources AI21 Maestro allocates to fulfill the requirements. Accepted values:
high
medium
low
Defaults to low
if not provided.
Specify which extra fields should be included in the output. If not provided, none of these fields will be included. Supported values:
data_sources
— Includes thedata_sources
field in the output.requirements_result
— Includes detailed results for each requirement in therequirements_result
field.