API Reference
Run an agent on a repository
Executes the specified agent on a repository. The agent will analyze the repository and perform automated tasks based on its configuration. Requires Administrator scope.
AuthorizationBearer <token>
In: header
Path Parameters
namestring
The name of the agent to run
branch_name?string | null
Optional branch name for the execution. If not provided, a default branch will be created.
inputs?object | null
Optional inputs for the agent execution as key-value pairs
Empty Object
repositorystring
The repository where the agent will be executed. Can be provided as:
- GitHub repository: "owner/repo" (e.g., "myorg/myrepo")
- GitLab repository: "group/project" (e.g., "mygroup/myproject")
- Full repository URL: "https://github.com/owner/repo"
- Repository name as configured in your Gitar organization
Response Body
curl -X POST "https://api.gitar.ai/v1/external/agents/string/runs" \
-H "Content-Type: application/json" \
-d '{
"repository": "string"
}'const body = JSON.stringify({
"repository": "string"
})
fetch("https://api.gitar.ai/v1/external/agents/string/runs", {
body
})package main
import (
"fmt"
"net/http"
"io/ioutil"
"strings"
)
func main() {
url := "https://api.gitar.ai/v1/external/agents/string/runs"
body := strings.NewReader(`{
"repository": "string"
}`)
req, _ := http.NewRequest("POST", url, body)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}import requests
url = "https://api.gitar.ai/v1/external/agents/string/runs"
body = {
"repository": "string"
}
response = requests.request("POST", url, json = body, headers = {
"Content-Type": "application/json"
})
print(response.text)import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;
import java.net.http.HttpRequest.BodyPublishers;
var body = BodyPublishers.ofString("""{
"repository": "string"
}""");
HttpClient client = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(10))
.build();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("https://api.gitar.ai/v1/external/agents/string/runs"))
.header("Content-Type", "application/json")
.POST(body)
.build();
try {
HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
System.out.println("Status code: " + response.statusCode());
System.out.println("Response body: " + response.body());
} catch (Exception e) {
e.printStackTrace();
}using System;
using System.Net.Http;
using System.Text;
var body = new StringContent("""
{
"repository": "string"
}
""", Encoding.UTF8, "application/json");
var client = new HttpClient();
var response = await client.PostAsync("https://api.gitar.ai/v1/external/agents/string/runs", body);
var responseBody = await response.Content.ReadAsStringAsync();{
"agent_name": "string",
"created_at": "string",
"execution_id": "string",
"repository": "string",
"status": "string"
}Empty
Empty
Empty
Empty
{
"message": "string"
}