BugHerd API

Name: BugHerd API
Brand: BugHerd API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsProject Managementbasic37 EndpointsREST

For Agents

Read and update BugHerd projects, visual bug tasks, comments, attachments, and webhooks across 37 endpoints.

Install Jentic One Beta

Connect the BugHerd API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the BugHerd API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with BugHerd API.

List, create, update, and delete BugHerd projects across the organisation

Add members and guests to a project to manage who can submit and triage feedback

Browse, create, and update tasks (visual bug reports) within any project

GET STARTED

Start building with BugHerd API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use BugHerd API for, with concrete tasks.

★ BugHerd to Jira Sync

Mirror visual bug reports captured in BugHerd into a Jira backlog. The agent registers a BugHerd webhook for task creation, then on each event reads the task with GET /projects/{project_id}/tasks/{task_id}.json and posts a structured Jira issue with the screenshot attachment URL and severity. Closing a Jira ticket can update the BugHerd column via the move tasks endpoint.

Subscribe to a BugHerd webhook for new tasks in project 4421, and for each event create a Jira issue including the BugHerd task description, severity, and attachment URLs.

Client Project Provisioning

When an agency onboards a new client, a script can spin up a BugHerd project, add the agency QA team as members, and invite the client as a guest. The API exposes POST /projects.json, POST /projects/{project_id}/add_member.json, and POST /projects/{project_id}/add_guest.json so the entire client setup runs from one workflow without dashboard clicks.

Create a BugHerd project named Acme Site Redesign, add three QA users as members, and add the client contact as a guest.

Visual Feedback Reports

Generate weekly reports for stakeholders by listing tasks across active projects, grouping by column status, and surfacing comment activity. GET /projects/active.json plus GET /projects/{project_id}/tasks.json returns the input you need, and column metadata via GET /projects/{project_id}/columns.json gives you the canonical pipeline names so every project's report is consistent.

For each active BugHerd project, list tasks, group by column, and post a Slack-formatted summary to a project channel.

AI Agent QA Triage via Jentic

An agent connected via Jentic can take a screenshot from a tester, identify which BugHerd project it belongs to, and create a task with a description, severity, and the image attached. The agent searches Jentic for create a bug task, loads the POST /projects/{project_id}/tasks.json schema, and chains the upload attachment call to keep the visual context attached.

Search Jentic for create a BugHerd task, load the schema, create a task in project 9912 with a tester-supplied description, then upload the attached screenshot to that task.

Key Endpoints

37 endpoints — jentic publishes the only available openapi specification for bugherd api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/projects.json

List projects

POST

/projects.json

Create a project

GET

/projects/{project_id}/tasks.json

List tasks in a project

POST

/projects/{project_id}/tasks.json

Create a task

POST

/projects/{project_id}/tasks/{task_id}/comments.json

Add a comment to a task

POST

/projects/{project_id}/tasks/{task_id}/attachments.json

Add an attachment to a task

POST

/webhooks.json

Create a webhook

GET

/projects.json

List projects

POST

/projects.json

Create a project

GET

/projects/{project_id}/tasks.json

List tasks in a project

POST

/projects/{project_id}/tasks.json

Create a task

POST

/projects/{project_id}/tasks/{task_id}/comments.json

Add a comment to a task

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your BugHerd API key is stored once, encrypted, by your own Jentic One instance and used to build the Basic auth header at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'create a bug task' or 'list project tasks', and Jentic returns the matching BugHerd operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

Time to first call

FAQs

Specific to using BugHerd API through Jentic.

Why is there no official OpenAPI spec for BugHerd API?

BugHerd does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call BugHerd API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

What authentication does the BugHerd API use?

BugHerd uses HTTP basic authentication. Pass your API key as the username and the literal string x as the password. Through Jentic, the API key is stored encrypted in the vault and the basic auth header is constructed at execution time without exposing the secret to the agent.

Can I create a task with an attached screenshot through the BugHerd API?

Yes, but it takes two calls. First create the task with POST /projects/{project_id}/tasks.json, then attach a file with POST /projects/{project_id}/tasks/{task_id}/attachments.json or the upload variant POST /projects/{project_id}/tasks/{task_id}/attachments/upload. Combine them in a single agent flow.

Does the BugHerd API support webhooks for task events?

Yes. POST /webhooks.json registers a webhook URL, GET /webhooks.json lists existing subscriptions, and DELETE /webhooks/{webhook_id}.json removes one. Use webhooks to drive downstream automation such as syncing tasks into Jira or Linear.

What are the rate limits for the BugHerd API?

BugHerd does not publish explicit rate limits in the OpenAPI spec. Treat it as a per-account fair-use API and add retry-with-backoff for HTTP 429 responses. Avoid polling tasks endpoints in tight loops - use webhooks for change detection.

How do I create a BugHerd task from an AI agent through Jentic?

Run pip install jentic and authenticate with your ak_* key. Search Jentic with create a BugHerd task, load the POST /projects/{project_id}/tasks.json operation, and execute it with project_id, description, and priority. Jentic injects the basic auth header from your stored API key.

Can I limit what my agent is allowed to do with the BugHerd API?

Yes. Because you run Jentic One yourself, your own rules decide which BugHerd operations and credentials the agent may use. Since BugHerd puts the project and task ids in the URL path, you can pin the agent to a single project so it only creates tasks, comments, and attachments there and touches nothing else. You also choose the exact operations it may call, so it can file tasks and post comments while remaining unable to register webhooks unless you grant that.

BugHerd API

Connect the BugHerd API to your agent

Capabilities

Start building with BugHerd API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs