Run object
Run Object
ID of the task that a user can use for polling its status
The final result object, may vary based on task type.
any of completed
, failed
, in_progress
Detailed results for each requirement.
Specifies the data sources used to retrieve contextual information for a run. Contains optional web_search
and file_search
results.
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.
The example below shows a fully completed run object, including the requirements_result and data_sources fields.
These fields are not included by default and will only appear in the response if you explicitly request them using the include parameter.
For details on how to use this parameter, see the include
parameter documentation.