api.md

Collections

Types:

from replicate.types import CollectionListResponse, CollectionGetResponse

Methods:

• replicate.collections.list() -> SyncCursorURLPage[CollectionListResponse]
• replicate.collections.get(*, collection_slug) -> CollectionGetResponse

Deployments

Types:

from replicate.types import (
    DeploymentCreateResponse,
    DeploymentUpdateResponse,
    DeploymentListResponse,
    DeploymentGetResponse,
)

Methods:

• replicate.deployments.create(**params) -> DeploymentCreateResponse
• replicate.deployments.update(*, deployment_owner, deployment_name, **params) -> DeploymentUpdateResponse
• replicate.deployments.list() -> SyncCursorURLPage[DeploymentListResponse]
• replicate.deployments.delete(*, deployment_owner, deployment_name) -> None
• replicate.deployments.get(*, deployment_owner, deployment_name) -> DeploymentGetResponse

Predictions

Methods:

• replicate.deployments.predictions.create(*, deployment_owner, deployment_name, **params) -> Prediction

Hardware

Types:

from replicate.types import HardwareListResponse

Methods:

• replicate.hardware.list() -> HardwareListResponse

Account

Types:

from replicate.types import AccountGetResponse

Methods:

• replicate.account.get() -> AccountGetResponse

Models

Types:

from replicate.types import (
    ModelCreateResponse,
    ModelListResponse,
    ModelGetResponse,
    ModelSearchResponse,
)

Methods:

• replicate.models.create(**params) -> ModelCreateResponse
• replicate.models.list() -> SyncCursorURLPage[ModelListResponse]
• replicate.models.delete(*, model_owner, model_name) -> None
• replicate.models.get(*, model_owner, model_name) -> ModelGetResponse
• replicate.models.search(**params) -> SyncCursorURLPage[ModelSearchResponse]

Examples

Methods:

• replicate.models.examples.list(*, model_owner, model_name) -> SyncCursorURLPage[Prediction]

Predictions

Methods:

• replicate.models.predictions.create(*, model_owner, model_name, **params) -> Prediction

Readme

Types:

from replicate.types.models import ReadmeGetResponse

Methods:

• replicate.models.readme.get(*, model_owner, model_name) -> str

Versions

Types:

from replicate.types.models import VersionListResponse, VersionGetResponse

Methods:

• replicate.models.versions.list(*, model_owner, model_name) -> SyncCursorURLPage[VersionListResponse]
• replicate.models.versions.delete(*, model_owner, model_name, version_id) -> None
• replicate.models.versions.get(*, model_owner, model_name, version_id) -> VersionGetResponse

Predictions

Types:

from replicate.types import Prediction, PredictionOutput, PredictionRequest

Methods:

• replicate.predictions.create(**params) -> Prediction
• replicate.predictions.list(**params) -> SyncCursorURLPageWithCreatedFilters[Prediction]
• replicate.predictions.cancel(*, prediction_id) -> Prediction
• replicate.predictions.get(*, prediction_id) -> Prediction

Trainings

Types:

from replicate.types import (
    TrainingCreateResponse,
    TrainingListResponse,
    TrainingCancelResponse,
    TrainingGetResponse,
)

Methods:

• replicate.trainings.create(*, model_owner, model_name, version_id, **params) -> TrainingCreateResponse
• replicate.trainings.list() -> SyncCursorURLPage[TrainingListResponse]
• replicate.trainings.cancel(*, training_id) -> TrainingCancelResponse
• replicate.trainings.get(*, training_id) -> TrainingGetResponse

Webhooks

Default

Secret

Types:

from replicate.types.webhooks.default import SecretGetResponse

Methods:

• replicate.webhooks.default.secret.get() -> SecretGetResponse

Files

Types:

from replicate.types import FileCreateResponse, FileListResponse, FileGetResponse