Skip to main content

Consumption Guide: API, AI Credits, and Automations

This article details how Pipefy accounts for platform resource usage, ranging from external API calls to the use of artificial intelligence and automations.

Written by Product Team
Updated yesterday

1. API Calls

A Monetizable API Call is any processed request made by a user or third-party integration to Pipefy's external APIs to deliver data or perform actions.

What counts as an API Call:

  • External Requests: Calls made by users via Personal Access Tokens or Service Accounts.

  • GraphQL: Direct calls made via GraphQL.

  • IExternal Integrators: Calls originating from Zapier, Make, or any iPaaS that is not native to Pipefy or Workato.

  • Practical Examples:

    • Each individual call in the mutation setTableRecordFieldValue counts as one API Call.

    • A chatbot that updates Pipefy field-by-field will generate a charge for every update request made.

What does NOT count:

  • Internal platform calls (e.g., opening a pipe to view cards)

  • Calls made by native Automations, Pipefy integrations, or Workato

  • Calls made by public or customized apps from Outbound Labs.

Return Status and Billing:

Accounting depends on the HTTP status code returned by the request:

Status Range

Billable?

Justification

2xx (Success)

Yes

The request was processed successfully and consumed resources.

3xx (Redirection)

Yes

Backend resources were used to determine the redirection.

4xx (Client Error)

Depends

Billable: Data or path errors (404, 408, 422). Non-Billable: Authorization errors (401, 403).

5xx (Server Error)

No

The issue is internal, and the service was not delivered.

How to View API Call Consumption

  1. On the Home screen, click the Usage Stats shortcut (chart icon). This will open the Admin Panel directly in the statistics section.

  2. Within Usage Stats, click the API Calls tab. Here you will find the total calls processed in the selected period. For a detailed analysis, click Download report.

For further details, please visit the Usage Stats page


2. AI Credits

The use of Artificial Intelligence consumes specific credits based on the model used:

Base cost per Agent run

  • Pipefy AI: 2 AI Credits per execution

  • BYOLLM (Bring Your Own LLM): 1.5 AI Credits per execution

Additional costs (tools)

  • When an Agent uses additional tools (e.g., IDP, web search), extra AI Credits may be added on top of the base cost

  • Each tool has its own cost. For example:

    • IDP: +1 AI Credit per use

How to View AI Credit Consumption

  1. Navigate to Usage Stats.

  2. Click the AI Credits tab to see total credits consumed, broken down by resource type: Agents and Assistants.

  3. In the Agent Details section, use filters (Tags, Pipes, Status, and Events) for specific analysis.

    Important note: Unlike Automation Jobs, AI Credits are only consumed when an AI execution actually runs. Triggers without execution do not consume any AI Credits.

    For further details, please visit the Usage Stats page


3. Custom Integrations

This encompasses integrations via Workato and Activepieces (Pipefy Native iPaaS).

  • Rule: Each "task" executed consumes 1 Custom Integrations credit.

How to view Custom Integrations

  • Custom Integrations usage is not currently available in the admin panel (coming soon!)

  • To access this information, you need to contact your CSM or Support team


4. Automations (Automation Job - AJ)

  • General Rule: Every action triggered via AJ counts as 1 credit.

  • Trigger Logic: The credit is consumed at the moment of the trigger, even if the action is not completed due to missing conditional criteria (e.g., if the card assignee differs from the configuration).

  • Exception: The generate_with_ai action is not charged as an AJ; it is only billed as an AI credit.

How to View Automation Credit Consumption

  1. Navigate to Usage Stats and click the Automations tab.

  2. View the total Tasks processed for the month, monthly progression, and a general overview by period.

  3. The Automation Details table displays the number of tasks processed, tags, origin pipe, status, event, action, and creator for each automation.

    For further details, please visit the Usage Stats page


For further details on pricing and plan limits, please visit the Pipefy pricing page

Did this answer your question?