Skip to main content
Replicate logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 33
  • Triggers: 0
  • Slug: REPLICATE
  • Version: 20261101_00

Tools

Slug: REPLICATE_ACCOUNT_GETTool to get authenticated account information. Use when you need to retrieve details about the account associated with the API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_CANCEL_PREDICTIONTool to cancel a prediction that is still running. Use when you need to stop an in-progress prediction to free up resources or halt execution.

Input Parameters

string
required
The ID of the prediction to cancel

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_COLLECTIONS_GETTool to get a specific collection of models by its slug. Use when you need detailed information about a collection and its models.

Input Parameters

string
required
The slug identifier of the collection, e.g., ‘super-resolution’ or ‘text-to-image’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_COLLECTIONS_LISTTool to list all collections of models. Use when you need to retrieve available model collections. Collections are curated groupings of related models. Response includes only collection metadata (name, slug, description), not individual models within each collection; use REPLICATE_MODELS_GET for per-model details. Response may include a non-null next field indicating additional pages; follow it to enumerate all collections.

Input Parameters

string
Cursor for pagination. Use the cursor from ‘next’ URL of previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_CREATE_MODELTool to create a new Replicate model with specified owner, name, visibility, and hardware. Use when you need to create a destination model before launching LoRA/fine-tune training.

Input Parameters

string
required
The name of the model. This must be unique among all models owned by the user or organization.
string
required
The name of the user or organization that will own the model. This must be the same as the user or organization making the API request.
string
required
The SKU for the hardware used to run the model. Possible values can be retrieved from the hardware.list endpoint.
string
A URL for the model’s paper
string
A URL for the model’s source code on GitHub
string
required
Whether the model should be public or private. Public models are viewable and runnable by anyone; private models are restricted to owners.
string
A description of the model
string
A URL for the model’s license
string
A URL for the model’s cover image. This should be an image file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_CREATE_PREDICTIONCreate a prediction for a Replicate Deployment using model inputs. Supports webhook notifications and an optional wait of up to 60 seconds for completion.

Input Parameters

object
required
JSON object of inputs for the model Keys and types must exactly match the deployment model’s schema; consult REPLICATE_MODELS_README_GET or REPLICATE_MODELS_EXAMPLES_LIST first. For file inputs, verify file IDs via REPLICATE_FILES_LIST before submitting.
string
HTTPS URL to receive webhook callbacks
integer
Seconds to wait for prediction completion; adds a ‘Prefer: wait=<n>’ header if provided Valid range is 1–60; if the prediction does not complete within this window, poll for status or use a webhook instead.
string
required
Name of the deployment. NOTE: This is the deployment name, NOT a public model name. Deployments are created via REPLICATE_DEPLOYMENTS_CREATE. To run public models like ‘meta/llama-2-70b-chat’, use REPLICATE_MODELS_PREDICTIONS_CREATE instead
string
required
Username or organization that owns the deployment. NOTE: This is for Replicate Deployments only, NOT public models. Deployments are persistent instances you create and manage separately. To run public models, use REPLICATE_MODELS_PREDICTIONS_CREATE instead
array
List of events to trigger webhook calls

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_DEPLOYMENTS_CREATETool to create a new deployment with specified model, version, hardware, and scaling parameters. Use when you need to deploy a model for production use with auto-scaling.

Input Parameters

string
required
The deployment’s identifier
string
required
Full model name in format owner/name
string
required
The 64-character model version ID to deploy
string
required
Hardware SKU from the hardware.list endpoint
integer
required
Maximum instances for auto-scaling
integer
required
Minimum instances for auto-scaling

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_DEPLOYMENTS_DELETETool to delete a deployment from your account. Use when you need to remove a deployment. Deployments must be offline and unused for at least 15 minutes before deletion.

Input Parameters

string
required
The name of the deployment to delete. Deployment must be offline and unused for at least 15 minutes before deletion.
string
required
The username or organization that owns the deployment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_DEPLOYMENTS_GETTool to get deployment details by owner and name. Use when you need information about a specific deployment including its release configuration and hardware settings.

Input Parameters

string
required
The name of the deployment
string
required
The name of the user or organization that owns the deployment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_DEPLOYMENTS_LISTList deployments associated with the account, including their latest release configurations. Results are paginated; use the next-page cursor to retrieve additional deployments.

Input Parameters

string
Cursor for pagination. Use the cursor from ‘next’ URL of previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_FILES_CREATETool to create or upload a file to Replicate. Use when you need to upload file content with optional metadata.

Input Parameters

object
required
File to upload.
object
User-provided metadata associated with the file (must be valid JSON)
string
The content/MIME type for the file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_FILES_DELETEDelete a file by its ID. Returns a success message, including when the file is already absent.

Input Parameters

string
required
The unique identifier of the file to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_FILES_DOWNLOADDownload a stored file using Replicate’s signed download fields. Replicate documents a limit of 3,000 requests per minute for non-prediction endpoints. Accounts with low credit balances can be throttled more aggressively.

Input Parameters

string
required
The user or organization that owns the file, from the signed download URL.
integer
required
The positive Unix expiry timestamp from the signed download URL.
string
required
The Replicate file ID returned by a file or prediction action.
string
Optional output filename. If omitted, a safe filename is derived from the file ID.
string
required
The base64-encoded HMAC-SHA256 signature from the signed download URL. It is sent unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_FILES_GETTool to get details of a file by its ID. Use when you need to inspect uploaded file information before further operations. Returned URLs may be short-lived; download or persist needed files promptly after retrieval.

Input Parameters

string
required
The ID of the file to retrieve Must originate from a prior upload or prediction output. Use REPLICATE_FILES_LIST to confirm the ID exists before calling this tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_FILES_LISTTool to retrieve a paginated list of uploaded files. Use to view all files created by the authenticated user or organization. Files are sorted with most recent first. Pagination is cursor-based: follow the next cursor until empty to retrieve all files. Limit requests to 1–2/second to avoid 429 Too Many Requests errors. Use to validate current file_ids before passing to prediction tools, as stale file_ids cause runtime errors.

Input Parameters

string
Cursor for pagination. Use the cursor from ‘next’ URL of previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_GET_PREDICTIONTool to get the status and output of a prediction by its ID. Use when you need to check on a running prediction or retrieve the results of a completed prediction.

Input Parameters

string
required
The ID of the prediction to get

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_HARDWARE_LISTTool to list available hardware SKUs for models and deployments. Use when you need to see what hardware options are available on the Replicate platform.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_MODELS_EXAMPLES_LISTList example predictions for a specific model, with cursor-based pagination. Example input or output may be absent if data has been removed.

Input Parameters

string
Cursor for pagination. Use the cursor from ‘next’ URL of previous response.
string
required
The name of the model to list examples for. Must exactly match the Replicate URL slug (case-sensitive).
string
required
The name of the user or organization that owns the model. Must exactly match the Replicate URL slug (case-sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_MODELS_GETGet details of a specific model by owner and name. The latest version and its input/output schema may be included when available.

Input Parameters

string
required
The name of the model, e.g., ‘hello-world’ Must be an exact, case-sensitive Replicate slug (lowercase, hyphenated); e.g., use ‘hello-world’ not ‘Hello World’.
string
required
The username or organization that owns the model, e.g., ‘replicate’ Must be an exact, case-sensitive Replicate slug (lowercase, hyphenated); e.g., use ‘replicate’ not ‘Replicate’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_MODELS_LISTTool to list public models with pagination and sorting. Use when you need to browse available models or find models sorted by creation date.

Input Parameters

string
Pagination cursor for navigating through results. Use the ‘next’ URL from previous responses to fetch the next page of results.
string ("model_created_at" | "latest_version_created_at")
Field to sort models by. Options are ‘model_created_at’ (when model was created) or ‘latest_version_created_at’ (when latest version was created). Defaults to ‘latest_version_created_at’ if not specified.
string ("asc" | "desc")
Sort direction - ‘asc’ for ascending or ‘desc’ for descending. Defaults to ‘desc’ (newest first) if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_MODELS_PREDICTIONS_CREATETool to create a prediction using an official Replicate model. Use when you need to run inference with a specific model using its owner and name. Supports synchronous waiting (up to 60 seconds) and webhooks for async notifications.

Input Parameters

object
required
Model inputs as JSON object. Schema varies by model - each model has its own set of required fields, optional parameters, and validation constraints (e.g., max dimensions for image models). IMPORTANT: Before making predictions, use the REPLICATE_MODELS_GET action to fetch the model’s openapi_schema which contains all valid input parameters and their constraints. For image models like flux-1.1-pro, common constraints include max width/height limits (e.g., 1440px), valid aspect ratios, and output format options
string
HTTPS URL to receive POST requests when prediction updates occur
integer
Seconds to wait for prediction completion (1-60); adds a ‘Prefer: wait=<n>’ header to block and wait synchronously
string
required
The name of the model as it appears on Replicate. Must be an exact match. Find valid model names by searching at replicate.com or using the search/models_list actions. The full model identifier is {model_owner}/{model_name}
string
required
The username or organization that owns the model on Replicate. Find valid owners by searching models at replicate.com or using the search/models_list actions. Examples: ‘meta’, ‘stability-ai’, ‘black-forest-labs’, ‘bytedance’, ‘google’
string
Maximum execution duration with optional unit suffixes (s/m/h); minimum 5 seconds. Example: ’60s’ or ‘5m’
array
Filter webhook triggers by event type: ‘start’, ‘output’, ‘logs’, or ‘completed’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_MODELS_README_GETTool to get the README content for a model in Markdown format. Consult alongside REPLICATE_MODELS_EXAMPLES_LIST before calling REPLICATE_CREATE_PREDICTION — Replicate enforces strict JSON schemas on model inputs and returns 422 errors for incorrect keys or types. Use after retrieving model details when you want to view its documentation.

Input Parameters

string
required
The name of the model, e.g., ‘hello-world’
string
required
The username or organization that owns the model, e.g., ‘replicate’ Must exactly match the Replicate URL slug (case-sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_MODELS_VERSIONS_GETTool to get a specific version of a model. Use when you need details about a particular model version including its schema and metadata.

Input Parameters

string
required
The name of the model, e.g., ‘hello-world’
string
required
The 64-character identifier of the version
string
required
The name of the user or organization that owns the model, e.g., ‘replicate’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_MODELS_VERSIONS_LISTList versions of a specific model, newest first, with cursor-based pagination.

Input Parameters

string
Cursor for pagination. Use the cursor from ‘next’ URL of previous response.
string
required
The name of the model, e.g., ‘hello-world’
string
required
The username or organization that owns the model, e.g., ‘replicate’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_PREDICTIONS_CREATETool to create a prediction to run a model by version ID. Use when you have a specific model version identifier and need to run inference with provided inputs. Supports synchronous waiting and webhook notifications.

Input Parameters

object
required
Model inputs as JSON object. Schema varies by model. Files should be HTTP URLs (for files >256kb or reusable) or data URLs (for files ≤256kb)
boolean
Deprecated. Streaming availability is now included in response urls
string
required
Model version identifier. Accepts formats: {owner}/{name}, {owner}/{name}:{version_id}, or {version_id} alone
string
HTTPS URL to receive POST requests when prediction updates occur. Body mirrors the get prediction response
integer
Seconds (1-60) to hold connection open until model finishes. Adds ‘Prefer: wait=<n>’ header
string
Maximum runtime before automatic cancellation. Accepts durations with optional suffixes (s/m/h). Minimum: 5 seconds. Examples: ’30s’, ‘5m’, ‘1h30m45s’
array
Controls webhook triggers. Options: ‘start’, ‘output’, ‘logs’, ‘completed’. Output/logs events throttled to once per 500ms

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_PREDICTIONS_LISTTool to list all predictions for the authenticated user or organization with pagination. Use when you need to retrieve prediction history or filter predictions by creation date.

Input Parameters

string
Cursor for pagination. Use the cursor from ‘next’ URL of previous response.
string
Include only predictions created at or after this date-time, in ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’). Useful for filtering recent predictions.
string
Include only predictions created before this date-time, in ISO 8601 format (e.g., ‘2024-12-31T23:59:59Z’). Useful for filtering older predictions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_SEARCHTool to search for models, collections, and docs using text queries (beta). Use when you need to find relevant models or collections based on keywords or descriptions.

Input Parameters

integer
Maximum number of model results to return. Must be between 1 and 50. Defaults to 20 if not specified.
string
required
The search query string to execute. Can search across models, collections, and documentation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_TRAININGS_CANCELTool to cancel an ongoing training operation in Replicate. Use when you need to stop a training job that is in progress.

Input Parameters

string
required
The identifier of the training operation to be terminated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_TRAININGS_CREATETool to create a training job for a specific model version. Use when you need to fine-tune a model with custom training data. Supports webhook notifications for training status updates.

Input Parameters

string
required
Name of the model to train
object
required
JSON object containing inputs to the Cog model’s train() function. Schema varies by model
string
required
Name of the user or organization owning the model
string
HTTPS URL to receive POST requests when training updates occur
string
required
The 64-character model version identifier to use for training
string
required
Destination model to push to in format {owner}/{name}
array
List of event types that trigger webhook calls. Options: ‘start’, ‘output’, ‘logs’, ‘completed’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_TRAININGS_GETGet a training’s current state, output, logs, and runtime metrics by ID. Replicate documents a limit of 3,000 requests per minute for non-prediction endpoints and may throttle low-credit accounts more aggressively.

Input Parameters

string
required
The training ID returned by a training create or list action

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_TRAININGS_LISTTool to list all training jobs for the authenticated user or organization with pagination. Use when you need to retrieve training history or check the status of training jobs.

Input Parameters

string
Cursor for pagination. Use the cursor from ‘next’ URL of previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_UPDATE_MODELSUpdate a model’s metadata, including its description, README, and associated URLs.

Input Parameters

string
The README content of the model
string
A URL for the model’s paper
string
A URL for the model’s source code on GitHub
string
required
The name of the model to update
string
A description of the model
string
A URL for the model’s license
string
required
The name of the user or organization that owns the model
string
A URL for the model’s weights

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REPLICATE_WEBHOOKS_SECRET_GETTool to get the signing secret for the default webhook. Use when you need to retrieve the secret key used to verify webhook authenticity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not