Cards

Returns a digital business card and its share links (public page + vCard). Defaults to the calling user's own card; pass user_id for a specific teammate, slug for a card by its public URL segment, or ble_code after discovering a nearby digital business card over Bluetooth.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/cards.get_card \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "slug": "example"
  }'

Over MCP the same operation is the tool cards_get_card at https://app.chirply.io/api/mcp, same bearer token, same input.

Saves someone's published digital business card (by its public slug) into this account's CRM as a contact. If the person is already a contact (matched by phone/email) they're linked, not duplicated.

Also answers to import digital card, receive business card.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/cards.import_card \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "example"
  }'

Over MCP the same operation is the tool cards_import_card at https://app.chirply.io/api/mcp, same bearer token, same input.

Lists the digital business cards in this account — each person's shareable card, whether it's published, its public URL and view count.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/cards.list_cards \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool cards_list_cards at https://app.chirply.io/api/mcp, same bearer token, same input.

Creates or updates a person's digital business card (name, title, company, phones, emails, website, socials, bio, theme) and can publish or unpublish it. Publishing makes it world-readable at its public URL. Defaults to the calling user's card; an API key must pass user_id.

Also answers to edit digital card, publish business card, update my card.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/cards.save_card \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "display_name": "Example"
  }'

Over MCP the same operation is the tool cards_save_card at https://app.chirply.io/api/mcp, same bearer token, same input.

Reads a photo of a physical business card with AI vision and saves the details as a CRM contact — creating a new contact, or updating the one it matches by phone/email — with the card's front (and optional back) images attached. Uses this account's own OpenRouter/AI key, so the AI cost is billed to the account. Images are supplied as a data URL (data:image/jpeg;base64,…) or an https image URL. AN https IMAGE URL IS FETCHED FROM OUR SERVERS and handed to the vision provider, so everything in it — host, path, query string — is disclosed to whoever operates that address. That, and the AI spend, is why it asks for confirmation.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Also answers to scan business card, read business card, card to contact.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/cards.scan \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "image_front": "example"
  }'

Over MCP the same operation is the tool cards_scan at https://app.chirply.io/api/mcp, same bearer token, same input.

Upload a profile photo or cover/banner image for a digital business card. Stores the image permanently in the account's own R2 storage (up to 10 MB, which can incur storage and egress cost) and returns its public URL — pass that URL as avatar_url or cover_url on cards.save_card to actually attach it to a card. This call alone does not change any card.

Also answers to upload card photo, upload card avatar, upload card cover.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/cards.upload_card_asset \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "avatar",
    "content_base64": "example"
  }'

Over MCP the same operation is the tool cards_upload_card_asset at https://app.chirply.io/api/mcp, same bearer token, same input.