Skip to main content

API

Use this page when you want to integrate Boldo with another system or automate work on the knowledge base.

The API flow has two parts:

  • the Developer page, where you manage the API key
  • the public API documentation page, where you can authenticate and test supported requests

Availability​

Required plan

API access depends on your plan. Check Organization → Developer to verify your access.

Generate your API key​

  1. Click the Organization icon
  2. Select "Developer"
  3. Click "Generate" if no key exists yet
  4. Display the key if needed
  5. Click "Copy API key" to copy it

If a key already exists, generating a new one immediately invalidates the previous key.

Current limitation

For now, Boldo supports only one API key per organization.

That key has full API access for the organization.

Security
  • Never share your API key
  • Don't store it in source control
  • Regenerate it immediately if you think it was exposed

Use the API documentation​

The interactive API documentation is the safest place to see what the current environment supports.

It lets you:

  • authenticate with your API key
  • check that the key works before writing your own scripts
  • inspect request and response formats
  • test live requests against your environment

When to use the API​

Use the API when you need repeatable or programmatic work on the knowledge base.

Typical cases include:

  • integrating Boldo with another system
  • running recurring synchronization jobs
  • automating repeated updates
  • building scripts or internal tools on top of Boldo

Use Import a CSV file instead when the need is a one-time bulk import handled by business users.

Use the UI when you are updating a few assets manually, adjusting the metamodel, or exporting a one-time CSV or image from the current screen.