# Tasks

## Start

`client.agent.tasks.start(TaskStartParamsbody, RequestOptionsoptions?): TaskStartResponse`

**post** `/agent/tasks`

Starts an agent task and returns a task_id immediately.

### Parameters

- `body: TaskStartParams`

  - `agent_type?: string`

  - `environment_id?: string`

  - `instruction?: string`

  - `kind?: "desktop" | "browser"`

    - `"desktop"`

    - `"browser"`

  - `max_steps?: number`

  - `model?: string`

  - `persistent?: boolean`

  - `screenshot_mode?: "url" | "base64"`

    - `"url"`

    - `"base64"`

  - `temperature?: number`

  - `viewport_height?: number`

  - `viewport_width?: number`

### Returns

- `TaskStartResponse`

  - `status?: string`

  - `task_id?: string`

### Example

```typescript
import Lightcone from '@tzafon/lightcone';

const client = new Lightcone({
  apiKey: process.env['TZAFON_API_KEY'], // This is the default and can be omitted
});

const response = await client.agent.tasks.start();

console.log(response.task_id);
```

## Start Stream

`client.agent.tasks.startStream(TaskStartStreamParamsbody, RequestOptionsoptions?): TaskStartStreamResponse | Stream<TaskStartStreamResponse>`

**post** `/agent/tasks/stream`

Starts an agent task and streams events via SSE (Content-Type: text/event-stream).

### Parameters

- `body: TaskStartStreamParams`

  - `agent_type?: string`

  - `environment_id?: string`

  - `instruction?: string`

  - `kind?: "desktop" | "browser"`

    - `"desktop"`

    - `"browser"`

  - `max_steps?: number`

  - `model?: string`

  - `persistent?: boolean`

  - `screenshot_mode?: "url" | "base64"`

    - `"url"`

    - `"base64"`

  - `temperature?: number`

  - `viewport_height?: number`

  - `viewport_width?: number`

### Returns

- `TaskStartStreamResponse = string`

### Example

```typescript
import Lightcone from '@tzafon/lightcone';

const client = new Lightcone({
  apiKey: process.env['TZAFON_API_KEY'], // This is the default and can be omitted
});

const response = await client.agent.tasks.startStream();

console.log(response);
```

## Retrieve Status

`client.agent.tasks.retrieveStatus(stringid, RequestOptionsoptions?): TaskRetrieveStatusResponse`

**get** `/agent/tasks/{id}`

Returns the current status/result for a task.

### Parameters

- `id: string`

### Returns

- `TaskRetrieveStatusResponse`

  - `exit_code?: number`

  - `status?: string`

  - `task_id?: string`

### Example

```typescript
import Lightcone from '@tzafon/lightcone';

const client = new Lightcone({
  apiKey: process.env['TZAFON_API_KEY'], // This is the default and can be omitted
});

const response = await client.agent.tasks.retrieveStatus('id');

console.log(response.task_id);
```

## Inject Message

`client.agent.tasks.injectMessage(stringid, TaskInjectMessageParamsbody, RequestOptionsoptions?): TaskInjectMessageResponse`

**post** `/agent/tasks/{id}/messages`

Injects a message into a running agent task.

### Parameters

- `id: string`

- `body: TaskInjectMessageParams`

  - `message?: string`

### Returns

- `TaskInjectMessageResponse`

  - `status?: string`

### Example

```typescript
import Lightcone from '@tzafon/lightcone';

const client = new Lightcone({
  apiKey: process.env['TZAFON_API_KEY'], // This is the default and can be omitted
});

const response = await client.agent.tasks.injectMessage('id');

console.log(response.status);
```

## Pause

`client.agent.tasks.pause(stringid, RequestOptionsoptions?): TaskPauseResponse`

**post** `/agent/tasks/{id}/pause`

Pauses a running agent task.

### Parameters

- `id: string`

### Returns

- `TaskPauseResponse`

  - `status?: string`

### Example

```typescript
import Lightcone from '@tzafon/lightcone';

const client = new Lightcone({
  apiKey: process.env['TZAFON_API_KEY'], // This is the default and can be omitted
});

const response = await client.agent.tasks.pause('id');

console.log(response.status);
```

## Resume

`client.agent.tasks.resume(stringid, RequestOptionsoptions?): TaskResumeResponse`

**post** `/agent/tasks/{id}/resume`

Resumes a paused agent task.

### Parameters

- `id: string`

### Returns

- `TaskResumeResponse`

  - `status?: string`

### Example

```typescript
import Lightcone from '@tzafon/lightcone';

const client = new Lightcone({
  apiKey: process.env['TZAFON_API_KEY'], // This is the default and can be omitted
});

const response = await client.agent.tasks.resume('id');

console.log(response.status);
```