For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Discord
DocsAPI Reference
DocsAPI Reference
  • Projects
    • GETList projects
    • POSTCreate a project
    • GETGet a project
    • DELDelete a project
    • PATCHUpdate a project
    • POSTTrigger a dynamic pull request run
    • GETList project credentials
    • POSTCreate a project credential
    • GETList project memories
    • POSTCreate a project memory
    • DELDelete a project memory
    • GETList project files
    • GETList project mobile apps
    • POSTUpload a project mobile app
    • DELDelete a project mobile app
    • POSTInitiate a project mobile app upload
    • POSTConfirm a project mobile app upload
  • Tests
    • GETList tests
    • POSTCreate a test
    • GETGet a test
    • DELDelete a test
    • PATCHUpdate a test
    • POSTTrigger a test run
  • Groups
    • GETList test groups
    • POSTCreate a test group
    • GETGet a test group
    • DELDelete a test group
    • PATCHUpdate a test group
    • POSTAdd a test to a group
    • DELRemove a test from a group
    • POSTTrigger a test group run
  • Webhooks
    • POSTTrigger a project webhook
    • POSTTrigger a group webhook
  • Test Runs
    • GETList test runs
    • GETGet test run status
    • POSTCancel a queued or running run
LogoLogo
Discord
Projects

Trigger a dynamic pull request run

||View as Markdown|
POST
https://tester.army/api/v1/projects/:projectId/pull-request-runs
POST
/api/v1/projects/:projectId/pull-request-runs
$curl -X POST https://tester.army/api/v1/projects/projectId/pull-request-runs \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "targetUrl": "string",
>  "pullRequest": {
>    "number": 1,
>    "title": "string",
>    "commitSha": "string"
>  }
>}'
1{
2  "status": "queued",
3  "runId": "string",
4  "projectId": "string",
5  "platform": "web",
6  "metadata": {
7    "github": {
8      "configured": true,
9      "checkRunCreated": true,
10      "commentTargetResolved": true,
11      "status": "not_configured"
12    },
13    "mobile": {
14      "source": "string",
15      "buildId": "string"
16    }
17  }
18}

Trigger the dynamic PR agent from CI using PR metadata. Callers do not send changed files; TesterArmy enriches with changed files and GitHub reporting only when the project has a supported GitHub connection.

Was this page helpful?
Previous

Update a project

Next

List project credentials

Built with

Authentication

AuthorizationBearer
API key authentication using Bearer token format

Path parameters

projectIdstringRequired
Project ID or shortId

Request

This endpoint expects an object.
objectRequired
OR
objectRequired

Response

Dynamic PR run queued successfully
statusenum
Allowed values:
runIdstringformat: "uuid"
projectIdstringformat: "uuid"
platformenum
Allowed values:
metadataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
413
Content Too Large Error
429
Too Many Requests Error
500
Internal Server Error
504
Gateway Timeout Error