# Pigment

```json
{
  "name": "Pigment",
  "slug": "pigment",
  "url": "https://composio.dev/toolkits/pigment",
  "markdown_url": "https://composio.dev/toolkits/pigment.md",
  "logo_url": "https://logos.composio.dev/api/pigment",
  "categories": [
    "data & analytics"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-11-12T05:36:00.067Z"
}
```

![Pigment logo](https://logos.composio.dev/api/pigment)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Pigment MCP or direct API to import planning data, query workspaces, update models, and export reports through natural language.

## Summary

Pigment is a business planning platform for modeling, importing, and exporting workspace data.
It helps teams automate planning workflows and keep business data organized.

## Categories

- data & analytics

## Toolkit Details

- Tools: 26

## Images

- Logo: https://logos.composio.dev/api/pigment

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Pigment.
  - Setup:
    - Configure Api Key credentials for Pigment.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Review actuals versus budget for Q4
- Export monthly revenue plan from Pigment
- Update headcount assumptions across planning model

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `PIGMENT_DOWNLOAD_FILE` | Download File | Download the raw bytes of one file from a Pigment application. |
| `PIGMENT_EXPORT_LIST` | Export List | Download a Pigment List as CSV through v1 with property selection, item and property filters, and formatting options. |
| `PIGMENT_EXPORT_LIST_LEGACY` | Export List (Legacy) | Download a List as CSV through Pigment's officially published unversioned legacy endpoint with all documented filters and formatting options. Prefer the current Export List action for new workflows. |
| `PIGMENT_EXPORT_METRIC` | Export Metric | Download a Pigment Metric as CSV through v1 with scenarios, deprecated dimension filters, recursive filters, and formatting options. |
| `PIGMENT_EXPORT_METRIC_LEGACY` | Export Metric (Legacy) | Download a Metric as CSV through Pigment's officially published unversioned legacy endpoint with scenarios, deprecated and recursive filters, and all documented formatting options. Prefer the v1 action for new workflows. |
| `PIGMENT_EXPORT_TABLE` | Export Table | Download a Pigment Table as CSV through v1 with metrics, scenarios, filters, selected fields, and formatting options. |
| `PIGMENT_EXPORT_TABLE_LEGACY` | Export Table (Legacy) | Download a Table as CSV through Pigment's officially published unversioned legacy endpoint with metrics, scenarios, filters, selected fields, and formatting options. Prefer the current Export Table action for new workflows. |
| `PIGMENT_EXPORT_VIEW` | Export View | Download a Pigment view as CSV through the v1 endpoint, optionally choosing comma or semicolon delimiters. |
| `PIGMENT_EXPORT_VIEW_LEGACY` | Export View (Legacy) | Download a view as CSV through Pigment's officially published unversioned legacy endpoint; prefer v1 for new workflows. |
| `PIGMENT_GET_DATA_FLOW_STATUS` | Get Data Flow Status | Get the current status and per-step results of a Pigment Data Flow execution. |
| `PIGMENT_GET_IMPORT_STATUS` | Get Import Status | Get v1 status for a CSV, integration, list-copy, or metric-copy import, optionally including the detailed report. |
| `PIGMENT_GET_IMPORT_STATUS_LEGACY` | Get Import Status (Legacy) | Get CSV import status through Pigment's officially published unversioned legacy endpoint; prefer the v1 action for new workflows. |
| `PIGMENT_LIST_APPLICATIONS` | List Applications | List Pigment applications visible to the Modeling Metadata API key owner. |
| `PIGMENT_LIST_APPLICATION_SNAPSHOTS` | List Application Snapshots | List scheduled, in-progress, completed, and failed Pigment application snapshots. |
| `PIGMENT_LIST_BLOCKS` | List Blocks | List visible Pigment Lists, Transaction Lists, Metrics, and Tables, optionally for one application. |
| `PIGMENT_LIST_DATA_FLOWS` | List Data Flows | List the Data Flows visible in one Pigment application. |
| `PIGMENT_LIST_FILES` | List Files | Return one cursor-controlled page of file metadata for a Pigment application, newest first. Each page contains at most 1000 files. |
| `PIGMENT_LIST_IMPORT_CONFIGURATIONS` | List Import Configurations | List Pigment import configurations, optionally narrowing the results by application and block. |
| `PIGMENT_LIST_VIEWS` | List Views | List Pigment view metadata, optionally narrowing the results by application and block. |
| `PIGMENT_PUSH_CSV_IMPORT` | Push CSV Import | Upload CSV bytes to start a Pigment v1 import and return an import ID for status checks. |
| `PIGMENT_PUSH_CSV_IMPORT_LEGACY` | Push CSV Import (Legacy) | Upload CSV bytes to start an import through Pigment's officially published unversioned legacy endpoint; prefer v1 for new workflows. |
| `PIGMENT_PUSH_LOOKER_IMPORT` | Push Looker Import | Start a Pigment v1 Looker import from a saved configuration; the official contract declares no request body. |
| `PIGMENT_PUSH_LOOKER_IMPORT_LEGACY` | Push Looker Import (Legacy) | Start a Looker import through Pigment's officially published unversioned legacy endpoint; the documented operation has no request body. Prefer the current Push Looker Import action for new workflows. |
| `PIGMENT_TRIGGER_DATA_FLOW` | Trigger Data Flow | Start one Pigment Data Flow execution and return its execution ID for status checks. The flow may perform irreversible actions. |
| `PIGMENT_TRIGGER_IMPORT` | Trigger Import | Trigger a configured integration import, list-to-list copy, or metric-to-metric copy and return its import ID. |
| `PIGMENT_UPLOAD_FILE` | Upload File | Upload one file to a Pigment application and return the created file's metadata. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK, the OpenAI provider, and the OpenAI SDK
```python
pip install composio composio_openai openai
```

```typescript
npm install @composio/core @composio/openai openai
```

#### Path 1, Step 2: Create a Composio session

Initialize Composio with the OpenAI Responses provider and create a session scoped to Pigment
```python
import json
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
client = OpenAI()

session = composio.create(user_id="your-user-id", toolkits=["pigment"])
tools = session.tools()
```

```typescript
import OpenAI from "openai";
import { Composio } from "@composio/core";
import { OpenAIResponsesProvider } from "@composio/openai";

const composio = new Composio({ provider: new OpenAIResponsesProvider() });
const client = new OpenAI();

const session = await composio.create("your-user-id", { toolkits: ["pigment"] });
const tools = await session.tools();
```

#### Path 1, Step 3: Run Pigment tools with your agent

Send a request, execute the Pigment tool calls through the session, and print the final answer
```python
response = client.responses.create(
    model="gpt-5.6-sol",
    tools=tools,
    input=[{"role": "user", "content": "List all workspaces in my Pigment account"}],
)

while True:
    tool_calls = [o for o in response.output if o.type == "function_call"]
    if not tool_calls:
        break
    results = composio.provider.handle_tool_calls(response=response, session=session)
    response = client.responses.create(
        model="gpt-5.6-sol",
        tools=tools,
        previous_response_id=response.id,
        input=[
            {"type": "function_call_output", "call_id": call.call_id, "output": json.dumps(results[i])}
            for i, call in enumerate(tool_calls)
        ],
    )

print(response.output_text)
```

```typescript
let response = await client.responses.create({
  model: "gpt-5.6-sol",
  tools,
  input: [{ role: "user", content: "List all workspaces in my Pigment account" }],
});

while (response.output.some((o) => o.type === "function_call")) {
  const outputs = await composio.provider.handleToolCalls(session, response.output);
  response = await client.responses.create({
    model: "gpt-5.6-sol",
    tools,
    previous_response_id: response.id,
    input: outputs,
  });
}

console.log(response.output_text);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and your agent framework
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/mcp @ai-sdk/openai
```

#### Path 2, Step 2: Create a session with MCP enabled

Create a session scoped to Pigment and read its MCP URL and headers
```python
from composio import Composio

composio = Composio()
session = composio.create(user_id="your-user-id", toolkits=["pigment"], mcp=True)
```

```typescript
import { Composio } from "@composio/core";

const composio = new Composio();
const { mcp } = await composio.create("your-user-id", {
  toolkits: ["pigment"],
  mcp: true,
});
```

#### Path 2, Step 3: Connect your agent to the MCP server

Pass the session's MCP URL and headers to your agent and run a Pigment request
```python
import asyncio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions, AssistantMessage, TextBlock

options = ClaudeAgentOptions(
    mcp_servers={
        "composio": {
            "type": "http",
            "url": session.mcp.url,
            "headers": session.mcp.headers,
        }
    },
    system_prompt="You are a helpful assistant with access to Pigment tools.",
    tools=[],
    allowed_tools=["mcp__composio__*"],
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query("List all workspaces in my Pigment account")
        async for message in client.receive_response():
            if isinstance(message, AssistantMessage):
                for block in message.content:
                    if isinstance(block, TextBlock):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { createMCPClient } from "@ai-sdk/mcp";
import { openai } from "@ai-sdk/openai";
import { generateText, stepCountIs } from "ai";

const client = await createMCPClient({
  transport: { type: "http", url: mcp.url, headers: mcp.headers },
});

const { text } = await generateText({
  model: openai("gpt-5.6-sol"),
  tools: await client.tools(),
  prompt: "List all workspaces in my Pigment account",
  stopWhen: stepCountIs(10),
});

console.log(text);
await client.close();
```

## Why Use Composio?

### 1. AI Native Pigment Integration

- Supports both Pigment MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for importing, modeling, exporting, and querying Pigment workspace data

### 2. Secure API Key Management

- Securely store and use your Pigment API key without hard-coding it in agent logic
- Central place to manage, scope, and revoke Pigment access
- Per user and per environment credentials for safer deployments

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Pigment
- Scoped, least privilege access to Pigment workspaces and planning resources
- Full audit trail of agent actions to support review and compliance

## Use Pigment with any AI Agent Framework

Choose a framework you want to connect Pigment with:

- [ChatGPT](https://composio.dev/toolkits/pigment/framework/chatgpt)
- [Claude Cowork](https://composio.dev/toolkits/pigment/framework/claude-cowork)
- [Hermes](https://composio.dev/toolkits/pigment/framework/hermes-agent)
- [Atomic Agent](https://composio.dev/toolkits/pigment/framework/atomic-agent)

## Related Toolkits

- [Firecrawl](https://composio.dev/toolkits/firecrawl) - Firecrawl automates large-scale web crawling and data extraction. It helps organizations efficiently gather, index, and analyze content from online sources.
- [Tavily](https://composio.dev/toolkits/tavily) - Tavily offers powerful search and data retrieval from documents, databases, and the web. It helps teams locate and filter information instantly, saving hours on research.
- [Exa](https://composio.dev/toolkits/exa) - Exa is a data extraction and search platform for gathering and analyzing information from websites, APIs, or databases. It helps teams quickly surface insights and automate data-driven workflows.
- [Serpapi](https://composio.dev/toolkits/serpapi) - SerpApi is a real-time API for structured search engine results. It lets you automate SERP data collection, parsing, and analysis for SEO and research.
- [Excel](https://composio.dev/toolkits/excel) - Microsoft Excel is a robust spreadsheet application for organizing, analyzing, and visualizing data. It's the go-to tool for calculations, reporting, and flexible data management.
- [Peopledatalabs](https://composio.dev/toolkits/peopledatalabs) - Peopledatalabs delivers B2B data enrichment and identity resolution APIs. Supercharge your apps with accurate, up-to-date business and contact data.
- [Snowflake](https://composio.dev/toolkits/snowflake) - Snowflake is a cloud data warehouse built for elastic scaling, secure data sharing, and fast SQL analytics across major clouds.
- [Posthog](https://composio.dev/toolkits/posthog) - PostHog is an open-source analytics platform for tracking user interactions and product metrics. It helps teams refine features, analyze funnels, and reduce churn with actionable insights.
- [21risk](https://composio.dev/toolkits/_21risk) - 21RISK is a web app built for easy checklist, audit, and compliance management. It streamlines risk processes so teams can focus on what matters.
- [Abstract](https://composio.dev/toolkits/abstract) - Abstract provides a suite of APIs for automating data validation and enrichment tasks. It helps developers streamline workflows and ensure data quality with minimal effort.
- [AccuWeather](https://composio.dev/toolkits/accu_weather) - AccuWeather is a global weather service providing current conditions, forecasts, MinuteCast precipitation, alerts, and lightning data. Use it for fast, localized forecasts and real-time weather alerts.
- [Adafruit IO](https://composio.dev/toolkits/adafruit_io) - Adafruit IO is Adafruit's cloud platform for connected device and IoT project data. It helps you store, visualize, and act on sensor feeds without running your own backend.
- [Addressfinder](https://composio.dev/toolkits/addressfinder) - Addressfinder is a data quality platform for verifying addresses, emails, and phone numbers. It helps you ensure accurate customer and contact data every time.
- [Agentql](https://composio.dev/toolkits/agentql) - Agentql is a toolkit that connects AI agents to the web using a specialized query language. It enables structured web interaction and data extraction for smarter automations.
- [Agenty](https://composio.dev/toolkits/agenty) - Agenty is a web scraping and automation platform for extracting data and automating browser tasks—no coding needed. It streamlines data collection, monitoring, and repetitive online actions.
- [Ahrefs MCP](https://composio.dev/toolkits/ahrefs_mcp) - Ahrefs MCP is Ahrefs' hosted MCP server for SEO data and insights. Use it to access backlinks, organic metrics, keyword research, and competitor analysis.
- [Akta](https://composio.dev/toolkits/akta) - Akta is a company intelligence platform providing enrichment, news, and alternative business signals. It helps teams build targeted company lists and enrich data-driven workflows.
- [Ambee](https://composio.dev/toolkits/ambee) - Ambee is an environmental data platform providing real-time, hyperlocal APIs for air quality, weather, and pollen. Get precise environmental insights to power smarter decisions in your apps and workflows.
- [Ambient weather](https://composio.dev/toolkits/ambient_weather) - Ambient Weather is a platform for personal weather stations with a robust API for accessing local, real-time, and historical weather data. Get detailed environmental insights directly from your own sensors for smarter apps and automations.
- [Amplitude](https://composio.dev/toolkits/amplitude) - Amplitude is a digital analytics platform for product and behavioral data insights. It helps teams analyze user journeys and make data-driven decisions quickly.

## Frequently Asked Questions

### Do I need my own developer credentials to use Pigment with Composio?

Yes, Pigment requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)