# Batch API API

> Batch API API on Apizie: 9 endpoints (Gets the latest state of a long-running operation. Clients can use this method to poll the operation result…, Deletes a long-running operation. This method indicates that the client is no longer interested in the…, Lists information about the supported locations for this service. This method lists locations based on the…, Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/analytics:googleapis-batch/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:googleapis-batch`
- Category: Analytics
- Status: byok
- Source: https://cloud.google.com/batch/
- Page: https://www.apizie.tech/api/analytics/googleapis-batch
- OpenAPI: https://www.apizie.tech/api/analytics/googleapis-batch/openapi.json

An API to manage the running of Batch resources on Google Cloud Platform.

## Endpoints

### Gets the latest state of a long-running operation. Clients can use this method to poll the operation result…
`GET https://www.apizie.tech/v1/analytics:googleapis-batch/batch-projects-locations-operations-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource. |

### Deletes a long-running operation. This method indicates that the client is no longer interested in the…
`POST https://www.apizie.tech/v1/analytics:googleapis-batch/batch-projects-locations-operations-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource to be deleted. |

### Lists information about the supported locations for this service. This method lists locations based on the…
`GET https://www.apizie.tech/v1/analytics:googleapis-batch/batch-projects-locations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| extraLocationTypes | string | no | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter | string | no | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is… |
| name | string | yes | The resource that owns the locations collection, if applicable. |
| pageSize | integer | no | The maximum number of results to return. If not set, the service selects a default. |
| pageToken | string | no | A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |

### Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the…
`POST https://www.apizie.tech/v1/analytics:googleapis-batch/batch-projects-locations-operations-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource to be cancelled. |
| body | object | yes | JSON request body |

### List all Jobs for a project within a region.
`GET https://www.apizie.tech/v1/analytics:googleapis-batch/batch-projects-locations-jobs-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | List filter. |
| orderBy | string | no | Optional. Sort results. Supported are "name", "name desc", "create_time", and "create_time desc". |
| pageSize | integer | no | Page size. |
| pageToken | string | no | Page token. |
| parent | string | yes | Parent path. |

### Create a Job.
`POST https://www.apizie.tech/v1/analytics:googleapis-batch/batch-projects-locations-jobs-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | no | ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters and must start with… |
| parent | string | yes | Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}" |
| requestId | string | no | Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will… |
| body | object | yes | JSON request body |

### List Tasks associated with a job.
`GET https://www.apizie.tech/v1/analytics:googleapis-batch/batch-projects-locations-jobs-task-groups-tasks-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Task filter, null filter matches all Tasks. Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING |
| pageSize | integer | no | Page size. |
| pageToken | string | no | Page token. |
| parent | string | yes | Required. Name of a TaskGroup from which Tasks are being requested. Pattern:… |

### Lists operations that match the specified filter in the request. If the server doesn't support this method,…
`GET https://www.apizie.tech/v1/analytics:googleapis-batch/batch-projects-locations-operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | The standard list filter. |
| name | string | yes | The name of the operation's parent resource. |
| pageSize | integer | no | The standard list page size. |
| pageToken | string | no | The standard list page token. |
| returnPartialSuccess | boolean | no | When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the… |

### Report agent's state, e.g. agent status and tasks information
`POST https://www.apizie.tech/v1/analytics:googleapis-batch/batch-projects-locations-state-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. Format: projects/{project}/locations/{location} {project} should be a project number. |
| body | object | yes | JSON request body |

## Example
```
curl "https://www.apizie.tech/v1/analytics:googleapis-batch/batch-projects-locations-operations-get" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Batch API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/analytics:googleapis-batch/batch-projects-locations-operations-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Batch API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Batch API itself also needs your own key from googleapis.com.

### Can AI agents use the Batch API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key analytics:googleapis-batch.

### What is the status of the Batch API API?
Needs your own provider key (bring your own key)