HumanbasedDocs
Developer GuidesData and integrations

API keys and Agents

Create and protect a production API key, and use a wired Agent in a Campaign Pipeline.

An API key provides access to production data allowed by its scopes. An Agent can process or evaluate data inside a Pipeline.

Create a production API key

  1. Open Settings → API Keys.
  2. Select the Production environment.
  3. Select Create API Key.
  4. Enter the Name and Expiration.
  5. Select the scopes the integration needs: a Subscription scope for data delivery, a Campaign scope to read or change Campaigns from code.
  6. Create the API key.
  7. Immediately copy and securely store the complete Secret.

The complete Secret is displayed once. Do not place it in application code, chat messages, screenshots, or shared documents.

A Sandbox Key uses simulated data and cannot authenticate to the production API. A production key grants exactly what its scopes name — Subscription scopes decide which data it may pull, and Campaign scopes decide which Campaigns it may read or change. Scopes do not imply one another, so a key granted only data access cannot read a Campaign. See Campaign API.

API Keys page with complete navigation, Production environment, Subscription scope, key fields, and Create key actions. The fixture contains no real Secret.

Rotate or revoke a key

If a key may have been exposed:

  1. Create a replacement key.
  2. Update the applications that use the old key.
  3. Confirm that the new key works.
  4. Revoke the old key.

Revocation cannot be undone.

Wire in an Agent

  1. Open Agents → Agent Exchange.
  2. Find the capability you need among the currently visible Humanbased platform-certified Agents.
  3. Open the Agent card and review Overview, I/O contract, Pricing, Quality, Reviews, and Versions.
  4. Select Wire in.
  5. Return to Campaign → Open builder.
  6. Add Agent Task from Transform & Safety.
  7. Select the wired Agent, enter Instructions, Checks, and the Minimum rating, then save and connect the node.

Agent Exchange with complete navigation, search and capability filters, public platform-certified Agent cards, and the Agent Detail entry.

Agent Detail with I/O contract, version, quality, pricing, and Wire in. This public fixture does not imply open third-party listing.

Builder showing the wired Agent's destination context alongside the complete Pipeline and Save controls.

Your Agents shows the Agents owned or wired by the Organization, their state, and available usage information.

Third-party Agent listing is not open. List an agent is currently disabled, so do not use this page as a third-party publishing workflow.

For request authentication, see Authentication and environments.

On this page