Add a custom endpoint

curl --request POST \
  --url https://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_key": "<string>",
  "base_url": "<string>",
  "display_name": "<string>",
  "manual_models": [
    "<string>"
  ]
}
'

import requests

url = "https://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints"

payload = {
    "api_key": "<string>",
    "base_url": "<string>",
    "display_name": "<string>",
    "manual_models": ["<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({
    api_key: '<string>',
    base_url: '<string>',
    display_name: '<string>',
    manual_models: ['<string>']
  })
};

fetch('https://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints', 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://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints",
  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([
    'api_key' => '<string>',
    'base_url' => '<string>',
    'display_name' => '<string>',
    'manual_models' => [
        '<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://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints"

	payload := strings.NewReader("{\n  \"api_key\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"manual_models\": [\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://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"api_key\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"manual_models\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints")

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  \"api_key\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"manual_models\": [\n    \"<string>\"\n  ]\n}"

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

{
  "base_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_validated": true,
  "last_discovery_error": "<string>",
  "manual_models": [
    "<string>"
  ],
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

BYOK

Add a custom endpoint

Add a custom OpenAI-compatible endpoint (public HTTPS only). The base URL is normalised and validated with the key before saving; the key is encrypted at rest and never returned.

A refused validation is a 400 with one coarse code (endpoint_blocked, endpoint_unreachable, endpoint_tls_error, endpoint_timeout, endpoint_auth_failed, endpoint_not_found, endpoint_invalid_response, endpoint_redirected). An endpoint without a model list (endpoint_not_found) is saved when manual_models are given, with last_discovery_error set. An account holds at most 10 endpoints (409 custom_endpoint_limit_reached); names are unique per account ignoring case (409 custom_endpoint_name_taken). A transient failure is 503 key_validation_unavailable. Each check draws from the user’s validation budget (429 rate_limited).

POST

api

byok

custom-endpoints

Add a custom endpoint

curl --request POST \
  --url https://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_key": "<string>",
  "base_url": "<string>",
  "display_name": "<string>",
  "manual_models": [
    "<string>"
  ]
}
'

import requests

url = "https://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints"

payload = {
    "api_key": "<string>",
    "base_url": "<string>",
    "display_name": "<string>",
    "manual_models": ["<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({
    api_key: '<string>',
    base_url: '<string>',
    display_name: '<string>',
    manual_models: ['<string>']
  })
};

fetch('https://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints', 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://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints",
  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([
    'api_key' => '<string>',
    'base_url' => '<string>',
    'display_name' => '<string>',
    'manual_models' => [
        '<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://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints"

	payload := strings.NewReader("{\n  \"api_key\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"manual_models\": [\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://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"api_key\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"manual_models\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://neo.api.projectdiscovery.io/api/v1/byok/custom-endpoints")

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  \"api_key\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"manual_models\": [\n    \"<string>\"\n  ]\n}"

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

{
  "base_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_validated": true,
  "last_discovery_error": "<string>",
  "manual_models": [
    "<string>"
  ],
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

Authorizations

Authorization

string

header

required

JWT authentication token

Body

application/json

A malformed field (name, key or URL length, a manual model ID that does not match the model ID pattern, more than 50 manual IDs) is a 400 with the code invalid_request.

api_key

string

required

Bearer API key (encrypted at rest, never returned)

Maximum string length: 4096

base_url

string

required

Public https base URL on port 443, as the provider documents it (Neo appends nothing but /models)

Maximum string length: 2048

display_name

string

required

Name for the endpoint (1 to 80 characters)

Maximum string length: 80

manual_models

string[]

Model IDs to offer in addition to the listed ones (at most 50 after removing duplicates)

Response

Custom endpoint created

A custom OpenAI-compatible endpoint. The API key is never returned.

base_url

string

required

Normalised https base URL, as the provider documents it (usually ending in /v1)

created_at

string<date-time>

required

display_name

string

required

The user's name for the endpoint, unique per account ignoring case

string<uuid>

required

is_validated

boolean

required

Whether the key was accepted by the endpoint

last_discovery_error

string | null

required

Stable code of the last model-list failure (for example endpoint_not_found); null after a successful listing

manual_models

string[]

required

Model IDs typed by the user

updated_at

string<date-time>

required