Skip to main content
PATCH
/
projects
/
{id}
Update a project
curl --request PATCH \
  --url https://app.gc.ai/api/external/v1/projects/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Vendor: Acme MSA (renamed)",
  "description": "<string>",
  "custom_instructions": "<string>"
}
'
import requests

url = "https://app.gc.ai/api/external/v1/projects/{id}"

payload = {
"name": "Vendor: Acme MSA (renamed)",
"description": "<string>",
"custom_instructions": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Vendor: Acme MSA (renamed)',
description: '<string>',
custom_instructions: '<string>'
})
};

fetch('https://app.gc.ai/api/external/v1/projects/{id}', 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://app.gc.ai/api/external/v1/projects/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Vendor: Acme MSA (renamed)',
'description' => '<string>',
'custom_instructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://app.gc.ai/api/external/v1/projects/{id}"

payload := strings.NewReader("{\n \"name\": \"Vendor: Acme MSA (renamed)\",\n \"description\": \"<string>\",\n \"custom_instructions\": \"<string>\"\n}")

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

req.Header.Add("Authorization", "<api-key>")
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.patch("https://app.gc.ai/api/external/v1/projects/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Vendor: Acme MSA (renamed)\",\n \"description\": \"<string>\",\n \"custom_instructions\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.gc.ai/api/external/v1/projects/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Vendor: Acme MSA (renamed)\",\n \"description\": \"<string>\",\n \"custom_instructions\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "custom_instructions": "<string>",
  "is_access_controlled": true,
  "created_at": "<string>",
  "updated_at": "<string>"
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}
{
"error": "<string>",
"code": "<string>",
"message": "<string>",
"details": {}
}

Authorizations

Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → API.

Path Parameters

id
string<uuid>
required

The project ID

Body

application/json
name
string

New project name (non-empty after trim)

Minimum string length: 1
Example:

"Vendor: Acme MSA (renamed)"

description
string | null

New project description, or null to clear it

custom_instructions
string | null

New custom instructions for chats in this project, or null to clear them

Response

Updated project

id
string<uuid>
required

Unique project identifier

name
string
required

Project name

description
string | null
required

Project description, or null if unset

custom_instructions
string | null
required

Custom instructions injected into chats opened in this project

is_access_controlled
boolean
required

When true, only the creator and explicitly granted users can see the project. When false, any member of the organization can see it.

my_access_level
enum<string> | null
required

Caller's access level on this project: admin (creator or explicitly granted admin), write, read, or null if the caller has no recorded grant. null is also returned for org-scoped keys, which carry no user identity.

Available options:
read,
write,
admin,
null
created_at
string
required

ISO 8601 creation timestamp

updated_at
string
required

ISO 8601 last-update timestamp