# town.delve.video.getUploadStatus

> Published by [delve.town](https://lexicon.garden/identity/did:plc:qzqct2rrq4u2gmy5g3mjxske)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.video.getUploadStatus)
- [Documentation](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.video.getUploadStatus/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.video.getUploadStatus/examples)

## Definitions

### `town.delve.video.getUploadStatus`

**Type**: `query`

Get the authoritative status of the upload phase. Terminal states remain readable. completedJobId and jobStatus are present only for completed sessions; failureReason is present only for failed sessions.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `jobId` | `string` | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `completedJobId` | `string` | No | Present only when state is completed; may differ from jobId on deduplication. |
| `expiresAt` | `string` (datetime) | Yes |  |
| `failureReason` | `string` | No | Present only when state is failed. |
| `jobId` | `string` | Yes |  |
| `jobStatus` | `ref` → `town.delve.video.defs#jobStatus` | No | Present only when state is completed. |
| `partCount` | `integer` | Yes |  |
| `partSizeBytes` | `integer` | Yes |  |
| `receivedParts` | `array` | Yes |  |
| `state` | `string` | Yes |  |

#### Errors

- **UploadNotFound**: The job ID is unknown or aged out of retention; known terminal sessions remain readable and are never reported as not found.

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get the authoritative status of the upload phase. Terminal states remain readable. completedJobId and jobStatus are present only for completed sessions; failureReason is present only for failed sessions.",
      "errors": [
        {
          "description": "The job ID is unknown or aged out of retention; known terminal sessions remain readable and are never reported as not found.",
          "name": "UploadNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "completedJobId": {
              "description": "Present only when state is completed; may differ from jobId on deduplication.",
              "maxLength": 256,
              "minLength": 1,
              "type": "string"
            },
            "expiresAt": {
              "format": "datetime",
              "type": "string"
            },
            "failureReason": {
              "description": "Present only when state is failed.",
              "maxLength": 1024,
              "type": "string"
            },
            "jobId": {
              "maxLength": 256,
              "minLength": 1,
              "type": "string"
            },
            "jobStatus": {
              "description": "Present only when state is completed.",
              "ref": "town.delve.video.defs#jobStatus",
              "type": "ref"
            },
            "partCount": {
              "type": "integer"
            },
            "partSizeBytes": {
              "type": "integer"
            },
            "receivedParts": {
              "items": {
                "minimum": 1,
                "type": "integer"
              },
              "type": "array"
            },
            "state": {
              "knownValues": [
                "created",
                "finishing",
                "completed",
                "failed",
                "aborted",
                "expired"
              ],
              "maxLength": 32,
              "type": "string"
            }
          },
          "required": [
            "jobId",
            "partSizeBytes",
            "partCount",
            "receivedParts",
            "expiresAt",
            "state"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "jobId": {
            "maxLength": 256,
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [
          "jobId"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "town.delve.video.getUploadStatus",
  "lexicon": 1
}
```