Skip to main content
POST
/
admin
/
tool
/
custom
Create Custom Tool
curl --request POST \
  --url https://cloud.onyx.app/api/admin/tool/custom \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "definition": {},
  "custom_headers": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "passthrough_auth": true
}'
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "definition": {},
  "display_name": "<string>",
  "in_code_tool_id": "<string>",
  "custom_headers": [
    "<any>"
  ],
  "passthrough_auth": true
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
definition
object
required
passthrough_auth
boolean
required
description
string | null
custom_headers
Header · object[] | null

Response

Successful Response

id
integer
name
string
description
string
definition
object | null
display_name
string
in_code_tool_id
string | null
custom_headers
any[] | null
passthrough_auth
boolean
I