API - Corsair

Every replicate.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Account

get

account.get Get authenticated account information Risk: read

await corsair.replicate.api.account.get({});

Input: empty object Output

Name	Type	Required	Description
`username`	`string`	Yes	—
`name`	`string`	No	—
`type`	`user \| organization`	Yes	—
`avatar_url`	`string`	No	—
`github_url`	`string`	No	—

Collections

get

collections.get Get model collection details by slug Risk: read

await corsair.replicate.api.collections.get({});

Input

Name	Type	Required	Description
`collectionSlug`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`slug`	`string`	Yes	—
`description`	`string`	Yes	—
`full_description`	`string`	No	—
`models`	`object[]`	No	—

models full type

{
  owner: string,
  name: string,
  description?: string | null,
  visibility?: public | private,
  url?: string,
  github_url?: string | null,
  paper_url?: string | null,
  license_url?: string | null,
  cover_image_url?: string | null,
  run_count?: number,
  is_official?: boolean,
  default_example?: any | null,
  latest_version?: any | null
}[]

list

collections.list List model collections Risk: read

await corsair.replicate.api.collections.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string`	No	—
`previous`	`string`	No	—
`results`	`object[]`	Yes	—

results full type

{
  name: string,
  slug: string,
  description: string
}[]

Deployments

create

deployments.create Create a deployment Risk: write

await corsair.replicate.api.deployments.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`model`	`string`	Yes	—
`version`	`string`	Yes	—
`hardware`	`string`	Yes	—
`min_instances`	`number`	Yes	—
`max_instances`	`number`	Yes	—

Output

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—
`current_release`	`object`	No	—

current_release full type

{
  number?: number,
  model?: string,
  version?: string,
  created_at?: string | string,
  configuration?: {
    hardware?: string,
    min_instances?: number,
    max_instances?: number
  }
}

delete

deployments.delete Delete a deployment Risk: destructive

await corsair.replicate.api.deployments.delete({});

Input

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`true`	Yes	—

get

deployments.get Get deployment details Risk: read

await corsair.replicate.api.deployments.get({});

Input

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—
`current_release`	`object`	No	—

current_release full type

{
  number?: number,
  model?: string,
  version?: string,
  created_at?: string | string,
  configuration?: {
    hardware?: string,
    min_instances?: number,
    max_instances?: number
  }
}

list

deployments.list List deployments Risk: read

await corsair.replicate.api.deployments.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string`	No	—
`previous`	`string`	No	—
`results`	`object[]`	Yes	—

results full type

{
  owner: string,
  name: string,
  current_release?: {
    number?: number,
    model?: string,
    version?: string,
    created_at?: string | string,
    configuration?: {
      hardware?: string,
      min_instances?: number,
      max_instances?: number
    }
  }
}[]

predictionsCreate

deployments.predictionsCreate Create a prediction from deployment Risk: write

await corsair.replicate.api.deployments.predictionsCreate({});

Input

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—
`input`	`object`	Yes	—
`stream`	`boolean`	No	—
`webhook`	`string`	No	—
`webhook_events_filter`	`start \| output \| logs \| completed[]`	No	—
`prefer`	`string`	No	—
`cancelAfter`	`string`	No	—

input full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`starting \| processing \| succeeded \| failed \| canceled \| aborted`	Yes	—
`model`	`string`	No	—
`version`	`string`	No	—
`deployment`	`string`	No	—
`input`	`object`	No	—
`output`	`any`	No	—
`error`	`string`	No	—
`logs`	`string`	No	—
`source`	`api \| web`	No	—
`data_removed`	`boolean`	No	—
`created_at`	`string \| string`	No	—
`started_at`	`string \| string`	No	—
`completed_at`	`string \| string`	No	—
`deadline`	`string \| string`	No	—
`metrics`	`object`	No	—
`urls`	`object`	No	—

input full type

{
}

metrics full type

{
}

urls full type

{
  get?: string,
  cancel?: string,
  web?: string,
  stream?: string
}

Files

create

files.create Upload a file Risk: write

await corsair.replicate.api.files.create({});

Input

Name	Type	Required	Description
`content`	`any`	Yes	—
`filename`	`string`	No	—
`type`	`string`	No	—
`metadata`	`object`	No	—

metadata full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`content_type`	`string`	Yes	—
`size`	`number`	Yes	—
`checksums`	`object`	Yes	—
`metadata`	`object`	Yes	—
`created_at`	`string \| string`	Yes	—
`expires_at`	`string \| string`	Yes	—
`urls`	`object`	Yes	—

checksums full type

{
  sha256?: string
}

metadata full type

{
}

urls full type

{
  get: string
}

delete

files.delete Delete a file Risk: destructive

await corsair.replicate.api.files.delete({});

Input

Name	Type	Required	Description
`fileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`success`	`true`	Yes	—

get

files.get Get file details Risk: read

await corsair.replicate.api.files.get({});

Input

Name	Type	Required	Description
`fileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`content_type`	`string`	Yes	—
`size`	`number`	Yes	—
`checksums`	`object`	Yes	—
`metadata`	`object`	Yes	—
`created_at`	`string \| string`	Yes	—
`expires_at`	`string \| string`	Yes	—
`urls`	`object`	Yes	—

checksums full type

{
  sha256?: string
}

metadata full type

{
}

urls full type

{
  get: string
}

list

files.list List uploaded files Risk: read

await corsair.replicate.api.files.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string`	No	—
`previous`	`string`	No	—
`results`	`object[]`	Yes	—

results full type

{
  id: string,
  content_type: string,
  size: number,
  checksums: {
    sha256?: string
  },
  metadata: {
  },
  created_at: string | string,
  expires_at: string | string,
  urls: {
    get: string
  }
}[]

Hardware

list

hardware.list List available hardware SKUs Risk: read

await corsair.replicate.api.hardware.list({});

Input: empty object Output: object[]

Output full type

{
  sku: string,
  name: string
}[]

Models

examplesList

models.examplesList List model examples Risk: read

await corsair.replicate.api.models.examplesList({});

Input

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string`	No	—
`previous`	`string`	No	—
`results`	`object[]`	Yes	—

results full type

{
  id: string,
  status: starting | processing | succeeded | failed | canceled | aborted,
  model?: string,
  version?: string,
  deployment?: string,
  input?: {
  },
  output?: any,
  error?: string | null,
  logs?: string,
  source?: api | web,
  data_removed?: boolean,
  created_at?: string | string,
  started_at?: string | string | null,
  completed_at?: string | string | null,
  deadline?: string | string,
  metrics?: {
  },
  urls?: {
    get?: string,
    cancel?: string,
    web?: string,
    stream?: string
  }
}[]

get

models.get Get model details Risk: read

await corsair.replicate.api.models.get({});

Input

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`string`	No	—
`visibility`	`public \| private`	No	—
`url`	`string`	No	—
`github_url`	`string`	No	—
`paper_url`	`string`	No	—
`license_url`	`string`	No	—
`cover_image_url`	`string`	No	—
`run_count`	`number`	No	—
`is_official`	`boolean`	No	—
`default_example`	`any`	No	—
`latest_version`	`any`	No	—

list

models.list List public models Risk: read

await corsair.replicate.api.models.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`sort_by`	`model_created_at \| latest_version_created_at`	No	—
`sort_direction`	`asc \| desc`	No	—

Output

Name	Type	Required	Description
`next`	`string`	No	—
`previous`	`string`	No	—
`results`	`object[]`	Yes	—

results full type

{
  owner: string,
  name: string,
  description?: string | null,
  visibility?: public | private,
  url?: string,
  github_url?: string | null,
  paper_url?: string | null,
  license_url?: string | null,
  cover_image_url?: string | null,
  run_count?: number,
  is_official?: boolean,
  default_example?: any | null,
  latest_version?: any | null
}[]

predictionsCreate

models.predictionsCreate Create official model prediction Risk: write

await corsair.replicate.api.models.predictionsCreate({});

Input

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—
`input`	`object`	Yes	—
`stream`	`boolean`	No	—
`webhook`	`string`	No	—
`webhook_events_filter`	`start \| output \| logs \| completed[]`	No	—
`prefer`	`string`	No	—
`cancelAfter`	`string`	No	—

input full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`starting \| processing \| succeeded \| failed \| canceled \| aborted`	Yes	—
`model`	`string`	No	—
`version`	`string`	No	—
`deployment`	`string`	No	—
`input`	`object`	No	—
`output`	`any`	No	—
`error`	`string`	No	—
`logs`	`string`	No	—
`source`	`api \| web`	No	—
`data_removed`	`boolean`	No	—
`created_at`	`string \| string`	No	—
`started_at`	`string \| string`	No	—
`completed_at`	`string \| string`	No	—
`deadline`	`string \| string`	No	—
`metrics`	`object`	No	—
`urls`	`object`	No	—

input full type

{
}

metrics full type

{
}

urls full type

{
  get?: string,
  cancel?: string,
  web?: string,
  stream?: string
}

readmeGet

models.readmeGet Get model README Risk: read

await corsair.replicate.api.models.readmeGet({});

Input

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—

Output: string

update

models.update Update model metadata Risk: write

await corsair.replicate.api.models.update({});

Input

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`string`	No	—
`readme`	`string`	No	—
`github_url`	`string`	No	—
`paper_url`	`string`	No	—
`weights_url`	`string`	No	—
`license_url`	`string`	No	—

Output

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`string`	No	—
`visibility`	`public \| private`	No	—
`url`	`string`	No	—
`github_url`	`string`	No	—
`paper_url`	`string`	No	—
`license_url`	`string`	No	—
`cover_image_url`	`string`	No	—
`run_count`	`number`	No	—
`is_official`	`boolean`	No	—
`default_example`	`any`	No	—
`latest_version`	`any`	No	—

versionsGet

models.versionsGet Get model version Risk: read

await corsair.replicate.api.models.versionsGet({});

Input

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—
`versionId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`created_at`	`string \| string`	Yes	—
`cog_version`	`string`	No	—
`openapi_schema`	`any`	No	—

versionsList

models.versionsList List model versions Risk: read

await corsair.replicate.api.models.versionsList({});

Input

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string`	No	—
`previous`	`string`	No	—
`results`	`object[]`	Yes	—

results full type

{
  id: string,
  created_at: string | string,
  cog_version?: string | null,
  openapi_schema?: any | null
}[]

Predictions

cancel

predictions.cancel Cancel prediction Risk: write

await corsair.replicate.api.predictions.cancel({});

Input

Name	Type	Required	Description
`predictionId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`starting \| processing \| succeeded \| failed \| canceled \| aborted`	Yes	—
`model`	`string`	No	—
`version`	`string`	No	—
`deployment`	`string`	No	—
`input`	`object`	No	—
`output`	`any`	No	—
`error`	`string`	No	—
`logs`	`string`	No	—
`source`	`api \| web`	No	—
`data_removed`	`boolean`	No	—
`created_at`	`string \| string`	No	—
`started_at`	`string \| string`	No	—
`completed_at`	`string \| string`	No	—
`deadline`	`string \| string`	No	—
`metrics`	`object`	No	—
`urls`	`object`	No	—

input full type

{
}

metrics full type

{
}

urls full type

{
  get?: string,
  cancel?: string,
  web?: string,
  stream?: string
}

create

predictions.create Create prediction by version Risk: write

await corsair.replicate.api.predictions.create({});

Input

Name	Type	Required	Description
`input`	`object`	Yes	—
`stream`	`boolean`	No	—
`webhook`	`string`	No	—
`webhook_events_filter`	`start \| output \| logs \| completed[]`	No	—
`prefer`	`string`	No	—
`cancelAfter`	`string`	No	—
`version`	`string`	Yes	—

input full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`starting \| processing \| succeeded \| failed \| canceled \| aborted`	Yes	—
`model`	`string`	No	—
`version`	`string`	No	—
`deployment`	`string`	No	—
`input`	`object`	No	—
`output`	`any`	No	—
`error`	`string`	No	—
`logs`	`string`	No	—
`source`	`api \| web`	No	—
`data_removed`	`boolean`	No	—
`created_at`	`string \| string`	No	—
`started_at`	`string \| string`	No	—
`completed_at`	`string \| string`	No	—
`deadline`	`string \| string`	No	—
`metrics`	`object`	No	—
`urls`	`object`	No	—

input full type

{
}

metrics full type

{
}

urls full type

{
  get?: string,
  cancel?: string,
  web?: string,
  stream?: string
}

get

predictions.get Get prediction status Risk: read

await corsair.replicate.api.predictions.get({});

Input

Name	Type	Required	Description
`predictionId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`starting \| processing \| succeeded \| failed \| canceled \| aborted`	Yes	—
`model`	`string`	No	—
`version`	`string`	No	—
`deployment`	`string`	No	—
`input`	`object`	No	—
`output`	`any`	No	—
`error`	`string`	No	—
`logs`	`string`	No	—
`source`	`api \| web`	No	—
`data_removed`	`boolean`	No	—
`created_at`	`string \| string`	No	—
`started_at`	`string \| string`	No	—
`completed_at`	`string \| string`	No	—
`deadline`	`string \| string`	No	—
`metrics`	`object`	No	—
`urls`	`object`	No	—

input full type

{
}

metrics full type

{
}

urls full type

{
  get?: string,
  cancel?: string,
  web?: string,
  stream?: string
}

list

predictions.list List predictions Risk: read

await corsair.replicate.api.predictions.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`created_after`	`string`	No	—
`created_before`	`string`	No	—
`source`	`web`	No	—

Output

Name	Type	Required	Description
`next`	`string`	No	—
`previous`	`string`	No	—
`results`	`object[]`	Yes	—

results full type

{
  id: string,
  status: starting | processing | succeeded | failed | canceled | aborted,
  model?: string,
  version?: string,
  deployment?: string,
  input?: {
  },
  output?: any,
  error?: string | null,
  logs?: string,
  source?: api | web,
  data_removed?: boolean,
  created_at?: string | string,
  started_at?: string | string | null,
  completed_at?: string | string | null,
  deadline?: string | string,
  metrics?: {
  },
  urls?: {
    get?: string,
    cancel?: string,
    web?: string,
    stream?: string
  }
}[]

Search

search

search.search Search models, collections, and docs Risk: read

await corsair.replicate.api.search.search({});

Input

Name	Type	Required	Description
`query`	`string`	Yes	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`query`	`string`	Yes	—
`models`	`object[]`	Yes	—
`collections`	`object[]`	Yes	—
`pages`	`object[]`	Yes	—

models full type

{
  model: {
    owner: string,
    name: string,
    description?: string | null,
    visibility?: public | private,
    url?: string,
    github_url?: string | null,
    paper_url?: string | null,
    license_url?: string | null,
    cover_image_url?: string | null,
    run_count?: number,
    is_official?: boolean,
    default_example?: any | null,
    latest_version?: any | null
  },
  metadata: {
  }
}[]

collections full type

{
  slug: string,
  name: string
}[]

pages full type

{
  title?: string
}[]

Trainings

cancel

trainings.cancel Cancel training job Risk: write

await corsair.replicate.api.trainings.cancel({});

Input

Name	Type	Required	Description
`trainingId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`starting \| processing \| succeeded \| failed \| canceled \| aborted`	Yes	—
`model`	`string`	No	—
`version`	`string`	No	—
`input`	`object`	No	—
`output`	`object`	No	—
`error`	`string`	No	—
`logs`	`string`	No	—
`source`	`api \| web`	No	—
`created_at`	`string \| string`	No	—
`started_at`	`string \| string`	No	—
`completed_at`	`string \| string`	No	—
`urls`	`object`	No	—
`metrics`	`object`	No	—

input full type

{
}

output full type

{
  version?: string,
  weights?: string
}

urls full type

{
  get?: string,
  cancel?: string,
  web?: string,
  stream?: string
}

metrics full type

{
}

create

trainings.create Create training job Risk: write

await corsair.replicate.api.trainings.create({});

Input

Name	Type	Required	Description
`owner`	`string`	Yes	—
`name`	`string`	Yes	—
`versionId`	`string`	Yes	—
`destination`	`string`	Yes	—
`input`	`object`	Yes	—
`webhook`	`string`	No	—
`webhook_events_filter`	`start \| output \| logs \| completed[]`	No	—

input full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`starting \| processing \| succeeded \| failed \| canceled \| aborted`	Yes	—
`model`	`string`	No	—
`version`	`string`	No	—
`input`	`object`	No	—
`output`	`object`	No	—
`error`	`string`	No	—
`logs`	`string`	No	—
`source`	`api \| web`	No	—
`created_at`	`string \| string`	No	—
`started_at`	`string \| string`	No	—
`completed_at`	`string \| string`	No	—
`urls`	`object`	No	—
`metrics`	`object`	No	—

input full type

{
}

output full type

{
  version?: string,
  weights?: string
}

urls full type

{
  get?: string,
  cancel?: string,
  web?: string,
  stream?: string
}

metrics full type

{
}

get

trainings.get Get training job details Risk: read

await corsair.replicate.api.trainings.get({});

Input

Name	Type	Required	Description
`trainingId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`starting \| processing \| succeeded \| failed \| canceled \| aborted`	Yes	—
`model`	`string`	No	—
`version`	`string`	No	—
`input`	`object`	No	—
`output`	`object`	No	—
`error`	`string`	No	—
`logs`	`string`	No	—
`source`	`api \| web`	No	—
`created_at`	`string \| string`	No	—
`started_at`	`string \| string`	No	—
`completed_at`	`string \| string`	No	—
`urls`	`object`	No	—
`metrics`	`object`	No	—

input full type

{
}

output full type

{
  version?: string,
  weights?: string
}

urls full type

{
  get?: string,
  cancel?: string,
  web?: string,
  stream?: string
}

metrics full type

{
}

list

trainings.list List training jobs Risk: read

await corsair.replicate.api.trainings.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`next`	`string`	No	—
`previous`	`string`	No	—
`results`	`object[]`	Yes	—

results full type

{
  id: string,
  status: starting | processing | succeeded | failed | canceled | aborted,
  model?: string,
  version?: string,
  input?: {
  },
  output?: {
    version?: string,
    weights?: string
  },
  error?: string | null,
  logs?: string,
  source?: api | web,
  created_at?: string | string,
  started_at?: string | string | null,
  completed_at?: string | string | null,
  urls?: {
    get?: string,
    cancel?: string,
    web?: string,
    stream?: string
  },
  metrics?: {
  }
}[]

Webhooks

defaultSecretGet

webhooks.defaultSecretGet Get default webhook signing secret Risk: read

await corsair.replicate.api.webhooks.defaultSecretGet({});

Input: empty object Output

Name	Type	Required	Description
`key`	`string`	Yes	—

​Account

​get

​Collections

​get

​list

​Deployments

​create

​delete

​get

​list

​predictionsCreate

​Files

​create

​delete

​get

​list

​Hardware

​list

​Models

​examplesList

​get

​list

​predictionsCreate

​readmeGet

​update

​versionsGet

​versionsList

​Predictions

​cancel

​create

​get

​list

​Search

​search

​Trainings

​cancel

​create

​get

​list

​Webhooks

​defaultSecretGet

Account

get

Collections

get

list

Deployments

create

delete

get

list

predictionsCreate

Files

create

delete

get

list

Hardware

list

Models

examplesList

get

list

predictionsCreate

readmeGet

update

versionsGet

versionsList

Predictions

cancel

create

get

list

Search

search

Trainings

cancel

create

get

list

Webhooks

defaultSecretGet