Skip to main content
POST
/
v2
/
tools
Create tool
curl --request POST \
  --url https://api.orq.ai/v2/tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "Default",
  "key": "<string>",
  "description": "<string>",
  "type": "function",
  "function": {
    "name": "<string>",
    "description": "<string>",
    "strict": true
  },
  "display_name": "<string>",
  "status": "live"
}
'
{
  "path": "Default",
  "key": "<string>",
  "description": "<string>",
  "project_id": "<string>",
  "workspace_id": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "type": "function",
  "function": {
    "name": "<string>",
    "description": "<string>",
    "strict": true,
    "parameters": {
      "type": "object",
      "properties": {},
      "required": [
        "<string>"
      ]
    }
  },
  "_id": "tool_01KPTAPD6TT1SFJDTZX7BACJDP",
  "display_name": "<string>",
  "created_by_id": "<string>",
  "updated_by_id": "<string>",
  "status": "live"
}

Documentation Index

Fetch the complete documentation index at: https://docs.orq.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json

The tool to create

A custom function tool that allows the model to call predefined functions with structured parameters.

​
path
string
required

Entity storage path in the format: project/folder/subfolder/...

The first element identifies the project, followed by nested folders (auto-created as needed).

With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.

Example:

"Default"

​
key
string
required

Unique key of the tool as it will be displayed in the UI

Required string length: 1 - 64
Pattern: ^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$
​
description
string
required

A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the description field as accurate as possible to give enough context to the model to make the right decision.

​
type
enum<string>
required
Available options:
function
​
function
object
required
​
display_name
string

The name of the tool as it will be displayed in the UI. This is optional and if not provided, the key will be used.

​
status
enum<string>
default:live

The status of the tool. Live is the latest version of the tool. Draft is a version that is not yet published. Pending is a version that is pending approval. Published is a version that was live and has been replaced by a new version.

Available options:
live,
draft,
pending,
published

Response

200 - application/json

Successfully created the tool.

A custom function tool that allows the model to call predefined functions with structured parameters.

​
path
string
required

Entity storage path in the format: project/folder/subfolder/...

The first element identifies the project, followed by nested folders (auto-created as needed).

With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.

Example:

"Default"

​
key
string
required

Unique key of the tool as it will be displayed in the UI

Required string length: 1 - 64
Pattern: ^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$
​
description
string
required

A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the description field as accurate as possible to give enough context to the model to make the right decision.

​
project_id
string
required
​
workspace_id
string
required
​
created
string
required
​
updated
string
required
​
type
enum<string>
required
Available options:
function
​
function
object
required
​
_id
string
default:tool_01KPTAPD6TT1SFJDTZX7BACJDP
​
display_name
string

The name of the tool as it will be displayed in the UI. This is optional and if not provided, the key will be used.

​
created_by_id
string

The id of the user that created the tool

​
updated_by_id
string

The id of the user that last updated the tool

​
status
enum<string>
default:live

The status of the tool. Live is the latest version of the tool. Draft is a version that is not yet published. Pending is a version that is pending approval. Published is a version that was live and has been replaced by a new version.

Available options:
live,
draft,
pending,
published