Skip to main content

Documentation Index

Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Get aggregate details for a related batch of jobs

Tool details

FieldValue
Nameget_job_batch
GroupJobs

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "batch_id": {
      "type": "string",
      "description": "Batch ID"
    }
  },
  "required": [
    "project_reference",
    "batch_id"
  ],
  "additionalProperties": false,
  "description": "Input schema for the get_job_batch tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the returned record."
    },
    "project_id": {
      "type": "string",
      "format": "uuid",
      "description": "Project identifier associated with this result."
    },
    "target": {
      "type": [
        "string",
        "null"
      ],
      "description": "The target associated with this tool result."
    },
    "job_count": {
      "type": "integer",
      "minimum": 0,
      "description": "The job count associated with this tool result."
    },
    "status_counts": {
      "type": "object",
      "properties": {
        "submitted": {
          "type": "integer",
          "minimum": 0,
          "description": "The submitted associated with this tool result."
        },
        "working": {
          "type": "integer",
          "minimum": 0,
          "description": "The working associated with this tool result."
        },
        "completed": {
          "type": "integer",
          "minimum": 0,
          "description": "The completed associated with this tool result."
        },
        "failed": {
          "type": "integer",
          "minimum": 0,
          "description": "The failed associated with this tool result."
        },
        "canceled": {
          "type": "integer",
          "minimum": 0,
          "description": "The canceled associated with this tool result."
        }
      },
      "required": [
        "submitted",
        "working",
        "completed",
        "failed",
        "canceled"
      ],
      "additionalProperties": false,
      "description": "Structured status counts details associated with this tool result."
    },
    "created_at": {
      "type": "string",
      "description": "Creation timestamp in ISO 8601 format."
    },
    "updated_at": {
      "type": "string",
      "description": "Last update timestamp in ISO 8601 format."
    },
    "result": {
      "anyOf": [
        {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "knowledge_ingest",
                  "description": "The kind associated with this tool result."
                },
                "total_count": {
                  "type": "integer",
                  "minimum": 0,
                  "description": "The total count associated with this tool result."
                },
                "completed_count": {
                  "type": "integer",
                  "minimum": 0,
                  "description": "The completed count associated with this tool result."
                },
                "skipped_count": {
                  "type": "integer",
                  "minimum": 0,
                  "description": "The skipped count associated with this tool result."
                },
                "failed_count": {
                  "type": "integer",
                  "minimum": 0,
                  "description": "The failed count associated with this tool result."
                },
                "processing": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "label": {
                        "type": "string",
                        "description": "The label associated with this tool result."
                      },
                      "path": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The path associated with this tool result."
                      },
                      "upload_id": {
                        "anyOf": [
                          {
                            "type": "string",
                            "format": "uuid",
                            "description": "The upload id associated with this tool result."
                          },
                          {
                            "type": "null",
                            "description": "The upload id returned by the tool."
                          }
                        ],
                        "description": "The upload id associated with this tool result."
                      },
                      "remote_path": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The remote path associated with this tool result."
                      },
                      "warning_count": {
                        "type": "integer",
                        "minimum": 0,
                        "description": "The warning count associated with this tool result."
                      }
                    },
                    "required": [
                      "label",
                      "path",
                      "upload_id",
                      "remote_path",
                      "warning_count"
                    ],
                    "additionalProperties": false,
                    "description": "One processing item associated with this tool result."
                  },
                  "description": "List of processing associated with this tool result."
                },
                "completed": {
                  "type": "array",
                  "items": {
                    "$ref": "#/properties/result/anyOf/0/anyOf/0/properties/processing/items",
                    "description": "One completed item returned by the tool."
                  },
                  "description": "List of completed associated with this tool result."
                },
                "skipped": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "label": {
                        "$ref": "#/properties/result/anyOf/0/anyOf/0/properties/processing/items/properties/label",
                        "description": "The label returned by the tool."
                      },
                      "path": {
                        "$ref": "#/properties/result/anyOf/0/anyOf/0/properties/processing/items/properties/path",
                        "description": "The path returned by the tool."
                      },
                      "upload_id": {
                        "$ref": "#/properties/result/anyOf/0/anyOf/0/properties/processing/items/properties/upload_id",
                        "description": "The upload id returned by the tool."
                      },
                      "remote_path": {
                        "$ref": "#/properties/result/anyOf/0/anyOf/0/properties/processing/items/properties/remote_path",
                        "description": "The remote path returned by the tool."
                      },
                      "warning_count": {
                        "$ref": "#/properties/result/anyOf/0/anyOf/0/properties/processing/items/properties/warning_count",
                        "description": "The warning count returned by the tool."
                      },
                      "message": {
                        "type": "string",
                        "description": "The message associated with this tool result."
                      }
                    },
                    "required": [
                      "label",
                      "path",
                      "upload_id",
                      "remote_path",
                      "warning_count",
                      "message"
                    ],
                    "additionalProperties": false,
                    "description": "One skipped item associated with this tool result."
                  },
                  "description": "List of skipped associated with this tool result."
                },
                "failed": {
                  "type": "array",
                  "items": {
                    "$ref": "#/properties/result/anyOf/0/anyOf/0/properties/skipped/items",
                    "description": "One failed item returned by the tool."
                  },
                  "description": "List of failed associated with this tool result."
                },
                "remaining": {
                  "type": "array",
                  "items": {
                    "$ref": "#/properties/result/anyOf/0/anyOf/0/properties/processing/items",
                    "description": "One remaining item returned by the tool."
                  },
                  "description": "List of remaining associated with this tool result."
                },
                "remaining_label": {
                  "type": "string",
                  "enum": [
                    "Remaining Files",
                    "Not Ingested Files"
                  ],
                  "description": "The remaining label associated with this tool result."
                }
              },
              "required": [
                "kind",
                "total_count",
                "completed_count",
                "skipped_count",
                "failed_count",
                "processing",
                "completed",
                "skipped",
                "failed",
                "remaining",
                "remaining_label"
              ],
              "additionalProperties": false,
              "description": "Structured option 1 details associated with this tool result."
            }
          ],
          "description": "The result associated with this tool result."
        },
        {
          "type": "null",
          "description": "The result returned by the tool."
        }
      ],
      "description": "The result associated with this tool result."
    }
  },
  "required": [
    "id",
    "project_id",
    "target",
    "job_count",
    "status_counts",
    "created_at",
    "updated_at",
    "result"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_job_batch tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}