Skip to content

API Documentation

Welcome to the AgentQ API documentation.

Base URL

https://backend-app.agentq.id

Authentication

The API accepts a company API key via the X-API-Key header (recommended for automation) or a JWT bearer token obtained by logging in. See Authentication for both methods, how to get your key, and how to attribute automated results to a team member.

bash
curl -H "X-API-Key: YOUR_API_KEY" \
  "https://backend-app.agentq.id/projects/YOUR_PROJECT_ID/test-runs?page=1&limit=50"

Common Use Cases

  • Push automated test results from CI/CD — easiest via the Playwright or WebdriverIO integration libraries, which handle authentication, result matching, and screenshot/video upload for you.
  • Update a test result directly: PATCH /projects/:projectId/test-runs/:testRunId/test-results/tcId/:tcId
  • Read test runs and results: GET /projects/:projectId/test-runs and GET /projects/:projectId/test-runs/:testRunId/test-results

Support

For API support:

Released under the MIT License.