Get Project Details

curl --request GET \
  --url https://cloud.onyx.app/api/user/projects/{project_id}/details \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://cloud.onyx.app/api/user/projects/{project_id}/details"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://cloud.onyx.app/api/user/projects/{project_id}/details', 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://cloud.onyx.app/api/user/projects/{project_id}/details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://cloud.onyx.app/api/user/projects/{project_id}/details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://cloud.onyx.app/api/user/projects/{project_id}/details")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "project": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "chat_sessions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "time_created": "<string>",
        "time_updated": "<string>",
        "shared_status": "public",
        "persona_id": 123,
        "current_alternate_model": "<string>",
        "current_temperature_override": 123
      }
    ],
    "instructions": "<string>"
  },
  "files": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "file_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "status": "PROCESSING",
      "last_accessed_at": "2023-11-07T05:31:56Z",
      "file_type": "<string>",
      "chat_file_type": "image",
      "token_count": 123,
      "chunk_count": 123,
      "temp_id": "<string>",
      "project_id": 123
    }
  ],
  "persona_id_to_is_default": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

user

projects

{project_id}

details

Get Project Details

curl --request GET \
  --url https://cloud.onyx.app/api/user/projects/{project_id}/details \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://cloud.onyx.app/api/user/projects/{project_id}/details"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://cloud.onyx.app/api/user/projects/{project_id}/details', 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://cloud.onyx.app/api/user/projects/{project_id}/details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://cloud.onyx.app/api/user/projects/{project_id}/details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://cloud.onyx.app/api/user/projects/{project_id}/details")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "project": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "chat_sessions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "time_created": "<string>",
        "time_updated": "<string>",
        "shared_status": "public",
        "persona_id": 123,
        "current_alternate_model": "<string>",
        "current_temperature_override": 123
      }
    ],
    "instructions": "<string>"
  },
  "files": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "file_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "status": "PROCESSING",
      "last_accessed_at": "2023-11-07T05:31:56Z",
      "file_type": "<string>",
      "chat_file_type": "image",
      "token_count": 123,
      "chunk_count": 123,
      "temp_id": "<string>",
      "project_id": 123
    }
  ],
  "persona_id_to_is_default": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Required permission: Basic access (basic) — any signed-in user or service account. You only see and change your own projects and files.

Authorizations

Authorization

string

header

required

Authorization header with Bearer token

Path Parameters

project_id

integer

required

Response

Successful Response

project

UserProjectSnapshot · object

required

Show child attributes

files

UserFileSnapshot · object[] | null

Show child attributes

persona_id_to_is_default

Persona Id To Is Default · object | null

Show child attributes

Getting Started

Guides & Examples

API Reference

Miscellaneous

Get Project Details

Authorizations

Path Parameters

Response