Create a project

curl --request POST \
  --url https://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "project_creator": "jsmith@example.com"
}
'

import requests

url = "https://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects"

payload = {
    "name": "<string>",
    "description": "<string>",
    "project_creator": "jsmith@example.com"
}
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({
    name: '<string>',
    description: '<string>',
    project_creator: 'jsmith@example.com'
  })
};

fetch('https://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects', 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://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects",
  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' => '<string>',
    'description' => '<string>',
    'project_creator' => 'jsmith@example.com'
  ]),
  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://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"project_creator\": \"jsmith@example.com\"\n}")

	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://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"project_creator\": \"jsmith@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects")

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 = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"project_creator\": \"jsmith@example.com\"\n}"

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

{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Projects

Create a project

Create a project in a workspace. The parent workspace is identified by the workspace_id path parameter alone; the x-hh-workspace-id header does not participate.

The optional project_creator field names the user (by email) who receives the project-creator membership on the new project. The named user must already be a member of the workspace. When omitted, the project is created without any membership. The field is only accepted on API-key-initiated requests. User-initiated creation always makes the calling user the creator, so sending the field returns a 400.

The roles that membership carries come from your organization’s role configuration. An organization that grants no role on project creation is a supported case: the request still succeeds and the named user receives no access. A 200 response is not by itself confirmation that the named user was granted anything.

A project_creator who is already signed in does not see the new project immediately. A session captures its scope tree and permission grants when it is created, so a membership granted afterwards is not reflected in it. Creating the project marks that user’s sessions for refresh, and the refresh takes effect on their next request to the control plane, so an idle browser tab may need a page reload.

POST

workspaces

{workspace_id}

projects

Create a project

curl --request POST \
  --url https://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "project_creator": "jsmith@example.com"
}
'

import requests

url = "https://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects"

payload = {
    "name": "<string>",
    "description": "<string>",
    "project_creator": "jsmith@example.com"
}
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({
    name: '<string>',
    description: '<string>',
    project_creator: 'jsmith@example.com'
  })
};

fetch('https://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects', 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://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects",
  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' => '<string>',
    'description' => '<string>',
    'project_creator' => 'jsmith@example.com'
  ]),
  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://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"project_creator\": \"jsmith@example.com\"\n}")

	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://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"project_creator\": \"jsmith@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cp.us.honeyhive.ai/v1/workspaces/{workspace_id}/projects")

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 = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"project_creator\": \"jsmith@example.com\"\n}"

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

{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace_id

string

required

The unique identifier of the workspace the project is created in

Body

application/json

Request body for creating a project

name

string

required

Project display name

Minimum string length: 1

description

string

Project description

project_creator

string<email>

Email of the user to grant the project-creator membership to (API key actors only). A signed-in user does not see the new project until their session refreshes, which happens on their next request to the control plane.

Response

Project created successfully

The created project

success

boolean

required

data

object

required

Project object

Show child attributes

⌘I

Data Plane API

Control Plane API

Create a project

Authorizations

Path Parameters

Body

Response