Configure the SuperAgent API with an agent

You can give a coding agent one file and let it handle the technical setup in your project.

Copy the setup file

1. Open hivemindos.app/superagent-api/llms.txt.
2. Copy the whole file.
3. Paste it into the agent that is working in your project.
4. Tell the agent which HivemindOS features your product needs.

The file is written as an agent task. It tells the agent to inspect your project, follow its existing conventions, use the live OpenAPI contract, create the smallest useful key, store secrets privately, add the client, and run live read-only checks.

Keep it as a reusable skill

If your agent supports skills, download hivemindos.app/superagent-api/SKILL.md and install it using that agent’s normal skill folder or skill manager.

Use the prompt for a one-time setup. Use the skill when you want the agent to keep managing access, endpoint limits, MCP, capabilities, Agent Credits, tests, and audits for the project.

Connect without writing a client

If the agent supports remote MCP servers, it can connect directly to https://api.hivemindos.app/mcp. Use the same restricted key in a protected Authorization header. The key must include services:read, actions.list, and only the exact additional access needed for the agent’s job.

See Connect an agent with MCP for the ready-to-copy configuration and tool behavior.

What you may need to provide

The agent first looks for HIVEMINDOS_API_KEY in your project’s private runtime settings. If it is missing, it can create the first key with an existing HIVEMINDOS_CREDIT_TOKEN.

Add either credential directly to the secret manager or private environment used by your project. Do not paste it into chat, source code, an example env file, a public issue, or a screenshot.

The agent should never show the secret value back to you. It should report only whether the named credential is set and whether the live checks passed.

What the agent should finish

The setup is complete when:

• your application loads its key from private runtime settings;
• the key can reach only the services and actions you chose;
• endpoint request and concurrency limits are active;
• live balance, service, and capability checks pass through your application’s real client path;
• a deliberately disallowed capability is denied when practical to test;
• mutations use idempotency keys; and
• no secret appears in the project diff, logs, tests, or documentation.

Paying for more Agent Credits

If you want the integration to buy Agent Credits directly, give its key the credits:write scope and the credits.x402.topUp operation. The agent can add an x402-aware client that pays Base payment challenges and credits the same HivemindOS account.

The agent must ask you to confirm the exact dollar amount before it signs or sends the payment. Top-ups may be $5 to $500. HivemindOS fixes and verifies the official revenue wallet, payment network, asset, amount, and credited account, so the integration cannot redirect the payment.

The first request receives an HTTP 402 payment challenge. The wallet client signs it and retries with the same Idempotency-Key. Success returns a receipt and the updated Agent Credit balance.

Review advanced details

Use the authentication guide to review key delegation, the endpoint limits guide to review per-operation ceilings, and the API reference for the exact x402 headers and response fields.

The live OpenAPI document remains the source of truth for generated clients and request validation.