Skip to main content
POST
/
orchestration
/
tools
Create tool
curl --request POST \
  --url https://api.getcargo.io/v1/orchestration/tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "icon": {
    "kind": "<string>",
    "data": "<string>"
  },
  "description": "<string>",
  "folderUuid": "<string>"
}
'
{
  "tool": {
    "uuid": "<string>",
    "icon": {
      "kind": "<string>",
      "data": "<string>"
    },
    "workspaceUuid": "<string>",
    "workflowUuid": "<string>",
    "userUuid": "<string>",
    "name": "<string>",
    "folderUuid": "<string>",
    "creditsCost": {
      "kind": "<string>"
    },
    "description": "<string>",
    "isReadOnly": true,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Request body schema.

name
string
required

Tool name.

icon
Icon · object
required

Tool icon.

description
string

Tool description.

folderUuid
string

Folder identifier.

Response

Successful response

tool
Tool · object
required

Created tool details.