ai_parser_get_details
Read-onlyIdempotent
Check an AI parser's status, fields, and errors. Poll after create or update until status is FINISHED.
Instructions
Get an AI parser's details and generation status.
Returns the parser's status ('GENERATING', 'FINISHED', or 'FAILED'), its
fields, example results, and any error. Poll this after 'ai_parser_create'
(or after a field-editing 'ai_parser_update') until status is 'FINISHED'.
When to use:
- Polling a parser's status after create/update until it is 'FINISHED'
- Inspecting a parser's fields before parsing with it
When NOT to use:
- Extracting data from a page (use 'ai_parser_parse_url')
Args:
params (AiParserGetParams): parser_id (required) and optional version.
Returns:
str: JSON with the parser details and status.
Raises:
ToolError: If the API key is missing, the rate limit is exceeded, or
the request fails.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |