Skip to main content
POST
/
api
/
v1
/
projects
POST projects instances
curl --request POST \
  --url https://app.onecodex.com/api/v1/projects \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "description": "<string>",
  "name": "<string>",
  "project_name": "<string>"
}
'
import requests

url = "https://app.onecodex.com/api/v1/projects"

payload = {
    "description": "<string>",
    "name": "<string>",
    "project_name": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({description: '<string>', name: '<string>', project_name: '<string>'})
};

fetch('https://app.onecodex.com/api/v1/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://app.onecodex.com/api/v1/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([
    'description' => '<string>',
    'name' => '<string>',
    'project_name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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.onecodex.com/api/v1/projects"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"project_name\": \"<string>\"\n}")

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

	req.Header.Add("X-API-Key", "<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.onecodex.com/api/v1/projects")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"project_name\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.onecodex.com/api/v1/projects")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"project_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "$uri": "/api/v1/projects/0d77065796f8d173",
  "owner": {
    "__DOLLAR_REF__": "/api/v1/users/a1b2c3d4e5f67890"
  },
  "permissions": [
    "<string>"
  ],
  "project_name": "<string>",
  "description": "<string>",
  "external_id": "PRJ-2024-001",
  "name": "<string>",
  "public": false
}
Create a new Project owned by the authenticated user. The project_name must be unique within the user’s organization and match the pattern ^[a-zA-Z0-9_-]{3,15}$.

Authorizations

X-API-Key
string
header
required

Body

application/json
description
string | null
name
string | null
project_name
string | null

Response

200 - application/json

OK

$uri
string
required
read-only
Pattern: ^/api/v1/projects/[a-f0-9]{16}$
Example:

"/api/v1/projects/0d77065796f8d173"

owner
users · object
required
permissions
string[]
required
project_name
string | null
required
Required string length: 3 - 15
Pattern: ^[a-zA-Z0-9_-]{3,15}$
description
string | null
external_id
string | null
Example:

"PRJ-2024-001"

name
string | null
public
boolean
default:false