Import custom tools from an OpenAPI spec

curl --request POST \
  --url https://api.orbit.devotel.io/api/v1/agents/custom-tools/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spec": {},
  "dry_run": true,
  "base_url_override": "<string>",
  "default_timeout_ms": 30500,
  "enabled": true,
  "only": [
    "<string>"
  ]
}
'

import requests

url = "https://api.orbit.devotel.io/api/v1/agents/custom-tools/import"

payload = {
    "spec": {},
    "dry_run": True,
    "base_url_override": "<string>",
    "default_timeout_ms": 30500,
    "enabled": True,
    "only": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    spec: {},
    dry_run: true,
    base_url_override: '<string>',
    default_timeout_ms: 30500,
    enabled: true,
    only: ['<string>']
  })
};

fetch('https://api.orbit.devotel.io/api/v1/agents/custom-tools/import', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/agents/custom-tools/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'spec' => [
        
    ],
    'dry_run' => true,
    'base_url_override' => '<string>',
    'default_timeout_ms' => 30500,
    'enabled' => true,
    'only' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orbit.devotel.io/api/v1/agents/custom-tools/import"

	payload := strings.NewReader("{\n  \"spec\": {},\n  \"dry_run\": true,\n  \"base_url_override\": \"<string>\",\n  \"default_timeout_ms\": 30500,\n  \"enabled\": true,\n  \"only\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/agents/custom-tools/import")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"spec\": {},\n  \"dry_run\": true,\n  \"base_url_override\": \"<string>\",\n  \"default_timeout_ms\": 30500,\n  \"enabled\": true,\n  \"only\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/agents/custom-tools/import")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"spec\": {},\n  \"dry_run\": true,\n  \"base_url_override\": \"<string>\",\n  \"default_timeout_ms\": 30500,\n  \"enabled\": true,\n  \"only\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "dry_run": true,
    "spec_title": "Acme Orders API",
    "candidates": [
      {
        "name": "check_order_status",
        "description": "Look up an order's fulfilment status.",
        "importable": true,
        "status": "importable",
        "reason": null
      }
    ],
    "summary": {
      "total": 1,
      "importable": 1,
      "skipped": 0
    }
  },
  "meta": {
    "request_id": "req_01J9Z8ABCDEF",
    "timestamp": "2026-08-29T14:33:00.000Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "<string>",
    "status": 429,
    "retry_after": 2
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

Agents

Import custom tools from an OpenAPI spec

Bulk-convert an OpenAPI/Swagger document into custom tool candidates. With dry_run (default true) it parses the spec and returns per-candidate importability (importable, reserved_name, duplicate, invalid_url, schema_too_large) without persisting, so the candidates can be reviewed; a non-dry-run POST creates every importable candidate, optionally narrowed by the ‘only’ slug list, through the same SSRF and reserved-name checks as the single-register endpoint.

POST

api

agents

custom-tools

import

Import custom tools from an OpenAPI spec

curl --request POST \
  --url https://api.orbit.devotel.io/api/v1/agents/custom-tools/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spec": {},
  "dry_run": true,
  "base_url_override": "<string>",
  "default_timeout_ms": 30500,
  "enabled": true,
  "only": [
    "<string>"
  ]
}
'

import requests

url = "https://api.orbit.devotel.io/api/v1/agents/custom-tools/import"

payload = {
    "spec": {},
    "dry_run": True,
    "base_url_override": "<string>",
    "default_timeout_ms": 30500,
    "enabled": True,
    "only": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    spec: {},
    dry_run: true,
    base_url_override: '<string>',
    default_timeout_ms: 30500,
    enabled: true,
    only: ['<string>']
  })
};

fetch('https://api.orbit.devotel.io/api/v1/agents/custom-tools/import', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/agents/custom-tools/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'spec' => [
        
    ],
    'dry_run' => true,
    'base_url_override' => '<string>',
    'default_timeout_ms' => 30500,
    'enabled' => true,
    'only' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orbit.devotel.io/api/v1/agents/custom-tools/import"

	payload := strings.NewReader("{\n  \"spec\": {},\n  \"dry_run\": true,\n  \"base_url_override\": \"<string>\",\n  \"default_timeout_ms\": 30500,\n  \"enabled\": true,\n  \"only\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/agents/custom-tools/import")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"spec\": {},\n  \"dry_run\": true,\n  \"base_url_override\": \"<string>\",\n  \"default_timeout_ms\": 30500,\n  \"enabled\": true,\n  \"only\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/agents/custom-tools/import")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"spec\": {},\n  \"dry_run\": true,\n  \"base_url_override\": \"<string>\",\n  \"default_timeout_ms\": 30500,\n  \"enabled\": true,\n  \"only\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "dry_run": true,
    "spec_title": "Acme Orders API",
    "candidates": [
      {
        "name": "check_order_status",
        "description": "Look up an order's fulfilment status.",
        "importable": true,
        "status": "importable",
        "reason": null
      }
    ],
    "summary": {
      "total": 1,
      "importable": 1,
      "skipped": 0
    }
  },
  "meta": {
    "request_id": "req_01J9Z8ABCDEF",
    "timestamp": "2026-08-29T14:33:00.000Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "<string>",
    "status": 429,
    "retry_after": 2
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Dashboard JWT token from Clerk

Headers

Idempotency-Key

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255

X-Test-Mode

enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:

true,

false

Body

application/json

The OpenAPI document plus import options.

spec

required

Parsed document object or a raw JSON/YAML string.

dry_run

boolean

default:true

Preview candidates without persisting.

base_url_override

string<uri>

Maximum string length: 2000

default_timeout_ms

integer

Required range: 1000 <= x <= 60000

default_confirmation

enum<string>

Available options:

never,

always

enabled

boolean

default:true

only

string[]

Commit only these candidate slugs.

Response

The dry-run preview or the commit result.

data

object

candidates + summary on dry run; created + skipped on commit.

API Reference

All Endpoints

Import custom tools from an OpenAPI spec

Authorizations

Headers

Body

Response