Platform APIs
Gateway APIs
curl --request GET \
--url https://api.orq.ai/v2/tools \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"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_01KBYRE1V3CDCBQ6A1ZFM02ZJJ",
"display_name": "<string>",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"status": "live",
"version_hash": "<string>"
}
],
"has_more": true
}List tools
Lists all workspace tools. By default, returns all tools in a single response. Set limit to enable cursor-based pagination with starting_after and ending_before.
curl --request GET \
--url https://api.orq.ai/v2/tools \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"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_01KBYRE1V3CDCBQ6A1ZFM02ZJJ",
"display_name": "<string>",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"status": "live",
"version_hash": "<string>"
}
],
"has_more": true
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Maximum number of tools per page (1-200). Omit to return all tools.
1 <= x <= 200A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include after=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the next page of the list.
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include before=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the previous page of the list.
Response
Successfully retrieved the list of tools.
list A custom function tool that allows the model to call predefined functions with structured parameters.
- Function Tool
- JSON Schema Tool
- HTTP Tool
- MCP Tool
- Code Execution Tool
Show child attributes
Show child attributes
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.
"Default"
Unique key of the tool as it will be displayed in the UI
1 - 64A 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.
function Show child attributes
Show child attributes
The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
A description of what the function does, used by the model to choose when and how to call the function.
Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Currently only compatible with OpenAI models.
The parameters the functions accepts, described as a JSON Schema object. See the OpenAI guide for examples, and the JSON Schema reference for documentation about the format.
Show child attributes
Show child attributes
The type must be "object"
object Array of required parameter names
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.
The id of the user that created the tool
The id of the user that last updated the tool
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.
live, draft, pending, published Was this page helpful?