Serverless

Create a Elastic deployment

post

Create a Elastic deployment

Authorizations

x-api-key

x-api-keystringRequired

Body

application/json

ElasticDeployCreateRequest

namestring · min: 1Required

Elastic Deployment Name

Pattern: ^(?=[A-Za-z])[A-Za-z0-9@._-]{1,50}$

imageRegistrystringOptional

Image Registry Url

imagestring · min: 1 · max: 255Required

image

minSingleCardVramInGbinteger · int32 · max: 1536Optional

Min GPU Single Card VRAM(GB)

minSingleCardVcpuinteger · int32Optional

Min GPU Single Card VCPU

minSingleCardRamInGbinteger · int32 · max: 1536Optional

Min GPU Single Card RAM(GB)

workersinteger · int32 · min: 1Required

Workers

credentialIdstringOptional

Credential Id

containerVolumeInGbinteger · int32 · min: 20Required

Container volume(GB)

initializationCommandstringOptional

Initialization Command

serviceModestring · min: 1Required

Service Mode(ALB,QUEUE,CUSTOM)

webhookUrlstringOptional

Webhook Url

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Bad Request

*/*

500

Internal Server Error

*/*

post/openapi/v1/elastic/deploy/create

HTTPcURLJavaScriptPython

POST /openapi/v1/elastic/deploy/create HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 421

{
  "name": "text",
  "imageRegistry": "text",
  "image": "text",
  "resources": [
    {
      "region": "text",
      "gpuType": "text",
      "gpuCount": 1
    }
  ],
  "minSingleCardVramInGb": 1,
  "minSingleCardVcpu": 1,
  "minSingleCardRamInGb": 1,
  "workers": 1,
  "credentialId": "text",
  "containerVolumeInGb": 1,
  "initializationCommand": "text",
  "environmentVars": [
    {
      "key": "HF_HOME",
      "value": "/workspace/cache"
    }
  ],
  "expose": {
    "port": 1,
    "protocol": "text"
  },
  "serviceMode": "text",
  "webhookUrl": "text"
}

{
  "message": "text",
  "code": 1,
  "data": {
    "id": "text",
    "name": "text",
    "creator": "text",
    "domain": "text",
    "imageRegistry": "text",
    "image": "text",
    "resources": [
      {
        "region": "text",
        "regionDisplayName": "text",
        "gpuType": "text",
        "gpuDisplayName": "text",
        "gpuCount": 1,
        "singleCardVramInGb": 1,
        "singleCardVcpu": 1,
        "singleCardRamInGb": 1
      }
    ],
    "minSingleCardVramInGb": 1,
    "minSingleCardVcpu": 1,
    "minSingleCardRamInGb": 1,
    "credentialId": 1,
    "containerVolumeInGb": 1,
    "initializationCommand": "text",
    "environmentVars": [
      {
        "key": "HF_HOME",
        "value": "/workspace/cache"
      }
    ],
    "expose": {
      "port": 1,
      "protocol": "text"
    },
    "totalWorkers": 1,
    "runningWorkers": 1,
    "cost": 1,
    "perSecondPrice": 1,
    "perHourPrice": 1,
    "serviceMode": "text",
    "webhookUrl": "text",
    "status": "text"
  }
}

Update a Elastic deployment

post

Update a specific Elastic deployment

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64RequiredExample: 0

Body

application/json

ElasticDeployUpdateRequest

namestring · min: 1Required

Elastic Deployment Name

Pattern: ^(?=[A-Za-z])[A-Za-z0-9@._-]{1,50}$

minSingleCardVramInGbinteger · int32Optional

Min GPU Single Card VRAM(GB)

minSingleCardVcpuinteger · int32Optional

Min GPU Single Card VCPU

minSingleCardRamInGbinteger · int32Optional

Min GPU Single Card RAM(GB)

workersinteger · int32 · min: 1Required

Workers

credentialIdstringOptional

Credential Id

containerVolumeInGbinteger · int32 · min: 20Required

Container volume(GB)

initializationCommandstringOptional

Initialization Command

webhookUrlstringOptional

Webhook Url

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Bad Request

*/*

500

Internal Server Error

*/*

post/openapi/v1/elastic/deploy/{id}/update

HTTPcURLJavaScriptPython

POST /openapi/v1/elastic/deploy/{id}/update HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 362

{
  "name": "text",
  "resources": [
    {
      "region": "text",
      "gpuType": "text",
      "gpuCount": 1
    }
  ],
  "minSingleCardVramInGb": 1,
  "minSingleCardVcpu": 1,
  "minSingleCardRamInGb": 1,
  "workers": 1,
  "credentialId": "text",
  "containerVolumeInGb": 1,
  "initializationCommand": "text",
  "environmentVars": [
    {
      "key": "HF_HOME",
      "value": "/workspace/cache"
    }
  ],
  "expose": {
    "port": 1,
    "protocol": "text"
  },
  "webhookUrl": "text"
}

{
  "message": "text",
  "code": 1,
  "data": {
    "id": "text",
    "name": "text",
    "creator": "text",
    "domain": "text",
    "imageRegistry": "text",
    "image": "text",
    "resources": [
      {
        "region": "text",
        "regionDisplayName": "text",
        "gpuType": "text",
        "gpuDisplayName": "text",
        "gpuCount": 1,
        "singleCardVramInGb": 1,
        "singleCardVcpu": 1,
        "singleCardRamInGb": 1
      }
    ],
    "minSingleCardVramInGb": 1,
    "minSingleCardVcpu": 1,
    "minSingleCardRamInGb": 1,
    "credentialId": 1,
    "containerVolumeInGb": 1,
    "initializationCommand": "text",
    "environmentVars": [
      {
        "key": "HF_HOME",
        "value": "/workspace/cache"
      }
    ],
    "expose": {
      "port": 1,
      "protocol": "text"
    },
    "totalWorkers": 1,
    "runningWorkers": 1,
    "cost": 1,
    "perSecondPrice": 1,
    "perHourPrice": 1,
    "serviceMode": "text",
    "webhookUrl": "text",
    "status": "text"
  }
}

Stop a Elastic deployment

post

Stop a specific Elastic deployment

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64RequiredExample: 0

Responses

200

OK

*/*

messagestringOptional

message

Example: success

codeinteger · int32Optional

code

Example: 10000

dataanyOptional

data

400

Bad Request

*/*

500

Internal Server Error

*/*

post/openapi/v1/elastic/deploy/{id}/stop

HTTPcURLJavaScriptPython

POST /openapi/v1/elastic/deploy/{id}/stop HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "success",
  "code": 10000,
  "data": null
}

Scale Elastic Deployment Workers

post

Adjust the number of workers for a specific elastic deployment.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64RequiredExample: 0

Body

application/json

OpenapiScaleWorkersRequest

workersinteger · int32Required

workers

Responses

200

OK

*/*

messagestringOptional

message

Example: success

codeinteger · int32Optional

code

Example: 10000

dataanyOptional

data

400

Bad Request

*/*

500

Internal Server Error

*/*

post/openapi/v1/elastic/deploy/{id}/workers

HTTPcURLJavaScriptPython

POST /openapi/v1/elastic/deploy/{id}/workers HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "workers": 1
}

{
  "message": "success",
  "code": 10000,
  "data": null
}

Start or resume a Elastic deployment

post

Start or resume a specific Elastic deployment

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64RequiredExample: 0

Responses

200

OK

*/*

messagestringOptional

message

Example: success

codeinteger · int32Optional

code

Example: 10000

dataanyOptional

data

400

Bad Request

*/*

500

Internal Server Error

*/*

post/openapi/v1/elastic/deploy/{id}/start

HTTPcURLJavaScriptPython

POST /openapi/v1/elastic/deploy/{id}/start HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "success",
  "code": 10000,
  "data": null
}

Delete a Elastic deployment

delete

Delete a specific Elastic deployment

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64RequiredExample: 0

Responses

200

OK

*/*

messagestringOptional

message

Example: success

codeinteger · int32Optional

code

Example: 10000

dataanyOptional

data

400

Bad Request

*/*

500

Internal Server Error

*/*

delete/openapi/v1/elastic/deploy/{id}

HTTPcURLJavaScriptPython

DELETE /openapi/v1/elastic/deploy/{id} HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "success",
  "code": 10000,
  "data": null
}

Get all Elastic deployments

get

Get all Elastic deployments list

Authorizations

x-api-key

x-api-keystringRequired

Query parameters

statusListstring[]Optional

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Bad Request

*/*

500

Internal Server Error

*/*

get/openapi/v1/elastic/deploy/list

HTTPcURLJavaScriptPython

GET /openapi/v1/elastic/deploy/list HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "text",
  "code": 1,
  "data": [
    {
      "id": "text",
      "name": "text",
      "creator": "text",
      "domain": "text",
      "imageRegistry": "text",
      "image": "text",
      "resources": [
        {
          "region": "text",
          "regionDisplayName": "text",
          "gpuType": "text",
          "gpuDisplayName": "text",
          "gpuCount": 1,
          "singleCardVramInGb": 1,
          "singleCardVcpu": 1,
          "singleCardRamInGb": 1
        }
      ],
      "minSingleCardVramInGb": 1,
      "minSingleCardVcpu": 1,
      "minSingleCardRamInGb": 1,
      "credentialId": 1,
      "containerVolumeInGb": 1,
      "initializationCommand": "text",
      "environmentVars": [
        {
          "key": "HF_HOME",
          "value": "/workspace/cache"
        }
      ],
      "expose": {
        "port": 1,
        "protocol": "text"
      },
      "totalWorkers": 1,
      "runningWorkers": 1,
      "cost": 1,
      "perSecondPrice": 1,
      "perHourPrice": 1,
      "serviceMode": "text",
      "webhookUrl": "text",
      "status": "text"
    }
  ]
}

Query worker logs

get

Query worker logs with pagination

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64RequiredExample: 0

workerIdinteger · int64RequiredExample: 0

Query parameters

pageSizeinteger · int32OptionalDefault: 100

keywordstringOptional

startTimestringOptional

endTimestringOptional

searchAfterTimestringOptional

searchAfterOffsetinteger · int64Optional

directionstringOptional

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Bad Request

*/*

500

Internal Server Error

*/*

get/openapi/v1/elastic/deploy/{id}/workers/{workerId}/logs

HTTPcURLJavaScriptPython

GET /openapi/v1/elastic/deploy/{id}/workers/{workerId}/logs HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "success",
  "code": 10000,
  "data": {
    "logs": [
      "[INFO] Worker started",
      "[INFO] Task received"
    ],
    "hasMore": false,
    "nextSearchAfterTime": null,
    "nextSearchAfterOffset": null
  }
}

Get Elastic deployment detail

get

Retrieve detailed information of a specific elastic deployment by ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64RequiredExample: 0

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Bad Request

*/*

500

Internal Server Error

*/*

get/openapi/v1/elastic/deploy/{id}

HTTPcURLJavaScriptPython

GET /openapi/v1/elastic/deploy/{id} HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "text",
  "code": 1,
  "data": {
    "id": "text",
    "name": "text",
    "creator": "text",
    "domain": "text",
    "imageRegistry": "text",
    "image": "text",
    "resources": [
      {
        "region": "text",
        "regionDisplayName": "text",
        "gpuType": "text",
        "gpuDisplayName": "text",
        "gpuCount": 1,
        "singleCardVramInGb": 1,
        "singleCardVcpu": 1,
        "singleCardRamInGb": 1
      }
    ],
    "minSingleCardVramInGb": 1,
    "minSingleCardVcpu": 1,
    "minSingleCardRamInGb": 1,
    "credentialId": 1,
    "containerVolumeInGb": 1,
    "initializationCommand": "text",
    "environmentVars": [
      {
        "key": "HF_HOME",
        "value": "/workspace/cache"
      }
    ],
    "expose": {
      "port": 1,
      "protocol": "text"
    },
    "totalWorkers": 1,
    "runningWorkers": 1,
    "cost": 1,
    "perSecondPrice": 1,
    "perHourPrice": 1,
    "serviceMode": "text",
    "webhookUrl": "text",
    "status": "text"
  }
}

Get all workers of a Elastic deployment

get

Get all workers of a specific Elastic deployment

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64RequiredExample: 0

Query parameters

statusListstring[]Optional

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Bad Request

*/*

500

Internal Server Error

*/*

get/openapi/v1/elastic/deploy/{id}/workers

HTTPcURLJavaScriptPython

GET /openapi/v1/elastic/deploy/{id}/workers HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "success",
  "code": 10000,
  "data": []
}