Create or get a subject

POST

/subjects

Idempotent on externalId: if a (non-deleted) subject with this
externalId already exists for your account, it is returned
unchanged (200); otherwise a new one is created (201).

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The existing subject for this externalId.

Bodyapplication/json

🟢201Created

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠413

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://upload.tf/api/v1/subjects' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "externalId": "string",
    "label": "string",
    "metadata": {}
}'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
        "externalId": "string",
        "label": "string",
        "metadata": {},
        "status": "active",
        "moderationStatus": "active",
        "moderationReason": "string",
        "moderatedAt": "2019-08-24T14:15:22.123Z",
        "moderatedBy": "b1839e93-100b-450d-9645-6c473b4f81cf",
        "tokensRevokedAfter": "2019-08-24T14:15:22.123Z",
        "storageCapBytes": 0,
        "maxPages": 0,
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2026-08-18 09:08:48

List subjects

Get a subject