Skip to main content
POST
/
api
/
v1
/
sandbox
/
{sandbox_id}
/
expose
Expose Port Endpoint
curl --request POST \
  --url https://api.primeintellect.ai/api/v1/sandbox/{sandbox_id}/expose \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "port": 4511,
  "name": "<string>",
  "protocol": "HTTP"
}
'
{
  "exposure_id": "<string>",
  "sandbox_id": "<string>",
  "port": 123,
  "protocol": "<string>",
  "url": "<string>",
  "tls_socket": "<string>",
  "name": "<string>",
  "external_port": 123,
  "external_endpoint": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.primeintellect.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
sandbox_id
string
required

Body

application/json
​
port
integer
required

Port number to expose (22-9000)

Required range: 22 <= x <= 9000
​
name
string | null

Optional human-readable name for the exposure

Maximum string length: 50
​
protocol
string
default:HTTP

Protocol (HTTP or TCP)

Response

Successful Response

​
exposure_id
string
required
​
sandbox_id
string
required
​
port
integer
required
​
protocol
string
required
​
url
string
required

Public URL for accessing the exposed port

​
tls_socket
string
required
​
name
string | null
​
external_port
integer | null

External port for TCP exposures (not applicable for HTTP)

​
external_endpoint
string | null

External endpoint (host:port) for TCP/UDP exposures (not applicable for HTTP)