# Coalesce Jobs API

> Coalesce Jobs API on Apizie: 11 endpoints (List Environments, Get Environment, List Nodes, Get Node, …) 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://apizie.tech/v1/open-data:coalesce/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:coalesce`
- Category: Open Data
- Status: byok
- Source: https://coalesce.io
- Page: https://apizie.tech/api/open-data/coalesce
- OpenAPI: https://apizie.tech/api/open-data/coalesce/openapi.json

REST API for performing operations with the Coalesce backend.

## Endpoints

### List Environments
`GET https://apizie.tech/v1/open-data:coalesce/environments-list-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| detail | boolean | no | Include the full detail of the environments. |

### Get Environment
`GET https://apizie.tech/v1/open-data:coalesce/environments-get-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environmentID | string | yes | The environment ID. |

### List Nodes
`GET https://apizie.tech/v1/open-data:coalesce/nodes-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environmentID | string | yes | The environment ID. |
| detail | boolean | no | Include the full detail of the nodes. |

### Get Node
`GET https://apizie.tech/v1/open-data:coalesce/nodes-get-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environmentID | string | yes | The environment ID. |
| nodeID | string | yes | The node ID. |

### List Runs
`GET https://apizie.tech/v1/open-data:coalesce/runs-list-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The maximum number of runs to return. |
| startingFrom | string | no | The starting run ID, runStartTime, or runEndTime (exclusive) for paging the query results. |
| orderBy | string | no | The field used to order results. |
| orderByDirection | string | no | The sort order for query results. |
| runType | string | no | A run type to filter the query results. |
| runStatus | string | no | A status value to filter the query results. |
| environmentID | string | no | An environment ID to filter the query results. |
| detail | boolean | no | Include the full detail of the run. |

### Get Run
`GET https://apizie.tech/v1/open-data:coalesce/runs-get-run-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| runID | integer | yes | The run ID. |

### List Run Results
`GET https://apizie.tech/v1/open-data:coalesce/runs-list-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| runID | integer | yes | The run ID. |

### Trigger Job to Run
`POST https://apizie.tech/v1/open-data:coalesce/jobs-initiate-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get Job Status
`GET https://apizie.tech/v1/open-data:coalesce/jobs-get-status-updates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| runCounter | integer | yes | ID of the run to query |

### Trigger Job to Re-Run
`POST https://apizie.tech/v1/open-data:coalesce/jobs-trigger-rerun` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Cancel Running Job
`POST https://apizie.tech/v1/open-data:coalesce/jobs-cancel-job-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

## Example
```
curl "https://apizie.tech/v1/open-data:coalesce/environments-list-information" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Coalesce Jobs API?
Create a free Apizie key, then send GET https://apizie.tech/v1/open-data:coalesce/environments-list-information with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

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

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