# Gradient Works API

> Gradient Works provides programmatic access to market maps, target books, account distributions, retrievals, queues, reps, and carve projects.

- All endpoints require Bearer token authentication.
- Target book, distribution, retrieval, queue, and rep endpoints require a `crm_connection_id`; call CRM Connections first.
- Paginated endpoints use cursor-based pagination via `next_records_url`.

## API Reference

### CRM Connections

- [List crm connections](https://agents.gradient.works/docs/api/crm-connections/list-crm-connections.md): List CRM connections.
- [List crm connection metadata](https://agents.gradient.works/docs/api/crm-connections/list-crm-connection-metadata.md): List CRM object field metadata for a connection.

### Assets

- [Upload asset direct](https://agents.gradient.works/docs/api/assets/upload-asset-direct.md): Upload a file directly.
- [Get upload url upload url](https://agents.gradient.works/docs/api/assets/get-upload-url-upload-url.md): Get a pre-signed upload URL.
- [Complete upload complete](https://agents.gradient.works/docs/api/assets/complete-upload-complete.md): Complete a file upload.

### Market Maps

- [List market maps](https://agents.gradient.works/docs/api/market-maps/list-market-maps.md): List market maps.
- [Create market map](https://agents.gradient.works/docs/api/market-maps/create-market-map.md): Create a market map.
- [Get market map](https://agents.gradient.works/docs/api/market-maps/get-market-map.md): Get a market map.
- [List runs](https://agents.gradient.works/docs/api/market-maps/list-runs.md): List runs for a market map.
- [Get current run](https://agents.gradient.works/docs/api/market-maps/get-current-run.md): Get the latest run.
- [Get run](https://agents.gradient.works/docs/api/market-maps/get-run.md): Get a single run.
- [Get run progress](https://agents.gradient.works/docs/api/market-maps/get-run-progress.md): Poll run progress.
- [Get run results](https://agents.gradient.works/docs/api/market-maps/get-run-results.md): Get run results.
- [Cancel run](https://agents.gradient.works/docs/api/market-maps/cancel-run.md): Cancel a run.
- [List accounts](https://agents.gradient.works/docs/api/market-maps/list-accounts.md): List all accounts in a market map.
- [Post accounts](https://agents.gradient.works/docs/api/market-maps/post-accounts.md): Add accounts to an existing market map.
- [Get market map summary](https://agents.gradient.works/docs/api/market-maps/get-market-map-summary.md): Get market map summary metrics.
- [List clusters](https://agents.gradient.works/docs/api/market-maps/list-clusters.md): List clusters in a market map.
- [Get cluster](https://agents.gradient.works/docs/api/market-maps/get-cluster.md): Get cluster detail.
- [Export market map](https://agents.gradient.works/docs/api/market-maps/export-market-map.md): Export market map as CSV.
- [Get account detail](https://agents.gradient.works/docs/api/market-maps/get-account-detail.md): Get full account detail.
- [Get similar accounts detail](https://agents.gradient.works/docs/api/market-maps/get-similar-accounts-detail.md): Get similar reference accounts.

### Target Books

- [List target books](https://agents.gradient.works/docs/api/target-books/list-target-books.md): List target books.
- [Create target book](https://agents.gradient.works/docs/api/target-books/create-target-book.md): Create a target book.
- [Get target book](https://agents.gradient.works/docs/api/target-books/get-target-book.md): Get a target book.
- [Patch target book](https://agents.gradient.works/docs/api/target-books/patch-target-book.md): Update target book fields.
- [Delete target book](https://agents.gradient.works/docs/api/target-books/delete-target-book.md): Delete a target book.
- [Add reps to target book](https://agents.gradient.works/docs/api/target-books/add-reps-to-target-book.md): Add reps to a target book.
- [Assign reps to target book](https://agents.gradient.works/docs/api/target-books/assign-reps-to-target-book.md): Replace all reps on a target book.
- [Remove reps from target book](https://agents.gradient.works/docs/api/target-books/remove-reps-from-target-book.md): Remove one or more reps from a target book.
- [Post target book segment](https://agents.gradient.works/docs/api/target-books/post-target-book-segment.md): Add a new segment to a target book.
- [Put target book segments](https://agents.gradient.works/docs/api/target-books/put-target-book-segments.md): Replace all segments on a target book.
- [Patch target book segment](https://agents.gradient.works/docs/api/target-books/patch-target-book-segment.md): Update a target book segment.
- [Delete target book segment](https://agents.gradient.works/docs/api/target-books/delete-target-book-segment.md): Delete a segment from a target book.

### Reps

- [List reps](https://agents.gradient.works/docs/api/reps/list-reps.md): List bookbuilder reps.
- [Get rep](https://agents.gradient.works/docs/api/reps/get-rep.md): Get a bookbuilder rep.
- [List rep accounts](https://agents.gradient.works/docs/api/reps/list-rep-accounts.md): List a rep's accounts.
- [List rep opportunities](https://agents.gradient.works/docs/api/reps/list-rep-opportunities.md): List a rep's opportunities.
- [Get rep activities by day chart](https://agents.gradient.works/docs/api/reps/get-rep-activities-by-day-chart.md): Get a rep's completed-activity counts bucketed by day.
- [Get rep created opps by day chart](https://agents.gradient.works/docs/api/reps/get-rep-created-opps-by-day-chart.md): Get a rep's created-opportunity counts bucketed by day.

### Distributions

- [List distribution templates](https://agents.gradient.works/docs/api/distributions/list-distribution-templates.md): List distribution templates.
- [Get distribution](https://agents.gradient.works/docs/api/distributions/get-distribution.md): Get a distribution.
- [List runs](https://agents.gradient.works/docs/api/distributions/list-runs.md): List distribution runs.
- [Get run](https://agents.gradient.works/docs/api/distributions/get-run.md): Get distribution run detail.
- [List run assignments](https://agents.gradient.works/docs/api/distributions/list-run-assignments.md): List assignments for a distribution run.

### Queues

- [List queues](https://agents.gradient.works/docs/api/queues/list-queues.md): List queues.
- [Get queue](https://agents.gradient.works/docs/api/queues/get-queue.md): Get a queue.

### Retrievals

- [List retrieval templates](https://agents.gradient.works/docs/api/retrievals/list-retrieval-templates.md): List retrieval templates.
- [Get retrieval](https://agents.gradient.works/docs/api/retrievals/get-retrieval.md): Get a retrieval.
- [List runs](https://agents.gradient.works/docs/api/retrievals/list-runs.md): List retrieval runs.
- [Get run](https://agents.gradient.works/docs/api/retrievals/get-run.md): Get retrieval run detail.
- [List run assignments](https://agents.gradient.works/docs/api/retrievals/list-run-assignments.md): List assignments for a retrieval run.

### Carve / Projects

- [Get projects](https://agents.gradient.works/docs/api/carve-projects/get-projects.md): List projects.
- [Create project](https://agents.gradient.works/docs/api/carve-projects/create-project.md): Create a project.
- [Get project](https://agents.gradient.works/docs/api/carve-projects/get-project.md): Get a project.
- [Get project data sources](https://agents.gradient.works/docs/api/carve-projects/get-project-data-sources.md): List data sources for a project.
- [Attach project data source](https://agents.gradient.works/docs/api/carve-projects/attach-project-data-source.md): Attach a data source to a project.
- [Get project data source](https://agents.gradient.works/docs/api/carve-projects/get-project-data-source.md): Get a data source for a project.
- [Replace project data source](https://agents.gradient.works/docs/api/carve-projects/replace-project-data-source.md): Replace a data source on a project.
- [Remove project data source](https://agents.gradient.works/docs/api/carve-projects/remove-project-data-source.md): Remove a data source from a project.
- [Download project data source](https://agents.gradient.works/docs/api/carve-projects/download-project-data-source.md): Get a presigned download URL for a data source file.
- [List project scenarios](https://agents.gradient.works/docs/api/carve-projects/list-project-scenarios.md): List scenarios for a project.
- [Create project scenario](https://agents.gradient.works/docs/api/carve-projects/create-project-scenario.md): Create a Carve scenario.
- [Get project scenario](https://agents.gradient.works/docs/api/carve-projects/get-project-scenario.md): Get a scenario.
- [Rename project scenario](https://agents.gradient.works/docs/api/carve-projects/rename-project-scenario.md): Rename a Carve scenario.
- [Delete project scenario](https://agents.gradient.works/docs/api/carve-projects/delete-project-scenario.md): Delete a Carve scenario.
- [Get scenario account sheet](https://agents.gradient.works/docs/api/carve-projects/get-scenario-account-sheet.md): Get the account sheet for a scenario.
- [Get scenario account sheet schema](https://agents.gradient.works/docs/api/carve-projects/get-scenario-account-sheet-schema.md): Get the schema of a scenario account sheet.
- [Reset scenario account sheet](https://agents.gradient.works/docs/api/carve-projects/reset-scenario-account-sheet.md): Refresh a scenario to use the latest account sheet version.
- [Get account sheet refresh preview](https://agents.gradient.works/docs/api/carve-projects/get-account-sheet-refresh-preview.md): Preview changes that would result from refreshing the account sheet.
- [Refresh account sheet](https://agents.gradient.works/docs/api/carve-projects/refresh-account-sheet.md): Refresh the account sheet for a project.
- [Set scenario account sheet overrides](https://agents.gradient.works/docs/api/carve-projects/set-scenario-account-sheet-overrides.md): Override Results and Rationale for rows in a scenario account sheet.
- [Clone project scenario](https://agents.gradient.works/docs/api/carve-projects/clone-project-scenario.md): Clone a Carve scenario.
- [Update project scenario description](https://agents.gradient.works/docs/api/carve-projects/update-project-scenario-description.md): Update a Carve scenario description.
- [Deploy project salesforce](https://agents.gradient.works/docs/api/carve-projects/deploy-project-salesforce.md): Deploy a Carve scenario to Salesforce.
- [Deploy project hubspot](https://agents.gradient.works/docs/api/carve-projects/deploy-project-hubspot.md): Deploy a Carve scenario to HubSpot.
- [Get deploy job](https://agents.gradient.works/docs/api/carve-projects/get-deploy-job.md): Get the status of a Carve deploy job.

### Assignments

- [List assignments](https://agents.gradient.works/docs/api/assignments/list-assignments.md): List assignments.

### Log Entries

- [List log entries](https://agents.gradient.works/docs/api/log-entries/list-log-entries.md): List log entries.

### Flows

- [List flows](https://agents.gradient.works/docs/api/flows/list-flows.md): List flows.
- [Create flow](https://agents.gradient.works/docs/api/flows/create-flow.md): Create a flow.
- [Get flow](https://agents.gradient.works/docs/api/flows/get-flow.md): Get a flow.
- [List flow versions](https://agents.gradient.works/docs/api/flows/list-flow-versions.md): List flow versions.
- [Create flow version](https://agents.gradient.works/docs/api/flows/create-flow-version.md): Create a flow version.
- [Get flow version](https://agents.gradient.works/docs/api/flows/get-flow-version.md): Get a flow version.
- [Update flow version](https://agents.gradient.works/docs/api/flows/update-flow-version.md): Update a flow version.
- [Activate flow version](https://agents.gradient.works/docs/api/flows/activate-flow-version.md): Activate a flow version.
- [Deactivate flow version](https://agents.gradient.works/docs/api/flows/deactivate-flow-version.md): Deactivate a flow.

## MCP

- [MCP tool reference](https://agents.gradient.works/docs/mcp.md)