Skip to main content
POST
Create an endpoint

Authorizations

Authorization
string
header
default:default
required

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

Path Parameters

projectId
string
required

Project identifier.

Body

application/json

Request parameters for creating an endpoint.

name
string
required

Inference-addressable endpoint name to create.

visibility
enum<string>
default:VISIBILITY_PRIVATE

Who can discover the endpoint. VISIBILITY_PRIVATE restricts it to the project; VISIBILITY_INTERNAL shares it with the organization.

Available options:
VISIBILITY_PRIVATE,
VISIBILITY_INTERNAL

Response

OK

Stable inference entry point that groups deployments and routes requests among them.

id
string
required
read-only

Unique endpoint identifier.

projectId
string
required
read-only

ID of the project that owns the endpoint.

name
string
required

Project-qualified endpoint name in the form <project_slug>/<endpoint_name>. Pass this value as model in inference requests. Create and update requests may use either a bare endpoint name or the qualified form; a supplied project slug must match the project in the request path.

createdAt
string<date-time>
required
read-only

Timestamp when the endpoint was created.

updatedAt
string<date-time>
required

Output only. Timestamp when the endpoint was last updated.

etag
string
required

Opaque version tag for optimistic concurrency control. Supply on update/delete to ensure consistent read-modify-write. If not set, the write overwrites based on current state.

trafficSplit
object[]
required

Deployments eligible for live traffic and their capacity weights. An empty list leaves the endpoint unrouted.

visibility
enum<string>
default:VISIBILITY_PRIVATE
required

Who can discover the endpoint. VISIBILITY_PRIVATE restricts it to the project; VISIBILITY_INTERNAL shares it with the organization.

Available options:
VISIBILITY_PRIVATE,
VISIBILITY_INTERNAL
endpointType
enum<string>
required
read-only

Serving class of the endpoint.

Available options:
ENDPOINT_TYPE_DEDICATED,
ENDPOINT_TYPE_SERVERLESS
deployments
object[]
required
read-only

Lightweight summaries of deployments under this endpoint. Retrieve a deployment through the endpoint's deployment API for full details.

activeRolloutId
string
read-only

ID of the currently active rollout, or empty if none.