Skip to main content

Introduction to the Public API

The Copera Public API is a REST API that lets you read and write your workspace data programmatically — boards and rows, documents, drive files, channels, search, notifications, and workspace metadata. Use it to build bots, automations, internal tools, and integrations.

  • Base URL: https://api.copera.ai/public/v1
  • Auth: Authorization: Bearer <token> (Personal Access Token, Integration API Key, or MCP OAuth token)
  • Format: JSON request and response bodies
tip

New here? Start with Getting Started to create a token and make your first request, then skim Authentication to pick the right token type.

What You Can Do​

Boards​

Work with structured data:

  • List boards and tables
  • Retrieve board and table details
  • Read and create rows
  • Authenticate rows and manage comments
  • Search across rows and board data

Documents​

Manage rich text documents:

  • Create, update, and delete documents
  • Read and write content as Markdown
  • Search across documents
  • Navigate document trees

Drive​

File storage and management:

  • Browse files and folders
  • Upload and download files
  • Create folders
  • Search across drive items

Messaging​

Send formatted messages to workspace channels for:

  • Notifications and alerts
  • Bot replies
  • Workflow updates
  • Reading and managing your own notifications

Tools & SDKs​

Node.js SDK
Full-featured TypeScript SDK with complete API coverage
CLI
Manage boards, docs, drive, and messaging from the terminal
GitHub Action
Send notifications from your CI/CD pipelines

Requirements​

To use the API:

  1. Create an integration (or a Personal Access Token) in your workspace.
  2. Generate a token — an Integration API Key (cp_key_…) or a Personal Access Token (cp_pat_…).
  3. Grant permission scopes — the relevant access_* scopes for what you need (access_boards, access_channels, access_docs, access_drive, access_notifications, access_bookings).
  4. Add the integration to the channels and boards it needs to reach. A token can only act on resources it has been granted access to.

See Authentication for the full breakdown of token types and scopes.

Next Steps​

  • Getting Started — Create a token and make your first request
  • Authentication — Token types, scopes, and the Bearer header
  • Developer Mode — Copy resource IDs straight from the Copera interface
  • Boards — Work with structured data
  • Docs — Manage documents
  • Drive — File storage and management
  • Channels — Send messages and notifications
  • API Reference — Browse every endpoint, parameter, and schema

Summary​

Use the Copera Public API to:

  • Read and create board data, rows, and comments
  • Manage documents and drive files
  • Send messages and create notifications
  • Search across your workspace
  • Build custom integrations with the SDK, CLI, or GitHub Action