Gitar Logo
EnterpriseAPI Reference

Run the Gitar agent

Run the Gitar agent. The agent will analyze the repository and perform automated tasks. Requires Administrator scope.

POST
/external/runs

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

branch_name?|

Optional branch name for the execution. If not provided, a default branch will be created.

instructions*string

Instructions for the agent to execute

metadata?|
repository*|

Platform-specific repository reference

run_id?|

Optional run ID to continue a previous conversation. When provided, the agent maintains context from the previous run, allowing for follow-up instructions and iterative work.

Response Body

application/json

application/json

curl -X POST "https://api.gitar.ai/v1/external/runs" \  -H "Content-Type: application/json" \  -d '{    "instructions": "string",    "repository": {      "data": {        "owner": "string",        "repo": "string"      },      "platform": "github"    }  }'
{
  "branch_name": "string",
  "created_at": "string",
  "repository": {
    "data": {
      "owner": "string",
      "repo": "string"
    },
    "platform": "github"
  },
  "run_id": "string",
  "status": "string",
  "updated_at": "string"
}
Empty
Empty
Empty
Empty
{
  "message": "string"
}