Instances

Get a list of all instances

This endpoint retrieves a list of all instances. The request requires a Bearer token in the header.

get

/instances/

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cortecs.ai/api/v1/instances/' \
  --header 'Authorization: Bearer JWT'

200

401

500

200

{
  "instances": [
    {
      "instance_id": "instance-12345",
      "base_url": "https://abcd-123456.eu/v1",
      "instance_args": {
        "model_id": "meta-llama--Meta-Llama-3.1-8B-Instruct",
        "hardware_type_id": "NVIDIA_H100_1",
        "context_length": 8192,
        "billing_interval": "per_minute"
      },
      "instance_status": {
        "started_at": "2024-08-07T08:53:13Z",
        "stopped_at": null,
        "status": "running"
      },
      "worker_statuses": [
        {
          "init_progress": {
            "current_step": 5,
            "num_steps": 5,
            "description": "Running"
          }
        }
      ]
    }
  ]
}

Successfully retrieved all instances

Get detailed information about an instance

This endpoint returns detailed information of the passed instance.

get

/instances/{instance_id}

Authorizations

Path parameters

instance_idstringrequired

The unique identifier of the instance.

Example: instance-12345

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cortecs.ai/api/v1/instances/{instance_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

500

200

{
  "instance": {
    "instance_id": "instance-12345",
    "base_url": "https://abcd-123456.eu/v1",
    "instance_args": {
      "model_id": "meta-llama--Meta-Llama-3.1-8B-Instruct",
      "hardware_type_id": "NVIDIA_H100_1",
      "context_length": 8192,
      "billing_interval": "per_minute"
    },
    "instance_status": {
      "started_at": "2024-08-07T08:53:13Z",
      "stopped_at": null,
      "status": "running"
    },
    "worker_statuses": [
      {
        "init_progress": {
          "current_step": 5,
          "num_steps": 5,
          "description": "Running"
        }
      }
    ]
  }
}

Successfully returned information about a specific instance.

Start an instance

This endpoint starts an instance based on the provided instance arguments. The full instance is not available immediately after starting, but the status can be checked using the /instances/{instance_id} endpoint. The request requires a Bearer token in the header.

post

/instances/start

Authorizations

Body

model_idstringrequired

The id of the model to start.

Example: meta-llama--Meta-Llama-3.1-8B-Instruct

hardware_type_idstring

The id of hardware type to run the model on. Default is recommended_config of the model.

Example: NVIDIA_H100_1

billing_intervalstring · enum

The billing interval.

Example: per_minute

Options: per_minute, per_hour

context_lengthnumber

Context length can be reduced if the full context length is not needed for the task. Decreasing the maximum context length increases the throughput of the model. Default is min(32000, max_context_length).

Example: 8192

num_workersinteger

The number of workers to run the model on. Default is 1.

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://cortecs.ai/api/v1/instances/start' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "model_id": "meta-llama--Meta-Llama-3.1-8B-Instruct",
    "hardware_type_id": "NVIDIA_H100_1",
    "billing_interval": "per_minute",
    "context_length": 8192,
    "num_workers": 1
  }'

202

400

401

500

202

{
  "message": "Instance is starting.",
  "instance": {
    "instance_id": "instance-12345",
    "base_url": "https://abcd-123456.eu/v1",
    "instance_args": {
      "model_id": "meta-llama--Meta-Llama-3.1-8B-Instruct",
      "hardware_type_id": "NVIDIA_H100_1",
      "context_length": 8192,
      "billing_interval": "per_minute"
    },
    "instance_status": {
      "started_at": "2024-08-07T08:53:13Z",
      "stopped_at": null,
      "status": "running"
    },
    "worker_statuses": [
      {
        "init_progress": {
          "current_step": 5,
          "num_steps": 5,
          "description": "Running"
        }
      }
    ]
  }
}

The instance is starting.

Restart an instance

This endpoint restarts an instance based on the provided instance ID. The full instance is not available immediately after restarting, but the status can be checked using the /instances/{instance_id} endpoint. The request requires a Bearer token in the header.

post

/instances/restart

Authorizations

Body

instance_idstringrequired

The ID of the instance to restart.

Example: instance-12345

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://cortecs.ai/api/v1/instances/restart' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "instance_id": "instance-12345"
  }'

202

400

401

500

202

{
  "message": "Instance is starting.",
  "instance": {
    "instance_id": "instance-12345",
    "base_url": "https://abcd-123456.eu/v1",
    "instance_args": {
      "model_id": "meta-llama--Meta-Llama-3.1-8B-Instruct",
      "hardware_type_id": "NVIDIA_H100_1",
      "context_length": 8192,
      "billing_interval": "per_minute"
    },
    "instance_status": {
      "started_at": "2024-08-07T08:53:13Z",
      "stopped_at": null,
      "status": "running"
    },
    "worker_statuses": [
      {
        "init_progress": {
          "current_step": 5,
          "num_steps": 5,
          "description": "Running"
        }
      }
    ]
  }
}

Successfully restarted the instance.

Stop an instance

This endpoint stops an instance based on the provided instance ID. The request requires a Bearer token in the header.

post

/instances/stop

Authorizations

Body

instance_idstringrequired

The ID of the instance to stop.

Example: instance-12345

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://cortecs.ai/api/v1/instances/stop' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "instance_id": "instance-12345"
  }'

200

400

401

500

200

{
  "message": "Instance stopped successfully",
  "instance": {
    "instance_id": "instance-12345",
    "base_url": "https://abcd-123456.eu/v1",
    "instance_args": {
      "model_id": "meta-llama--Meta-Llama-3.1-8B-Instruct",
      "hardware_type_id": "NVIDIA_H100_1",
      "context_length": 8192,
      "billing_interval": "per_minute"
    },
    "instance_status": {
      "started_at": "2024-08-07T08:53:13Z",
      "stopped_at": null,
      "status": "running"
    },
    "worker_statuses": [
      {
        "init_progress": {
          "current_step": 5,
          "num_steps": 5,
          "description": "Running"
        }
      }
    ]
  }
}

Successfully stopped the instance.

Stop all instances

This endpoint stops all running instances. The request requires a Bearer token in the header.

post

/instances/stop-all

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://cortecs.ai/api/v1/instances/stop-all' \
  --header 'Authorization: Bearer JWT'

200

401

500

200

{
  "message": "All instances stopped successfully.",
  "instance_ids": [
    "instance-12345",
    "instance-67890"
  ]
}

Successfully stopped all instances.

Delete an instance

This endpoint deletes an instance based on the provided instance ID. The instance must first be stopped before it can be deleted. To stop the instance, use the /instances/stop endpoint. The request requires a Bearer token in the header.

delete

/instances/{instance_id}

Authorizations

Path parameters

instance_idstringrequired

The ID of the instance to delete.

Example: instance-12345

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://cortecs.ai/api/v1/instances/{instance_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

500

200

{
  "message": "Instance deleted successfully.",
  "instance_id": "instance-12345"
}

Successfully deleted the model instance.

Delete all instances

This endpoint deletes all instances. If the force_deletion parameter is set to true, all instances will be deleted without stopping them first. Otherwise, only the stopped instances will be deleted. The request requires a Bearer token in the header.

delete

/instances/delete-all

Authorizations

Query parameters

force_deletionboolean

Whether to force delete all instances without stopping them first.

Example: true

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://cortecs.ai/api/v1/instances/delete-all' \
  --header 'Authorization: Bearer JWT'

200

401

500

200

{
  "message": "All instances deleted successfully.",
  "instance_ids": [
    "instance-12345",
    "instance-67890"
  ]
}

Successfully deleted all instances.