Agent-ready OpenAPI document · curated by JenticDeveloper ToolsProject Managementbasic37 EndpointsREST
Know of an official OpenAPI document? Contribute it →
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.
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://jentic.com/install.sh?src=apis&api=%2Fapis%2Fbugherd.com%2Fbugherd" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fbugherd.com%2Fbugherd" | 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 — bugherd is a visual feedback and bug tracking tool that lets clients and testers pin tasks directly onto a webpage.
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
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
B
BugHerd API
- Non-Ready (F)39/100
74
Foundational Compliance56
Developer Experience & Jentic Compatibility45
AI-Readiness & Agent Experience94
Agent Usability10
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
74
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A-Signals: 4
94%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
56
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: CSignals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
25%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
45
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: DSignals: 4
20%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
59%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
10
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
10%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring BugHerd by hand means constructing its HTTP Basic auth header from your API key against www.bugherd.com/api_v2 and passing the project and task ids through every call yourself. Through Jentic you install once, import BugHerd from the API Directory, store the key once, and your agent calls it.
Permission scoping
BugHerd puts the project and task ids in the URL path (/projects/{project_id}/tasks/{task_id}/...), so a rule can pin your agent to one project: it can create tasks, comments, and attachments there and nothing else. You choose the operations it may call, so it can file tasks and comments without being able to register webhooks unless you add that.
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.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using BugHerd API through Jentic.
Does BugHerd publish an official OpenAPI specification?
Yes. BugHerd publishes an official machine-readable specification at `https://docs.bugherd.com/api/openapi.yaml`, linked from its own API reference at `https://docs.bugherd.com/api`. It declares OpenAPI 3.1.0, info.version 2.0.0, 27 paths and 41 operations, with HTTP basic authentication. The specification behind this page is a Jentic-curated OpenAPI 3.0.3 document built from BugHerd's HTML reference before that vendor document was adopted; it covers 37 operations under the same basic auth scheme, and the official spec is canonical where the two differ. 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.
GET STARTED