Custom Templates

Generated on 18 Mar 2026

Base URL https://api.paperspace.com/v1

Endpoints

GET List templates POST Create template GET Get a template PUT Update a template DELETE Delete template

GET List templates

/custom-templates
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a list of templates.

Query Parameters

after string optional

Fetch the next page of results after this cursor.

limit integer 1 – 120 optional

The number of items to fetch after this page.

orderBy string, one of: dtCreated, name optional

Order results by one of these fields.

Default: dtCreated
order string, one of: asc, desc optional

The order to sort the results by.

Default: desc
name string optional
machineId string optional
Request: /custom-templates
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/custom-templates"

Responses

200

Successful response
Response Schema: application/json
hasMore boolean required

Whether there are more pages of results available.

items array of object required

The items on this page.

Show child properties
agentType string required

The type of agent installed on the template.

availableMachineTypes array of object required

The machine types the template is available on.

Show child properties
isAvailable boolean required

Whether the template is available on this machine type.

machineTypeLabel string required

The label of the machine type.

defaultSizeGb number (enum, 10 values) required

The default size of the template in gigabytes.

dtCreated string (date-time) required

The date the template was created.

dtDeleted string optional Nullable

The date the shared drive was deleted.

id string required

The ID of the template.

name string required

The name of the template.

operatingSystemLabel string required

The operating system installed on the template.

parentMachineId string required

The ID of the parent machine.

region string, one of: ny2, ca1, ams1 required

The region the template is in.

nextPage string optional

The cursor required to fetch the next page of results. i.e. ?after=nextPage. This is null when there is no next page.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "hasMore": true,
  "items": [
    {
      "agentType": "string",
      "availableMachineTypes": [],
      "defaultSizeGb": 0,
      "dtCreated": "2019-08-24T14:15:22Z",
      "id": "string",
      "name": "string",
      "operatingSystemLabel": "string",
      "parentMachineId": "string",
      "region": "ny2"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

POST Create template

/custom-templates
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Create a template for a machine.

Request Body: application/json

machineId string required

The ID of the machine to create a template from.

name string required

The name of the template.

Request: /custom-templates
Content type application/json 
{
  "machineId": "string",
  "name": "string"
}
curl -X POST \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "machineId": "string",
  "name": "string"
}' \
  "https://api.paperspace.com/v1/custom-templates"

Responses

200

Successful response
Response Schema: application/json
data object required

The template.

Show child properties
agentType string required

The type of agent installed on the template.

availableMachineTypes array of object required

The machine types the template is available on.

Show child properties
isAvailable boolean required

Whether the template is available on this machine type.

machineTypeLabel string required

The label of the machine type.

defaultSizeGb number (enum, 10 values) required

The default size of the template in gigabytes.

dtCreated string (date-time) required

The date the template was created.

dtDeleted string optional Nullable

The date the shared drive was deleted.

id string required

The ID of the template.

name string required

The name of the template.

operatingSystemLabel string required

The operating system installed on the template.

parentMachineId string required

The ID of the parent machine.

region string, one of: ny2, ca1, ams1 required

The region the template is in.

event object required

The machine event to poll for the async operation.

Show child properties
dtCreated string (date-time) required

The date the event was created.

dtFinished string (date-time) required Nullable

The date the event was finished.

dtStarted string (date-time) required Nullable

The date the event was started.

error string required Nullable

The error message of the event, if any.

id string required

The ID of the event.

machineId string required Nullable

The ID of the machine the event is for.

name string (enum) required

The name of the event, e.g. "create".

state string, one of: new, in progress, done, error, cancelled required

The state of the event, e.g. "done".

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "data": {
    "agentType": "string",
    "availableMachineTypes": [],
    "defaultSizeGb": 0,
    "dtCreated": "2019-08-24T14:15:22Z",
    "id": "string",
    "name": "string",
    "operatingSystemLabel": "string",
    "parentMachineId": "string",
    "region": "ny2"
  },
  "event": {
    "dtCreated": "2019-08-24T14:15:22Z",
    "dtFinished": "2019-08-24T14:15:22Z",
    "dtStarted": "2019-08-24T14:15:22Z",
    "error": "string",
    "id": "string",
    "machineId": "string",
    "name": "bill-sessions",
    "state": "new"
  }
}
{
  "code": "string",
  "message": "string"
}

GET Get a template

/custom-templates/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a single template by ID.

Path Parameters

id string required

The ID of the template to fetch.

Request: /custom-templates/{id}
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/custom-templates/{id}"

Responses

200

Successful response
Response Schema: application/json
agentType string required

The type of agent installed on the template.

availableMachineTypes array of object required

The machine types the template is available on.

Show child properties
isAvailable boolean required

Whether the template is available on this machine type.

machineTypeLabel string required

The label of the machine type.

defaultSizeGb number (enum, 10 values) required

The default size of the template in gigabytes.

dtCreated string (date-time) required

The date the template was created.

dtDeleted string optional Nullable

The date the shared drive was deleted.

id string required

The ID of the template.

name string required

The name of the template.

operatingSystemLabel string required

The operating system installed on the template.

parentMachineId string required

The ID of the parent machine.

region string, one of: ny2, ca1, ams1 required

The region the template is in.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "agentType": "string",
  "availableMachineTypes": [
    {
      "isAvailable": true,
      "machineTypeLabel": "string"
    }
  ],
  "defaultSizeGb": 0,
  "dtCreated": "2019-08-24T14:15:22Z",
  "id": "string",
  "name": "string",
  "operatingSystemLabel": "string",
  "parentMachineId": "string",
  "region": "ny2"
}
{
  "code": "string",
  "message": "string"
}

PUT Update a template

/custom-templates/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Updates a single template by ID.

Path Parameters

id string required

The ID of the template to update.

Request Body: application/json

name string required

The name of the template.

Request: /custom-templates/{id}
Content type application/json 
{
  "name": "string"
}
curl -X PUT \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}' \
  "https://api.paperspace.com/v1/custom-templates/{id}"

Responses

200

Successful response
Response Schema: application/json
agentType string required

The type of agent installed on the template.

availableMachineTypes array of object required

The machine types the template is available on.

Show child properties
isAvailable boolean required

Whether the template is available on this machine type.

machineTypeLabel string required

The label of the machine type.

defaultSizeGb number (enum, 10 values) required

The default size of the template in gigabytes.

dtCreated string (date-time) required

The date the template was created.

dtDeleted string optional Nullable

The date the shared drive was deleted.

id string required

The ID of the template.

name string required

The name of the template.

operatingSystemLabel string required

The operating system installed on the template.

parentMachineId string required

The ID of the parent machine.

region string, one of: ny2, ca1, ams1 required

The region the template is in.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "agentType": "string",
  "availableMachineTypes": [
    {
      "isAvailable": true,
      "machineTypeLabel": "string"
    }
  ],
  "defaultSizeGb": 0,
  "dtCreated": "2019-08-24T14:15:22Z",
  "id": "string",
  "name": "string",
  "operatingSystemLabel": "string",
  "parentMachineId": "string",
  "region": "ny2"
}
{
  "code": "string",
  "message": "string"
}

DELETE Delete template

/custom-templates/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Delete a template.

Path Parameters

id string required

The ID of the template to delete.

Request: /custom-templates/{id}
curl -X DELETE \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/custom-templates/{id}"

Responses

200

Successful response
Response Schema: application/json
agentType string required

The type of agent installed on the template.

availableMachineTypes array of object required

The machine types the template is available on.

Show child properties
isAvailable boolean required

Whether the template is available on this machine type.

machineTypeLabel string required

The label of the machine type.

defaultSizeGb number (enum, 10 values) required

The default size of the template in gigabytes.

dtCreated string (date-time) required

The date the template was created.

dtDeleted string optional Nullable

The date the shared drive was deleted.

id string required

The ID of the template.

name string required

The name of the template.

operatingSystemLabel string required

The operating system installed on the template.

parentMachineId string required

The ID of the parent machine.

region string, one of: ny2, ca1, ams1 required

The region the template is in.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "agentType": "string",
  "availableMachineTypes": [
    {
      "isAvailable": true,
      "machineTypeLabel": "string"
    }
  ],
  "defaultSizeGb": 0,
  "dtCreated": "2019-08-24T14:15:22Z",
  "id": "string",
  "name": "string",
  "operatingSystemLabel": "string",
  "parentMachineId": "string",
  "region": "ny2"
}
{
  "code": "string",
  "message": "string"
}

We can't find any results for your search.

Try using different keywords or simplifying your search terms.