BugHerd API
★ 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.
Use for: I need to create a new BugHerd project for a client onboarding, List all open tasks in my BugHerd project, Add a comment to a BugHerd task with reproduction steps, Move a BugHerd task to the In Progress column
Not supported: Does not handle billing, SSO configuration, or the in-page feedback widget itself — use for managing projects, tasks, comments, attachments, and webhooks only.
Jentic publishes the only available OpenAPI specification for BugHerd API, keeping it validated and agent-ready. BugHerd is a visual feedback and bug tracking tool that lets clients and testers pin tasks directly onto a webpage. The v2 API exposes projects, tasks, columns, comments, attachments, members, guests, and webhooks, so teams can move BugHerd into their own workflows. Use it to sync visual bugs into Jira, route attachments into a CMS, post comments from chat, or trigger downstream automation through webhooks.
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.
1
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 | sh2
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 instanceJentic 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
Move tasks between Kanban columns and reorder columns inside a project
Post comments and upload attachments against a specific task
Register and remove webhooks that fire when tasks change
Look up tasks and projects assigned to a particular user
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
POST
/projects/{project_id}/tasks/{task_id}/attachments.json
Add an attachment to a task
POST
/webhooks.json
Create a webhook
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
Your BugHerd API key is stored encrypted in the Jentic vault. Agents never see the raw key — Jentic constructs the basic auth header at execution time and returns only the API response.
Intent-based discovery
Agents search Jentic with intents like create a bug task or list project tasks and Jentic returns the matching BugHerd operations with input schemas, so the agent calls the right endpoint without browsing docs.
Time to first call
Direct BugHerd integration: roughly half a day for auth, attachment upload handling, and webhook setup. Through Jentic: under 30 minutes — search, load, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
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 at https://app.jentic.com/sign-up.
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.
GET STARTED