Upload a file

Streams one file in: the raw file is the request body (its Content-Type and Content-Length), and what it is goes in the query. A daemon names run_id and phase; a person answering a Hug names hug_id and requested_input — the file must suit that input (its accepted types, by declared type, extension and leading bytes; its size) and is kept until it is part of an answer. Files are limited to 50 MB unless the deployment says otherwise. Answers 201.

With hug_id (query string) in the body: Requires a realm member (or higher) with the runs.view permission on the realm that owns the hug given by hug_id (query string). Addressed to the caller; open; a file input. Without it: Daemon push: requires the daemon’s realm token (cliq_dt_…) for the realm that owns the run given by run_id (query string).

POST

artifacts

upload

Upload a file

curl --request POST \
  --url https://{host}/v1/artifacts/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://{host}/v1/artifacts/upload"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://{host}/v1/artifacts/upload', 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://{host}/v1/artifacts/upload",
  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([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://{host}/v1/artifacts/upload"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://{host}/v1/artifacts/upload")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/v1/artifacts/upload")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "ok": true,
  "data": {
    "artifact_id": "8f7e6d5c-4b3a-4291-8e7f-6a5b4c3d2e1f",
    "name": "MSA.pdf",
    "size": 48213,
    "content_type": "application/pdf",
    "sha256": "9f2b5c…",
    "status": "pending",
    "download_url": "https://cliqhub.io/v1/artifacts/download?artifact_id=8f7e6d5c-4b3a-4291-8e7f-6a5b4c3d2e1f"
  }
}

{
  "ok": false,
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "ok": false,
  "error": {
    "code": "forbidden",
    "message": "You do not have access to do this"
  }
}

{
  "ok": false,
  "error": {
    "code": "not_found",
    "message": "Not found"
  }
}

{
  "ok": false,
  "error": "Content-Length is required",
  "code": "ARTIFACT_LENGTH_REQUIRED"
}

{
  "ok": false,
  "error": "File is larger than the 50 MB limit",
  "code": "ARTIFACT_TOO_LARGE"
}

{
  "ok": false,
  "error": "contract: photo.png is not an accepted type (application/pdf)",
  "code": "HUG_FILE_INVALID"
}

{
  "ok": false,
  "error": "Internal server error",
  "code": "internal_error"
}

{
  "ok": false,
  "error": "File storage is not configured",
  "code": "ARTIFACT_STORAGE_UNAVAILABLE"
}

Authorizations

Authorization

string

header

required

User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).

Query Parameters

run_id

string

The run (daemon uploads, with phase).

phase

string

The phase that produced it (daemon uploads).

hug_id

string

The Hug whose file input this answers (with requested_input).

requested_input

string

The Hug's file input.

name

string

required

File name.

description

string

Shown with the file.

Body

application/json

The request body is not documented yet.

Response

Created.

enum<boolean>

required

Always true on success.

Available options:

true

data

object

required

Show child attributes

Upload a file

curl --request POST \
  --url https://{host}/v1/artifacts/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://{host}/v1/artifacts/upload"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://{host}/v1/artifacts/upload', 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://{host}/v1/artifacts/upload",
  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([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://{host}/v1/artifacts/upload"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://{host}/v1/artifacts/upload")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/v1/artifacts/upload")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "ok": true,
  "data": {
    "artifact_id": "8f7e6d5c-4b3a-4291-8e7f-6a5b4c3d2e1f",
    "name": "MSA.pdf",
    "size": 48213,
    "content_type": "application/pdf",
    "sha256": "9f2b5c…",
    "status": "pending",
    "download_url": "https://cliqhub.io/v1/artifacts/download?artifact_id=8f7e6d5c-4b3a-4291-8e7f-6a5b4c3d2e1f"
  }
}

{
  "ok": false,
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "ok": false,
  "error": {
    "code": "forbidden",
    "message": "You do not have access to do this"
  }
}

{
  "ok": false,
  "error": {
    "code": "not_found",
    "message": "Not found"
  }
}

{
  "ok": false,
  "error": "Content-Length is required",
  "code": "ARTIFACT_LENGTH_REQUIRED"
}

{
  "ok": false,
  "error": "File is larger than the 50 MB limit",
  "code": "ARTIFACT_TOO_LARGE"
}

{
  "ok": false,
  "error": "contract: photo.png is not an accepted type (application/pdf)",
  "code": "HUG_FILE_INVALID"
}

{
  "ok": false,
  "error": "Internal server error",
  "code": "internal_error"
}

{
  "ok": false,
  "error": "File storage is not configured",
  "code": "ARTIFACT_STORAGE_UNAVAILABLE"
}

Introduction

System

Auth

Users

Organizations

Invitations

Teams

Realms

Daemons

Workspaces

Runs

Artifacts

Events

Notification channels

Notifications

Agents

Settings

Mesh

Jira

A2A

Hugs

Upload a file

Authorizations

Query Parameters

Body

Response