Create Procedure

curl --request POST \
  --url https://api.proced.ai/procedures \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "categoryId": "cm2uqwcpd002s7xta3b1j8q3p",
  "doerId": "cm2uj5ffn001x7xtag73jmpx0",
  "name": "New Procedure Title",
  "projectId": "cm2uj5ffn001x7xtag73jmpx0",
  "priority": "MEDIUM",
  "state": "TODO",
  "dueAt": "2024-09-22T22:00:00.000Z",
  "content": "Procedure content goes here.",
  "generateProcedure": true,
  "contentType": "standard",
  "docStyle": "simplified",
  "language": "typescript"
}
'

import requests

url = "https://api.proced.ai/procedures"

payload = {
    "categoryId": "cm2uqwcpd002s7xta3b1j8q3p",
    "doerId": "cm2uj5ffn001x7xtag73jmpx0",
    "name": "New Procedure Title",
    "projectId": "cm2uj5ffn001x7xtag73jmpx0",
    "priority": "MEDIUM",
    "state": "TODO",
    "dueAt": "2024-09-22T22:00:00.000Z",
    "content": "Procedure content goes here.",
    "generateProcedure": True,
    "contentType": "standard",
    "docStyle": "simplified",
    "language": "typescript"
}
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({
    categoryId: 'cm2uqwcpd002s7xta3b1j8q3p',
    doerId: 'cm2uj5ffn001x7xtag73jmpx0',
    name: 'New Procedure Title',
    projectId: 'cm2uj5ffn001x7xtag73jmpx0',
    priority: 'MEDIUM',
    state: 'TODO',
    dueAt: '2024-09-22T22:00:00.000Z',
    content: 'Procedure content goes here.',
    generateProcedure: true,
    contentType: 'standard',
    docStyle: 'simplified',
    language: 'typescript'
  })
};

fetch('https://api.proced.ai/procedures', 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.proced.ai/procedures",
  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([
    'categoryId' => 'cm2uqwcpd002s7xta3b1j8q3p',
    'doerId' => 'cm2uj5ffn001x7xtag73jmpx0',
    'name' => 'New Procedure Title',
    'projectId' => 'cm2uj5ffn001x7xtag73jmpx0',
    'priority' => 'MEDIUM',
    'state' => 'TODO',
    'dueAt' => '2024-09-22T22:00:00.000Z',
    'content' => 'Procedure content goes here.',
    'generateProcedure' => true,
    'contentType' => 'standard',
    'docStyle' => 'simplified',
    'language' => 'typescript'
  ]),
  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.proced.ai/procedures"

	payload := strings.NewReader("{\n  \"categoryId\": \"cm2uqwcpd002s7xta3b1j8q3p\",\n  \"doerId\": \"cm2uj5ffn001x7xtag73jmpx0\",\n  \"name\": \"New Procedure Title\",\n  \"projectId\": \"cm2uj5ffn001x7xtag73jmpx0\",\n  \"priority\": \"MEDIUM\",\n  \"state\": \"TODO\",\n  \"dueAt\": \"2024-09-22T22:00:00.000Z\",\n  \"content\": \"Procedure content goes here.\",\n  \"generateProcedure\": true,\n  \"contentType\": \"standard\",\n  \"docStyle\": \"simplified\",\n  \"language\": \"typescript\"\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.proced.ai/procedures")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"categoryId\": \"cm2uqwcpd002s7xta3b1j8q3p\",\n  \"doerId\": \"cm2uj5ffn001x7xtag73jmpx0\",\n  \"name\": \"New Procedure Title\",\n  \"projectId\": \"cm2uj5ffn001x7xtag73jmpx0\",\n  \"priority\": \"MEDIUM\",\n  \"state\": \"TODO\",\n  \"dueAt\": \"2024-09-22T22:00:00.000Z\",\n  \"content\": \"Procedure content goes here.\",\n  \"generateProcedure\": true,\n  \"contentType\": \"standard\",\n  \"docStyle\": \"simplified\",\n  \"language\": \"typescript\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.proced.ai/procedures")

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  \"categoryId\": \"cm2uqwcpd002s7xta3b1j8q3p\",\n  \"doerId\": \"cm2uj5ffn001x7xtag73jmpx0\",\n  \"name\": \"New Procedure Title\",\n  \"projectId\": \"cm2uj5ffn001x7xtag73jmpx0\",\n  \"priority\": \"MEDIUM\",\n  \"state\": \"TODO\",\n  \"dueAt\": \"2024-09-22T22:00:00.000Z\",\n  \"content\": \"Procedure content goes here.\",\n  \"generateProcedure\": true,\n  \"contentType\": \"standard\",\n  \"docStyle\": \"simplified\",\n  \"language\": \"typescript\"\n}"

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

{
  "id": "cm0upgshc000rwf5eop1u2awr",
  "name": "Proced AI title",
  "priority": "MEDIUM",
  "state": "TODO",
  "creatorId": "cm2uj5ffn001x7xtag73jmpx0",
  "position": 1,
  "dueAt": "2024-09-22T22:00:00.000Z",
  "createdAt": "2024-09-22T22:00:00.000Z",
  "updatedAt": "2024-09-22T22:00:00.000Z",
  "projectId": "cm2uj5ffn001x7xtag73jmpx0",
  "workspaceId": "cm2uj5ffn001x7xtag73jmpx0",
  "displayVideo": true,
  "isFineTunedData": false,
  "shortId": "cm0upgshc000rwf5eop1u2awr",
  "content": "Procedure content goes here.",
  "categoryId": "cm2uqwcpd002s7xta3b1j8q3p",
  "doerId": "cm2uj5ffn001x7xtag73jmpx0",
  "captureId": "cm2uqwcpd002s7xta3b1j8q3p",
  "category": {
    "id": "<string>",
    "name": "<string>"
  },
  "doer": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>"
  },
  "project": {
    "id": "<string>",
    "name": "<string>"
  },
  "comments": [
    {
      "id": "<string>",
      "text": "<string>",
      "createdAt": "<string>"
    }
  ]
}

{
  "code": "disconnected",
  "message": "The login details of this item have changed (credentials, MFA, or required user action) and a user login is required to update this information.",
  "requestId": "123e4567-e89b-12d3-a456-426655440000"
}

POST

procedures

Create Procedure

curl --request POST \
  --url https://api.proced.ai/procedures \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "categoryId": "cm2uqwcpd002s7xta3b1j8q3p",
  "doerId": "cm2uj5ffn001x7xtag73jmpx0",
  "name": "New Procedure Title",
  "projectId": "cm2uj5ffn001x7xtag73jmpx0",
  "priority": "MEDIUM",
  "state": "TODO",
  "dueAt": "2024-09-22T22:00:00.000Z",
  "content": "Procedure content goes here.",
  "generateProcedure": true,
  "contentType": "standard",
  "docStyle": "simplified",
  "language": "typescript"
}
'

import requests

url = "https://api.proced.ai/procedures"

payload = {
    "categoryId": "cm2uqwcpd002s7xta3b1j8q3p",
    "doerId": "cm2uj5ffn001x7xtag73jmpx0",
    "name": "New Procedure Title",
    "projectId": "cm2uj5ffn001x7xtag73jmpx0",
    "priority": "MEDIUM",
    "state": "TODO",
    "dueAt": "2024-09-22T22:00:00.000Z",
    "content": "Procedure content goes here.",
    "generateProcedure": True,
    "contentType": "standard",
    "docStyle": "simplified",
    "language": "typescript"
}
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({
    categoryId: 'cm2uqwcpd002s7xta3b1j8q3p',
    doerId: 'cm2uj5ffn001x7xtag73jmpx0',
    name: 'New Procedure Title',
    projectId: 'cm2uj5ffn001x7xtag73jmpx0',
    priority: 'MEDIUM',
    state: 'TODO',
    dueAt: '2024-09-22T22:00:00.000Z',
    content: 'Procedure content goes here.',
    generateProcedure: true,
    contentType: 'standard',
    docStyle: 'simplified',
    language: 'typescript'
  })
};

fetch('https://api.proced.ai/procedures', 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.proced.ai/procedures",
  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([
    'categoryId' => 'cm2uqwcpd002s7xta3b1j8q3p',
    'doerId' => 'cm2uj5ffn001x7xtag73jmpx0',
    'name' => 'New Procedure Title',
    'projectId' => 'cm2uj5ffn001x7xtag73jmpx0',
    'priority' => 'MEDIUM',
    'state' => 'TODO',
    'dueAt' => '2024-09-22T22:00:00.000Z',
    'content' => 'Procedure content goes here.',
    'generateProcedure' => true,
    'contentType' => 'standard',
    'docStyle' => 'simplified',
    'language' => 'typescript'
  ]),
  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.proced.ai/procedures"

	payload := strings.NewReader("{\n  \"categoryId\": \"cm2uqwcpd002s7xta3b1j8q3p\",\n  \"doerId\": \"cm2uj5ffn001x7xtag73jmpx0\",\n  \"name\": \"New Procedure Title\",\n  \"projectId\": \"cm2uj5ffn001x7xtag73jmpx0\",\n  \"priority\": \"MEDIUM\",\n  \"state\": \"TODO\",\n  \"dueAt\": \"2024-09-22T22:00:00.000Z\",\n  \"content\": \"Procedure content goes here.\",\n  \"generateProcedure\": true,\n  \"contentType\": \"standard\",\n  \"docStyle\": \"simplified\",\n  \"language\": \"typescript\"\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.proced.ai/procedures")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"categoryId\": \"cm2uqwcpd002s7xta3b1j8q3p\",\n  \"doerId\": \"cm2uj5ffn001x7xtag73jmpx0\",\n  \"name\": \"New Procedure Title\",\n  \"projectId\": \"cm2uj5ffn001x7xtag73jmpx0\",\n  \"priority\": \"MEDIUM\",\n  \"state\": \"TODO\",\n  \"dueAt\": \"2024-09-22T22:00:00.000Z\",\n  \"content\": \"Procedure content goes here.\",\n  \"generateProcedure\": true,\n  \"contentType\": \"standard\",\n  \"docStyle\": \"simplified\",\n  \"language\": \"typescript\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.proced.ai/procedures")

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  \"categoryId\": \"cm2uqwcpd002s7xta3b1j8q3p\",\n  \"doerId\": \"cm2uj5ffn001x7xtag73jmpx0\",\n  \"name\": \"New Procedure Title\",\n  \"projectId\": \"cm2uj5ffn001x7xtag73jmpx0\",\n  \"priority\": \"MEDIUM\",\n  \"state\": \"TODO\",\n  \"dueAt\": \"2024-09-22T22:00:00.000Z\",\n  \"content\": \"Procedure content goes here.\",\n  \"generateProcedure\": true,\n  \"contentType\": \"standard\",\n  \"docStyle\": \"simplified\",\n  \"language\": \"typescript\"\n}"

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

{
  "id": "cm0upgshc000rwf5eop1u2awr",
  "name": "Proced AI title",
  "priority": "MEDIUM",
  "state": "TODO",
  "creatorId": "cm2uj5ffn001x7xtag73jmpx0",
  "position": 1,
  "dueAt": "2024-09-22T22:00:00.000Z",
  "createdAt": "2024-09-22T22:00:00.000Z",
  "updatedAt": "2024-09-22T22:00:00.000Z",
  "projectId": "cm2uj5ffn001x7xtag73jmpx0",
  "workspaceId": "cm2uj5ffn001x7xtag73jmpx0",
  "displayVideo": true,
  "isFineTunedData": false,
  "shortId": "cm0upgshc000rwf5eop1u2awr",
  "content": "Procedure content goes here.",
  "categoryId": "cm2uqwcpd002s7xta3b1j8q3p",
  "doerId": "cm2uj5ffn001x7xtag73jmpx0",
  "captureId": "cm2uqwcpd002s7xta3b1j8q3p",
  "category": {
    "id": "<string>",
    "name": "<string>"
  },
  "doer": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>"
  },
  "project": {
    "id": "<string>",
    "name": "<string>"
  },
  "comments": [
    {
      "id": "<string>",
      "text": "<string>",
      "createdAt": "<string>"
    }
  ]
}

{
  "code": "disconnected",
  "message": "The login details of this item have changed (credentials, MFA, or required user action) and a user login is required to update this information.",
  "requestId": "123e4567-e89b-12d3-a456-426655440000"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

categoryId

string

required

Example:

"cm2uqwcpd002s7xta3b1j8q3p"

doerId

string

required

Responsable ID

Example:

"cm2uj5ffn001x7xtag73jmpx0"

name

string

required

Example:

"New Procedure Title"

projectId

string

required

Example:

"cm2uj5ffn001x7xtag73jmpx0"

priority

enum<string>

required

Available options:

LOW,

MEDIUM,

HIGH

Example:

"MEDIUM"

state

enum<string>

required

Available options:

TODO,

IN_PROGRESS,

COMPLETED,

WAITING

Example:

"TODO"

dueAt

required

Example:

"2024-09-22T22:00:00.000Z"

content

string · null · null

Example:

"Procedure content goes here."

generateProcedure

boolean

generate procedure by content with ai

Example:

true

contentType

enum<string>

Content type becomes important when generateProcedure is true

Available options:

code,

standard,

api,

process

Example:

"standard"

docStyle

enum<string>

Documentation style becomes important when generateProcedure is true

Available options:

technical,

simplified,

detailed

Example:

"simplified"

language

enum<string>

Language becomes important when generateProcedure is true, especially for code documentation

Available options:

typescript,

javascript,

python,

java,

csharp,

other

Example:

"typescript"

Response

Create procedure

string

required

Example:

"cm0upgshc000rwf5eop1u2awr"

name

string

required

Example:

"Proced AI title"

priority

enum<string>

required

Available options:

LOW,

MEDIUM,

HIGH

Example:

"MEDIUM"

state

enum<string>

required

Available options:

TODO,

IN_PROGRESS,

COMPLETED,

WAITING

Example:

"TODO"

creatorId

string

required

Example:

"cm2uj5ffn001x7xtag73jmpx0"

position

number

required

Example:

1

dueAt

string

required

Example:

"2024-09-22T22:00:00.000Z"

createdAt

string

required

Example:

"2024-09-22T22:00:00.000Z"

updatedAt

string

required

Example:

"2024-09-22T22:00:00.000Z"

projectId

string

required

Example:

"cm2uj5ffn001x7xtag73jmpx0"

workspaceId

string

required

Example:

"cm2uj5ffn001x7xtag73jmpx0"

displayVideo

boolean

required

Example:

true

isFineTunedData

boolean

required

Example:

false

shortId

string | null

Example:

"cm0upgshc000rwf5eop1u2awr"

content

string | null

Example:

"Procedure content goes here."

categoryId

string | null

Example:

"cm2uqwcpd002s7xta3b1j8q3p"

doerId

string | null

Example:

"cm2uj5ffn001x7xtag73jmpx0"

captureId

string | null

Example:

"cm2uqwcpd002s7xta3b1j8q3p"

Procedures

Projects

Categories

Members

Create Procedure

Authorizations

Body

Response