answerline-dev · Schema

BatchTaskResponse

Artificial IntelligenceVisibilityMarketingAnalytics

Properties

Name Type Description
success boolean Set to true for every batch that was processed successfully; individual tasks inside it can still have failed.
summary object Totals across the whole batch.
results array Result for each task, listed by index in the same order as the input.
View JSON Schema on GitHub

JSON Schema

answerline-dev-batch-task-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/answerline-dev/json-schema/answerline-dev-batch-task-response-schema.json",
  "title": "BatchTaskResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/answerline-dev-async-api-openapi.yml#/components/schemas/BatchTaskResponse",
  "type": "object",
  "required": [
    "success",
    "summary",
    "results"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Set to true for every batch that was processed successfully; individual tasks inside it can still have failed."
    },
    "summary": {
      "type": "object",
      "required": [
        "total",
        "succeeded",
        "failed"
      ],
      "description": "Totals across the whole batch.",
      "properties": {
        "total": {
          "type": "integer",
          "description": "How many tasks the batch submission contained."
        },
        "succeeded": {
          "type": "integer",
          "description": "How many tasks were created without error."
        },
        "failed": {
          "type": "integer",
          "description": "How many tasks were not created."
        }
      }
    },
    "results": {
      "type": "array",
      "description": "Result for each task, listed by index in the same order as the input.",
      "items": {
        "oneOf": [
          {
            "$ref": "#/$defs/BatchTaskSuccessResult"
          },
          {
            "$ref": "#/$defs/BatchTaskFailureResult"
          }
        ]
      }
    }
  },
  "$defs": {
    "AsyncTaskCredits": {
      "type": "object",
      "required": [
        "creditsToCharge",
        "creditsCharged"
      ],
      "description": "Charge details for one async task, in USD.",
      "properties": {
        "creditsToCharge": {
          "type": "number",
          "description": "USD amount held back from the balance for this task."
        },
        "creditsCharged": {
          "type": [
            "number",
            "null"
          ],
          "description": "USD amount charged for the task (0 when a free request covered it); null while it has not finished."
        }
      }
    },
    "AsyncTaskSummary": {
      "type": "object",
      "required": [
        "id",
        "taskType",
        "status",
        "priority",
        "createdAt"
      ],
      "description": "Summary fields that every async task response includes.",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Identifier unique to the task."
        },
        "taskType": {
          "type": "string",
          "enum": [
            "AIMODE",
            "GOOGLE",
            "GOOGLE_NEWS",
            "GEMINI",
            "CHATGPT",
            "COPILOT",
            "PERPLEXITY",
            "GROK"
          ],
          "description": "Engine that handles this task."
        },
        "status": {
          "type": "string",
          "enum": [
            "QUEUED",
            "PROCESSING",
            "COMPLETED",
            "FAILED"
          ],
          "description": "Status of the task right now."
        },
        "priority": {
          "type": "integer",
          "description": "Priority of the task, from 1 to 10; tasks with higher numbers run first. Default: 1.",
          "minimum": 1,
          "maximum": 10
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "description": "Creation time of the task."
        },
        "latencyMs": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Time spent processing, in milliseconds, measured from the first pickup until the final outcome. The initial wait in the queue is not counted, but for a retried task it spans all attempts plus the backoff in between. Null for tasks in `QUEUED` or `PROCESSING` state, and for tasks that failed before processing began."
        },
        "idempotencyKey": {
          "type": [
            "string",
            "null"
          ],
          "description": "Idempotency key supplied with the request, if any."
        }
      }
    },
    "BatchTaskFailureResult": {
      "type": "object",
      "required": [
        "success",
        "index",
        "error"
      ],
      "properties": {
        "success": {
          "type": "boolean",
          "enum": [
            false
          ],
          "description": "Signals that the task did not succeed."
        },
        "index": {
          "type": "integer",
          "description": "Index of this task within the submitted request array, starting at 0."
        },
        "error": {
          "type": "object",
          "required": [
            "code",
            "message",
            "timestamp"
          ],
          "properties": {
            "code": {
              "type": "string",
              "description": "Code naming why the request failed.",
              "enum": [
                "VALIDATION_ERROR",
                "RESOURCE_ALREADY_EXISTS",
                "INSUFFICIENT_CREDITS"
              ]
            },
            "message": {
              "type": "string",
              "description": "Error description meant for people to read."
            },
            "details": {
              "type": "object",
              "description": "Extra information about the error, for example which fields failed validation."
            },
            "timestamp": {
              "type": "string",
              "format": "date-time",
              "description": "Time at which the error happened."
            }
          }
        }
      }
    },
    "BatchTaskSuccessResult": {
      "type": "object",
      "required": [
        "success",
        "index",
        "task",
        "credits"
      ],
      "properties": {
        "success": {
          "type": "boolean",
          "enum": [
            true
          ],
          "description": "Signals that the task was created."
        },
        "index": {
          "type": "integer",
          "description": "Index of this task within the submitted request array, starting at 0."
        },
        "task": {
          "allOf": [
            {
              "$ref": "#/$defs/AsyncTaskSummary"
            },
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "QUEUED"
                  ],
                  "description": "Status a task starts with when it is created."
                }
              }
            }
          ]
        },
        "credits": {
          "$ref": "#/$defs/AsyncTaskCredits"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/answerline-dev-batch-task-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.