fwd-sdk 0.1.1

Forward Compute API

Forward Compute SDK

Forward Compute API for managing machines, contracts, and compute resources

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 0.1.1
• Generator version: 7.18.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import fwd_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import fwd_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import fwd_sdk
from fwd_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.forwardcompute.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = fwd_sdk.Configuration(
    host = "https://app.forwardcompute.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = fwd_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with fwd_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fwd_sdk.AudioApi(api_client)
    create_speech_request = fwd_sdk.CreateSpeechRequest() # CreateSpeechRequest | 

    try:
        # Create speech from text
        api_response = api_instance.create_speech(create_speech_request)
        print("The response of AudioApi->create_speech:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AudioApi->create_speech: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://app.forwardcompute.ai

Class	Method	HTTP request	Description
AudioApi	create_speech	POST /v1/audio/speech	Create speech from text
AudioApi	create_transcription	POST /v1/audio/transcriptions	Create transcription from audio
AudioApi	create_translation	POST /v1/audio/translations	Create translation from audio
AudioApi	list_voices	GET /v1/audio/voices	List available TTS voices
ChatApi	create_completion	POST /v1/chat/completions	Create chat completion
ChatApi	get_completion	GET /v1/chat/completions/{id}	Get inference metadata
ChatApi	list_completions	GET /v1/chat/completions	List inference history
ComputeApi	get_offering	GET /v1/spot/compute/offerings/{id}	Get compute offering
ComputeApi	list_offerings	GET /v1/spot/compute/offerings	List compute offerings
EmbeddingsApi	create_embedding	POST /v1/embeddings/	Create embeddings
ImagesApi	create_image	POST /v1/images/generations	Generate images from a text prompt
InstancesApi	create_instance	POST /v1/spot/instances/	Create instance
InstancesApi	delete_instance	DELETE /v1/spot/instances/{id}	Delete instance
InstancesApi	get_instance	GET /v1/spot/instances/{id}	Get instance
InstancesApi	list_instances	GET /v1/spot/instances/	List instances
InstancesApi	restart_instance	POST /v1/spot/instances/{id}/restart	Restart instance
ModelsApi	list_models	GET /v1/models/	List models
SSHKeysApi	create_ssh_key	POST /v1/spot/ssh-keys/	Create SSH key
SSHKeysApi	delete_ssh_key	DELETE /v1/spot/ssh-keys/{id}	Delete SSH key
SSHKeysApi	list_ssh_keys	GET /v1/spot/ssh-keys/	List SSH keys
SupportApi	contact	POST /v1/support/	Submit support request
VolumesApi	create_volume	POST /v1/spot/volumes/	Create volume
VolumesApi	delete_volume	DELETE /v1/spot/volumes/{id}	Delete volume
VolumesApi	get_volume	GET /v1/spot/volumes/{id}	Get volume
VolumesApi	get_volume_offering	GET /v1/spot/volumes/offerings/{id}	Get volume offering
VolumesApi	list_volume_offerings	GET /v1/spot/volumes/offerings	List volume offerings
VolumesApi	list_volumes	GET /v1/spot/volumes/	List volumes

Documentation For Models

• Contact400Response
• Contact400ResponseError
• ContactRequest
• CreateCompletion200Response
• CreateCompletion200ResponseChoicesInner
• CreateCompletion200ResponseUsage
• CreateCompletionRequest
• CreateCompletionRequestMessagesInner
• CreateCompletionRequestMessagesInnerToolCallsInner
• CreateCompletionRequestMessagesInnerToolCallsInnerFunction
• CreateCompletionRequestToolsInner
• CreateCompletionRequestToolsInnerFunction
• CreateEmbedding200Response
• CreateEmbedding200ResponseDataInner
• CreateEmbedding200ResponseDataInnerEmbedding
• CreateEmbedding200ResponseUsage
• CreateEmbeddingRequest
• CreateEmbeddingRequestInput
• CreateImage200Response
• CreateImage200ResponseDataInner
• CreateImageRequest
• CreateInstance200Response
• CreateInstanceRequest
• CreateSpeech400Response
• CreateSpeech400ResponseError
• CreateSpeech402Response
• CreateSpeech402ResponseError
• CreateSpeechRequest
• CreateSshKeyRequest
• CreateTranscription200Response
• CreateTranscription200ResponseSegmentsInner
• CreateTranscriptionRequest
• CreateTranslationRequest
• CreateVolumeRequest
• DeleteInstance200Response
• DeleteSshKey200Response
• DeleteVolume200Response
• GetOffering200Response
• GetVolumeOffering200Response
• ListCompletions200Response
• ListCompletions200ResponseItemsInner
• ListInstances200Response
• ListInstances200ResponseDataInner
• ListInstances200ResponseDataInnerEnvsInner
• ListModels200Response
• ListModels200ResponseModelsInner
• ListModels200ResponseModelsInnerPricing
• ListModels200ResponseModelsInnerPricingOneOf
• ListModels200ResponseModelsInnerPricingOneOf1
• ListModels200ResponseModelsInnerPricingOneOf2
• ListModels200ResponseModelsInnerPricingOneOf3
• ListModels200ResponseModelsInnerPricingOneOf4
• ListModels200ResponseModelsInnerPricingOneOf5
• ListOfferings200Response
• ListOfferings200ResponseDataInner
• ListOfferings200ResponseDataInnerBootTime
• ListOfferings200ResponseDataInnerConfiguration
• ListSshKeys200Response
• ListSshKeys200ResponseDataInner
• ListVoices200Response
• ListVoices200ResponseVoicesInner
• ListVolumeOfferings200Response
• ListVolumeOfferings200ResponseDataInner
• ListVolumes200Response
• ListVolumes200ResponseDataInner

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author