Skip to main content
GET
/
v2
/
tools
List tools
curl --request GET \
  --url https://api.orq.ai/v2/tools \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "_id": "01K8VCCV9C4VSNYZH5MHGRMCWM",
      "path": "Default",
      "key": "<string>",
      "display_name": "<string>",
      "description": "<string>",
      "created_by_id": "<string>",
      "updated_by_id": "<string>",
      "project_id": "<string>",
      "workspace_id": "<string>",
      "created": "<string>",
      "updated": "<string>",
      "status": "live",
      "version_hash": "<string>",
      "type": "function",
      "function": {
        "name": "<string>",
        "description": "<string>",
        "strict": true,
        "parameters": {}
      }
    }
  ],
  "has_more": true
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
number

Maximum number of tools per page (1-200). Omit to return all tools.

Required range: 1 <= x <= 200
​
starting_after
string

A 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.

​
ending_before
string

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.

​
object
enum<string>
required
Available options:
list
​
data
object[]
required
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
​
has_more
boolean
required