---
title: "Upload a file for a submission, a post or a quiz answer"
description: "The upload session API, as the calling person. With content_base64 the file is stored and scanned at once and its file_id returned. Without it a session is opened: PUT the bytes to put.url, then complete the session; the address goes straight to object storage where the deployment uses it.\n\n### Quire permissions\n\nCredential scopes: `me:write`.\n\nThe acting subject must also be allowed to perform this action in the organisation."
image: "https://docs.quirelms.com/og.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.quirelms.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Quire API › me

`POST /me/uploads`

The upload session API, as the calling person. With content_base64 the file is stored and scanned at once and its file_id returned. Without it a session is opened: PUT the bytes to put.url, then complete the session; the address goes straight to object storage where the deployment uses it.

\### Quire permissions

Credential scopes: `me:write`.

The acting subject must also be allowed to perform this action in the organisation.

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`, scopes: `me:write`
- `oauth2`, oauth2, scopes: `me:write`

## Header parameters

- `uploadMyFile.header.Quire-Version` (string, optional) — The dated API revision to serve this request at. Omitted, the request is served at the revision the credential was issued against. The response echoes the revision actually applied.
  - format `date`
- `uploadMyFile.header.Idempotency-Key` (string, optional) — A caller-chosen key making this request safe to retry. A replay of a completed request returns the recorded response with `Idempotency-Replayed: true`. Reusing a key for a different request is refused.
  - maxLength 255

## Request body

_Required._

- `uploadMyFile.course_id` (string, required)
  - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`
- `uploadMyFile.purpose` (string, required) — What the file is for, which decides who may upload it.
  - one of `"assignment_submission"`, `"forum_post"`, `"quiz_response"`
- `uploadMyFile.activity_id` (string, required) — The assignment, forum or quiz activity.
  - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`
- `uploadMyFile.name` (string, required)
  - minLength 1; maxLength 255
- `uploadMyFile.mime_type` (string, required)
  - minLength 3; maxLength 255
- `uploadMyFile.size` (integer, required) — The size in bytes.
  - min 0; max 9007199254740991
- `uploadMyFile.attempt_id` (string, optional) — For a quiz response: the attempt.
  - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`
- `uploadMyFile.slot_number` (integer, optional) — For a quiz response: the question slot.
  - min 1; max 32767
- `uploadMyFile.content_base64` (string, optional) — The file itself, for a file under about 3 MB. Larger files leave this out, PUT the bytes to the returned address and complete the session.
  - maxLength 4000000

## Example request

```json
{
  "course_id": "5e757794-c815-4ccc-bf16-1010d8ef2347",
  "purpose": "assignment_submission",
  "activity_id": "98dae057-958f-4b2f-9ed4-41f109afdc3f",
  "attempt_id": "7a838dca-3ea8-4a7c-8133-ba2c86aeb22d",
  "slot_number": 1,
  "name": "string",
  "mime_type": "string",
  "size": 9007199254740991,
  "content_base64": "string"
}
```

## Code samples

### cURL

```curl
curl --request POST \
  --url https://your-organisation.quirelms.com/api/v1/me/uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "course_id": "5e757794-c815-4ccc-bf16-1010d8ef2347",
  "purpose": "assignment_submission",
  "activity_id": "98dae057-958f-4b2f-9ed4-41f109afdc3f",
  "attempt_id": "7a838dca-3ea8-4a7c-8133-ba2c86aeb22d",
  "slot_number": 1,
  "name": "string",
  "mime_type": "string",
  "size": 9007199254740991,
  "content_base64": "string"
}
'
```

### TypeScript

```typescript
const url = 'https://your-organisation.quirelms.com/api/v1/me/uploads';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    course_id: '5e757794-c815-4ccc-bf16-1010d8ef2347',
    purpose: 'assignment_submission',
    activity_id: '98dae057-958f-4b2f-9ed4-41f109afdc3f',
    attempt_id: '7a838dca-3ea8-4a7c-8133-ba2c86aeb22d',
    slot_number: 1,
    name: 'string',
    mime_type: 'string',
    size: 9007199254740991,
    content_base64: 'string'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://your-organisation.quirelms.com/api/v1/me/uploads"

payload = {
    "course_id": "5e757794-c815-4ccc-bf16-1010d8ef2347",
    "purpose": "assignment_submission",
    "activity_id": "98dae057-958f-4b2f-9ed4-41f109afdc3f",
    "attempt_id": "7a838dca-3ea8-4a7c-8133-ba2c86aeb22d",
    "slot_number": 1,
    "name": "string",
    "mime_type": "string",
    "size": 9007199254740991,
    "content_base64": "string"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 201

Success.

#### Example

```json
{
  "session_id": "string",
  "state": "pending",
  "file_id": "string",
  "name": "string",
  "mime_type": "string",
  "size": -9007199254740991,
  "expires_at": "string",
  "put": {
    "url": "string",
    "method": "string",
    "headers": {
      "property1": "string",
      "property2": "string"
    }
  },
  "multipart_upload_id": "string",
  "part_count": -9007199254740991
}
```

- `uploadMyFile.response.201.session_id` (string | null, required)
- `uploadMyFile.response.201.state` (string, required)
  - one of `"pending"`, `"committed"`
- `uploadMyFile.response.201.file_id` (string | null, required)
- `uploadMyFile.response.201.name` (string, required)
- `uploadMyFile.response.201.mime_type` (string, required)
- `uploadMyFile.response.201.size` (integer, required)
  - min -9007199254740991; max 9007199254740991
- `uploadMyFile.response.201.expires_at` (string | null, required)
- `uploadMyFile.response.201.put` (any of, required)
  - any of: `object`, `null`
- `uploadMyFile.response.201.multipart_upload_id` (string | null, required)
- `uploadMyFile.response.201.part_count` (any of, required)
  - any of: `integer`, `null`

### 401

The credential is missing, malformed, expired or revoked.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `uploadMyFile.response.401.type` (string, required)
  - format `uri`
- `uploadMyFile.response.401.title` (string, required)
- `uploadMyFile.response.401.status` (integer, required)
- `uploadMyFile.response.401.code` (string, required)
- `uploadMyFile.response.401.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `uploadMyFile.response.401.detail` (string, required)
- `uploadMyFile.response.401.request_id` (string, required)
- `uploadMyFile.response.401.docs_url` (string, required)
  - format `uri`
- `uploadMyFile.response.401.errors` (array<object>, optional)
  - `uploadMyFile.response.401.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `uploadMyFile.response.401.errors.code` (string, required)
  - `uploadMyFile.response.401.errors.detail` (string, required)
- `uploadMyFile.response.401.retry_after` (integer | null, optional)

### 403

The credential lacks the scope this operation requires, or the acting subject lacks the capability.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `uploadMyFile.response.403.type` (string, required)
  - format `uri`
- `uploadMyFile.response.403.title` (string, required)
- `uploadMyFile.response.403.status` (integer, required)
- `uploadMyFile.response.403.code` (string, required)
- `uploadMyFile.response.403.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `uploadMyFile.response.403.detail` (string, required)
- `uploadMyFile.response.403.request_id` (string, required)
- `uploadMyFile.response.403.docs_url` (string, required)
  - format `uri`
- `uploadMyFile.response.403.errors` (array<object>, optional)
  - `uploadMyFile.response.403.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `uploadMyFile.response.403.errors.code` (string, required)
  - `uploadMyFile.response.403.errors.detail` (string, required)
- `uploadMyFile.response.403.retry_after` (integer | null, optional)

### 409

The request conflicts with the current state, with a previous use of the same idempotency key, or with a concurrent write.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `uploadMyFile.response.409.type` (string, required)
  - format `uri`
- `uploadMyFile.response.409.title` (string, required)
- `uploadMyFile.response.409.status` (integer, required)
- `uploadMyFile.response.409.code` (string, required)
- `uploadMyFile.response.409.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `uploadMyFile.response.409.detail` (string, required)
- `uploadMyFile.response.409.request_id` (string, required)
- `uploadMyFile.response.409.docs_url` (string, required)
  - format `uri`
- `uploadMyFile.response.409.errors` (array<object>, optional)
  - `uploadMyFile.response.409.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `uploadMyFile.response.409.errors.code` (string, required)
  - `uploadMyFile.response.409.errors.detail` (string, required)
- `uploadMyFile.response.409.retry_after` (integer | null, optional)

### 422

The request was understood and its content is not valid. `errors` names each field.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `uploadMyFile.response.422.type` (string, required)
  - format `uri`
- `uploadMyFile.response.422.title` (string, required)
- `uploadMyFile.response.422.status` (integer, required)
- `uploadMyFile.response.422.code` (string, required)
- `uploadMyFile.response.422.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `uploadMyFile.response.422.detail` (string, required)
- `uploadMyFile.response.422.request_id` (string, required)
- `uploadMyFile.response.422.docs_url` (string, required)
  - format `uri`
- `uploadMyFile.response.422.errors` (array<object>, optional)
  - `uploadMyFile.response.422.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `uploadMyFile.response.422.errors.code` (string, required)
  - `uploadMyFile.response.422.errors.detail` (string, required)
- `uploadMyFile.response.422.retry_after` (integer | null, optional)

### 429

A rate limit or a concurrency cap was reached. `Retry-After` says when to try again.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `uploadMyFile.response.429.type` (string, required)
  - format `uri`
- `uploadMyFile.response.429.title` (string, required)
- `uploadMyFile.response.429.status` (integer, required)
- `uploadMyFile.response.429.code` (string, required)
- `uploadMyFile.response.429.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `uploadMyFile.response.429.detail` (string, required)
- `uploadMyFile.response.429.request_id` (string, required)
- `uploadMyFile.response.429.docs_url` (string, required)
  - format `uri`
- `uploadMyFile.response.429.errors` (array<object>, optional)
  - `uploadMyFile.response.429.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `uploadMyFile.response.429.errors.code` (string, required)
  - `uploadMyFile.response.429.errors.detail` (string, required)
- `uploadMyFile.response.429.retry_after` (integer | null, optional)

### 500

Something failed at our end. Quote `request_id` when reporting it.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `uploadMyFile.response.500.type` (string, required)
  - format `uri`
- `uploadMyFile.response.500.title` (string, required)
- `uploadMyFile.response.500.status` (integer, required)
- `uploadMyFile.response.500.code` (string, required)
- `uploadMyFile.response.500.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `uploadMyFile.response.500.detail` (string, required)
- `uploadMyFile.response.500.request_id` (string, required)
- `uploadMyFile.response.500.docs_url` (string, required)
  - format `uri`
- `uploadMyFile.response.500.errors` (array<object>, optional)
  - `uploadMyFile.response.500.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `uploadMyFile.response.500.errors.code` (string, required)
  - `uploadMyFile.response.500.errors.detail` (string, required)
- `uploadMyFile.response.500.retry_after` (integer | null, optional)


Source: https://docs.quirelms.com/api/me/uploadMyFile/index.md