> For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/llms-full.txt.

# Interface: ApiUploadResponse

Defined in: [core/upload.ts:112](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L112)

Response of `action=upload`.

## Extends

- [`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md)

## Properties

### batchcomplete?

> `optional` **batchcomplete?**: `true`

Defined in: [envelope/index.ts:178](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L178)

Present and `true` when all data for the current batch of pages has been
returned. Continuation may still be ongoing: the generator runs again for
the next batch of pages, and list/meta modules may continue independently.
Serialized as a real boolean under `formatversion=2`.

#### Inherited from

[`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`batchcomplete`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#batchcomplete)

***

### curtimestamp?

> `optional` **curtimestamp?**: `string`

Defined in: [envelope/index.ts:187](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L187)

Current server time (ISO 8601), present when the request set `curtimestamp`.

#### Inherited from

[`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`curtimestamp`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#curtimestamp)

***

### errorlang?

> `optional` **errorlang?**: `string`

Defined in: [envelope/index.ts:199](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L199)

Language error messages are rendered in (`responselanginfo=1`).

#### Inherited from

[`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`errorlang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#errorlang)

***

### requestid?

> `optional` **requestid?**: `string`

Defined in: [envelope/index.ts:190](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L190)

Opaque value echoed back from the request's `requestid` parameter.

#### Inherited from

[`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`requestid`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#requestid)

***

### servedby?

> `optional` **servedby?**: `string`

Defined in: [envelope/index.ts:184](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L184)

Identifier of the server that handled the request. Present by default on
error responses; on successful responses only when explicitly requested.

#### Inherited from

[`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`servedby`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#servedby)

***

### upload

> **upload**: `object`

Defined in: [core/upload.ts:114](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/upload.ts#L114)

Result of `action=upload`.

#### filekey?

> `optional` **filekey?**: `string`

File key when the upload was stashed (`stash=1`) or published from a stash.

#### filename?

> `optional` **filename?**: `string`

Stored file name (spaces underscored).

#### imageinfo?

> `optional` **imageinfo?**: [`ApiUploadImageinfo`](https://types-mediawiki-response.pages.dev/api/core/ApiUploadImageinfo.md)

Imageinfo for the newly stored revision (added only on `Success`).

#### offset?

> `optional` **offset?**: `number`

Chunked-upload byte offset (present on `Continue` results).

#### result

> **result**: `string` & `object` | `"Success"` | `"Failure"` | `"Warning"` | `"Poll"` | `"Continue"`

Outcome of the upload, set by the result builders (`getStashResult`,
`getWarningsResult`, `getChunkResult`, `performUpload`).

#### sessionkey?

> `optional` **sessionkey?**: `string`

Session key mirroring `filekey` on a stashed upload.

#### stage?

> `optional` **stage?**: `string` & `object` | `"queued"` | `"uploading"` | `"assembling"`

Async/chunked stage (present on `Poll`/`Continue` results).

#### warnings?

> `optional` **warnings?**: [`ApiUploadWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiUploadWarnings.md)

Recoverable warnings (distinct from the envelope `warnings`).

***

### uselang?

> `optional` **uselang?**: `string`

Defined in: [envelope/index.ts:196](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L196)

Language of the interface strings in the response (`responselanginfo=1`).

#### Inherited from

[`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`uselang`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#uselang)

***

### warnings?

> `optional` **warnings?**: [`ApiWarnings`](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)

Defined in: [envelope/index.ts:193](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/envelope/index.ts#L193)

Non-fatal warnings; shape depends on `errorformat` (see [ApiWarnings](https://types-mediawiki-response.pages.dev/api/core/ApiWarnings.md)).

#### Inherited from

[`ApiEnvelope`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md).[`warnings`](https://types-mediawiki-response.pages.dev/api/core/ApiEnvelope.md#warnings)
