Inference Logoinference.sh

Running Apps

Execute AI apps on inference.sh.


Basic Usage

typescript
1import { inference } from '@inferencesh/sdk';23const client = inference({ apiKey: 'inf_your_key' });45const result = await client.run({6  app: 'infsh/flux',7  input: { prompt: 'A sunset over mountains' }8});910console.log('Task ID:', result.id);11console.log('Output:', result.output);

Parameters

ParameterTypeDescription
appstringApp identifier
inputobjectInput matching app schema
setupobjectSetup parameters
infra'cloud' | 'private'Infrastructure
variantstringApp variant

Request Type

typescript
1interface ApiTaskRequest {2  app: string;3  input: object;4  setup?: object;5  infra?: 'cloud' | 'private';6  variant?: string;7  workers?: string[];8}

Setup Parameters

typescript
1const result = await client.run({2  app: 'infsh/flux',3  setup: { model: 'schnell' },4  input: { prompt: 'A sunset' }5});

Private Workers

typescript
1const result = await client.run({2  app: 'my-team/my-app',3  input: {...},4  infra: 'private',5  workers: ['worker-id-1']6});

Task Status Constants

typescript
1import {2  TaskStatusQueued,      // 23  TaskStatusRunning,     // 74  TaskStatusCompleted,   // 95  TaskStatusFailed,      // 106  TaskStatusCancelled    // 117} from '@inferencesh/sdk';89if (task.status === TaskStatusCompleted) {10  console.log('Done!');11}

we use cookies

we use cookies to ensure you get the best experience on our website. for more information on how we use cookies, please see our cookie policy.

by clicking "accept", you agree to our use of cookies.
learn more.