Initiate a chunked upload

curl --request POST \
  --url https://app.gc.ai/api/external/v1/files/uploads \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file_name": "msa-2026.pdf",
  "size": 12582912,
  "content_type": "application/pdf",
  "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scope": "my-files"
}
'

import requests

url = "https://app.gc.ai/api/external/v1/files/uploads"

payload = {
    "file_name": "msa-2026.pdf",
    "size": 12582912,
    "content_type": "application/pdf",
    "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scope": "my-files"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    file_name: 'msa-2026.pdf',
    size: 12582912,
    content_type: 'application/pdf',
    folder_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    project_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    scope: 'my-files'
  })
};

fetch('https://app.gc.ai/api/external/v1/files/uploads', 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/files/uploads",
  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([
    'file_name' => 'msa-2026.pdf',
    'size' => 12582912,
    'content_type' => 'application/pdf',
    'folder_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'project_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'scope' => 'my-files'
  ]),
  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/files/uploads"

	payload := strings.NewReader("{\n  \"file_name\": \"msa-2026.pdf\",\n  \"size\": 12582912,\n  \"content_type\": \"application/pdf\",\n  \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scope\": \"my-files\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://app.gc.ai/api/external/v1/files/uploads")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"file_name\": \"msa-2026.pdf\",\n  \"size\": 12582912,\n  \"content_type\": \"application/pdf\",\n  \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scope\": \"my-files\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gc.ai/api/external/v1/files/uploads")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"file_name\": \"msa-2026.pdf\",\n  \"size\": 12582912,\n  \"content_type\": \"application/pdf\",\n  \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scope\": \"my-files\"\n}"

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

{
  "upload_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "part_size": 123,
  "max_parts": 123,
  "expires_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": {}
}

Files

Initiate a Chunked Upload

Start a multipart upload session for a large file. Validates the file type, size, and destination up front, then returns an upload_id. Send the file in parts with PUT /files/uploads/{upload_id}/parts/{part_number}, then finalize with POST /files/uploads/{upload_id}/complete.

Use this instead of POST /files when a single request is impractical (large files, or clients with per-request payload limits). The destination options (folder_id / project_id / scope) behave exactly as on POST /files.

POST

files

uploads

Initiate a chunked upload

curl --request POST \
  --url https://app.gc.ai/api/external/v1/files/uploads \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file_name": "msa-2026.pdf",
  "size": 12582912,
  "content_type": "application/pdf",
  "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scope": "my-files"
}
'

import requests

url = "https://app.gc.ai/api/external/v1/files/uploads"

payload = {
    "file_name": "msa-2026.pdf",
    "size": 12582912,
    "content_type": "application/pdf",
    "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scope": "my-files"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    file_name: 'msa-2026.pdf',
    size: 12582912,
    content_type: 'application/pdf',
    folder_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    project_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    scope: 'my-files'
  })
};

fetch('https://app.gc.ai/api/external/v1/files/uploads', 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/files/uploads",
  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([
    'file_name' => 'msa-2026.pdf',
    'size' => 12582912,
    'content_type' => 'application/pdf',
    'folder_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'project_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'scope' => 'my-files'
  ]),
  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/files/uploads"

	payload := strings.NewReader("{\n  \"file_name\": \"msa-2026.pdf\",\n  \"size\": 12582912,\n  \"content_type\": \"application/pdf\",\n  \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scope\": \"my-files\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://app.gc.ai/api/external/v1/files/uploads")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"file_name\": \"msa-2026.pdf\",\n  \"size\": 12582912,\n  \"content_type\": \"application/pdf\",\n  \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scope\": \"my-files\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gc.ai/api/external/v1/files/uploads")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"file_name\": \"msa-2026.pdf\",\n  \"size\": 12582912,\n  \"content_type\": \"application/pdf\",\n  \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scope\": \"my-files\"\n}"

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

{
  "upload_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "part_size": 123,
  "max_parts": 123,
  "expires_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.

Body

application/json

file_name

string

required

Original filename, including extension.

Required string length: 1 - 255

Example:

"msa-2026.pdf"

size

integer

required

Total size of the complete file in bytes. Validated up front against the file-size limit so oversized uploads fail before any parts are sent.

Required range: x > 0

Example:

12582912

content_type

string

MIME type of the file. When omitted, it is derived from the filename extension.

Example:

"application/pdf"

folder_id

string<uuid>

Target folder ID. Defaults to the user's "My Files" folder. Mutually exclusive with project_id and scope.

project_id

string<uuid>

Upload the file into a project. The file is placed in the project's upload folder and linked to the project. Mutually exclusive with folder_id and scope.

scope

enum<string>

Upload to the root of a meta-collection ("my-files" or "organization"). Mutually exclusive with folder_id and project_id. User-scoped keys only.

Available options:

my-files,

organization

Example:

"my-files"

Response

Upload session created

upload_id

string<uuid>

required

Opaque identifier for this upload session. Use it in the part and complete requests.

part_size

number

required

Recommended part size in bytes. Split the file into parts no larger than this for reliable transfers.

max_parts

number

required

Maximum number of parts allowed for this session. Part numbers run from 1 to this value.

expires_at

string

required

ISO 8601 timestamp after which the session expires. Upload all parts and call complete before this.

Get File Status Search Files

⌘I

Concepts

Examples

Chat

Files

Folders

Playbooks

Profiles

Projects

Skills

Usage

Utility

Initiate a Chunked Upload

Authorizations

Body

Response