Bring Process Management
to Vercel AI SDK

You must provide the card_id of the card to clone. The new card is created in the same pipe as the original, starting at the first phase. This is useful for creating similar requests, repeating processes, or using an existing card as a template for new items. The cloned card gets a new unique ID but retains all field data. Clone an existing card to create a duplicate

You must provide the pipe_id and a JSON object containing field values matching the pipe's required fields. Fields are key-value pairs where keys are field IDs and values are the data to store. Optionally specify a phase_id to start the card in a specific phase (defaults to first phase). Example fields: { "name": "John Doe", "email": "john@example.com", "priority": "High" } Create a new card in a Pipefy pipe

You must provide the card_id. This action cannot be undone. Use this to remove test cards, duplicates, or items that were created in error. Be careful as this will also remove all associated data including comments, attachments, and field values for that card. Delete a card from a pipe

Use the card_id obtained from list_cards to inspect full card information. This is useful for reviewing card details before updating fields or moving to another phase. Get detailed information about a specific card

Use the organization_id to inspect your organization's structure, understand team membership, and discover available pipes for card management. Get details of a Pipefy organization

Phases represent steps in a pipe's workflow. Use the phase_id obtained from get_pipe or list_phases to inspect phase configuration. This helps understand what fields are required at each step of the workflow. Get details of a specific phase

Each pipe represents a workflow or process with multiple phases (steps) and custom fields. Use the pipe_id to get the structure of a pipe before creating cards or managing cards within it. The response includes all phases with their IDs, names, and the custom fields defined for the pipe. Get details of a specific Pipefy pipe (process)

Use this to verify API token access and discover organization IDs needed for other queries. This is also useful for understanding which organizations and pipes the user has access to. Get the authenticated user profile

Cards represent individual items flowing through the pipe's workflow phases (e.g., requests, tasks, tickets, leads). You must provide the pipe_id. Optionally filter by phase_id to see cards in a specific phase. Each card includes title, current phase, completion status, due date, and assignees. Use this to monitor workflow progress and identify cards that need attention. List all cards in a pipe with optional phase filter

Each phase represents a stage that cards flow through in the process. Use this to understand the workflow structure and identify phase IDs for filtering cards or moving cards between phases. The response includes phase names and card counts. List all phases in a pipe

Each pipe represents a structured workflow with phases, fields, and cards. You must provide the organization_id which can be found in your Pipefy URL or obtained from get_user_profile. Use this to discover all available pipes before managing cards within them. List all pipes in an organization

You must provide the card_id and the target phase_id. This is the primary way to advance workflow items through the pipe's process steps. Common use cases: moving a request from "New" to "In Review", advancing a lead to "Qualified", or progressing a task to "Completed". The card retains all its field values after moving. Move a card to a different phase in the pipe

This is useful for finding cards by email, name, ID, or any custom field content. You must provide the pipe_id, field_id (the field to search in), and search_value (text to find). Results include card title, current phase, status, and all field values for matching cards. The search uses a "contains" operator for flexible matching. Search cards in a pipe by a specific field value

You must provide the card_id, the field_id of the field to update, and the new value as a string. This is useful for updating card information as requests progress or details change. Common updates: changing priority, updating contact info, modifying descriptions, or setting dates. Update a specific field value on a card