create_pr - cliq

POST

/

git

/

create_pr

create_pr

curl --request POST \
  --url https://docs.getcliq.io/git/create_pr \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "git-create-pr",
  "agent": "git",
  "action": "create_pr"
}
'

import requests

url = "https://docs.getcliq.io/git/create_pr"

payload = {
    "name": "git-create-pr",
    "agent": "git",
    "action": "create_pr"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'git-create-pr', agent: 'git', action: 'create_pr'})
};

fetch('https://docs.getcliq.io/git/create_pr', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://docs.getcliq.io/git/create_pr",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'git-create-pr',
    'agent' => 'git',
    'action' => 'create_pr'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://docs.getcliq.io/git/create_pr"

	payload := strings.NewReader("{\n  \"name\": \"git-create-pr\",\n  \"agent\": \"git\",\n  \"action\": \"create_pr\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://docs.getcliq.io/git/create_pr")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"git-create-pr\",\n  \"agent\": \"git\",\n  \"action\": \"create_pr\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://docs.getcliq.io/git/create_pr")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"git-create-pr\",\n  \"agent\": \"git\",\n  \"action\": \"create_pr\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "text": "<string>",
  "data": {}
}

Body

application/json

Phase configuration for this action (team.yml shape).

name

string

required

Phase name in team.yml

Example:

"git-create-pr"

agent

enum<string>

required

Must be git

Available options:

git

action

enum<string>

required

Operation to run — create_pr

Available options:

create_pr

project_dir

string

Working tree the PR is opened from (defaults to process.cwd())

base_branch

string

Destination branch for the PR (e.g. 'master', 'develop'). Overrides settings..base_branch and the remote HEAD auto-detect; falls back to 'main' if none is available

notify

object

Pipeline lifecycle events this agent can handle (e.g. on_complete with action: create_pr)

Response

Phase completes successfully. Connector agents write artifacts under .cliq/files/{phase}/ and return structured data / text in the agent result.

ok

enum<boolean>

Available options:

true

text

string

Human-readable summary

data

object

Action-specific result payload

create_pr

curl --request POST \
  --url https://docs.getcliq.io/git/create_pr \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "git-create-pr",
  "agent": "git",
  "action": "create_pr"
}
'

import requests

url = "https://docs.getcliq.io/git/create_pr"

payload = {
    "name": "git-create-pr",
    "agent": "git",
    "action": "create_pr"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'git-create-pr', agent: 'git', action: 'create_pr'})
};

fetch('https://docs.getcliq.io/git/create_pr', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://docs.getcliq.io/git/create_pr",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'git-create-pr',
    'agent' => 'git',
    'action' => 'create_pr'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://docs.getcliq.io/git/create_pr"

	payload := strings.NewReader("{\n  \"name\": \"git-create-pr\",\n  \"agent\": \"git\",\n  \"action\": \"create_pr\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://docs.getcliq.io/git/create_pr")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"git-create-pr\",\n  \"agent\": \"git\",\n  \"action\": \"create_pr\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://docs.getcliq.io/git/create_pr")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"git-create-pr\",\n  \"agent\": \"git\",\n  \"action\": \"create_pr\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "text": "<string>",
  "data": {}
}