> ## Documentation Index
> Fetch the complete documentation index at: https://docs.novita.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List Endpoints

## Request Headers

**Content-Type** `string` *required*

Enum: `application/json`

**Authorization** `string` *required*

Bearer authentication format, for example: Bearer \{\{API Key}}.

## Query Parameters

**pageSize** `integer` *required*

Maximum number of items returned per page.

**pageNum** `integer` *required*

Current page number.

## Response

**endpoints** `object[]` *required*

Endpoint information.

**properties**

**id** `string` *required*

Endpoint ID.

**name** `string` *required*

Endpoint name.

**appName** `string` *required*

Application name.

**state** `object` *required*

Endpoint status.

**properties**

**state** `string` *required*

Endpoint status. When the value is `serving`, the endpoint is available for service.

**error** `string`

Error code when the endpoint is in an abnormal state.

**message** `string`

Error message when the endpoint is in an abnormal state.

**url** `string` *required*

Endpoint URL. You can access your HTTP service via this URL.

**workerConfig** `object` *required*

Worker configuration for the endpoint.

**properties**

**minNum** `integer` *required*

Minimum number of workers.

**maxNum** `integer` *required*

Maximum number of workers.

**freeTimeout** `string` *required*

Idle timeout, in seconds.

**maxConcurrent** `string` *required*

Maximum concurrency.

**gpuNum** `integer` *required*

Number of GPUs per worker.

**requestTimeout** `integer` *required*

Request timeout (seconds).

**cudaVersion** `string` *required*

CUDA version.

**policy** `object` *required*

Auto-scaling policy for the endpoint.

**properties**

**type** `string` *required*

Policy type. Options:

* `queue`: Queue latency policy, adjusts the number of workers based on the waiting time of requests in the queue.
* `concurrency`: Queue request policy, automatically adjusts the number of workers based on the number of requests in the queue.

**value** `string` *required*

The meaning of value depends on the type:

* If type = queue, value is the queue waiting time in seconds.
* If type = concurrency, value is the maximum number of requests in the queue.

**image** `object` *required*

Image configuration for the endpoint.

**properties**

**image** `string` *required*

Image URL.

**authId** `string` *required*

Image repository credential.

**command** `string` *required*

Container startup command.

**rootfsSize** `integer` *required*

System disk size.

**volumeMounts** `object[]` *required*

Storage configuration for the endpoint.

**properties**

**type** `string` *required*

Storage type. Options:

* `local`: Local storage.
* `network`: Cloud storage.

**id** `string` *required*

Cloud storage ID. Returned when type = network.

**size** `integer`

Returned when type = local, indicates the size of the local disk.

**mountPath** `string` *required*

Mount path for the storage.

**envs** `object[]` *required*

Environment variables.

**properties**

**key** `string` *required*

Environment variable name.

**value** `string` *required*

Environment variable value.

**ports** `object[]` *required*

HTTP ports.

**properties**

**port** `string` *required*

HTTP port.

**workers** `object[]` *required*

Worker information for the endpoint.

**properties**

**id** `string` *required*

Worker ID.

**state** `object` *required*

Worker status.

**properties**

**state** `string` *required*

Worker status. When the value is `running`, the worker is available for service.

**error** `string`

Error code when the worker is in an abnormal state.

**message** `string`

Error message when the worker is in an abnormal state.

**log** `string` *required*

Log path for the worker.

**metrics** `string` *required*

Monitoring information for the worker.

**healthy** `boolean` *required*

Whether the worker is healthy.

**products** `object[]` *required*

Product information.

**properties**

**id** `string` *required*

Product ID.

**healthy** `object` *required*

Health check configuration for the endpoint.

**properties**

**path** `string` *required*

Path to be checked via HTTP request for health monitoring.

**initialDelay** `integer` *required*

Time to wait after startup before starting health checks, in seconds.

**period** `integer` *required*

Interval between health checks, in seconds.

**timeout** `integer` *required*

Timeout for health checks, in seconds.

**successThreshold** `integer` *required*

Number of consecutive successes required to consider the check successful after a previous failure.

**failureThreshold** `integer` *required*

Number of consecutive failures required to consider the check failed after a previous success.

**clusterID** `string` *required*

Cluster ID where the cloud storage resides. Returned when using cloud storage.

**log** `string` *required*

Log path for the endpoint.

**total** `integer` *required*

Total number of results.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.