Models
Create a new model
Get Started
Architecture
Documents
Copilot
Collaborate
Integrations
API Reference
- Introduction
- Models
- Models/Parts
- Models/Ports
- Models/Actions
- Models/States
- Models/Transitions
- Models/Signals
- Models/Interfaces
- Models/Requirements
- OpenAPI Specification
Models
Create a new model
Creates a new model with the current user as the owner
POST
/
api
/
models
curl --request POST \
--url http://localhost:3000/api/models \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>"
}'
{
"id": "<string>",
"user_id": "<string>",
"name": "<string>",
"access_control_list": [
{
"user_id": "<string>",
"group_id": "<string>",
"invite_id": "<string>",
"email": "jsmith@example.com",
"roles": [
{
"name": "<string>",
"permissions": [
{
"action": "View",
"scopes": [
"<string>"
]
}
]
}
]
}
],
"created_at": "2023-11-07T05:31:56Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
Model created successfully
The response is of type object
.
curl --request POST \
--url http://localhost:3000/api/models \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>"
}'
{
"id": "<string>",
"user_id": "<string>",
"name": "<string>",
"access_control_list": [
{
"user_id": "<string>",
"group_id": "<string>",
"invite_id": "<string>",
"email": "jsmith@example.com",
"roles": [
{
"name": "<string>",
"permissions": [
{
"action": "View",
"scopes": [
"<string>"
]
}
]
}
]
}
],
"created_at": "2023-11-07T05:31:56Z"
}