Skip to main content
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"
}
'
{
  "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>"
    }
  ]
}

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

​
id
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"

​
category
object
​
doer
object
​
project
object
​
comments
object[] | null