Intake

Receive Intake File

post

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Header parameters

x-amigo-intake-sha256string · max: 64Required

x-amigo-intake-timestampstring · max: 20Required

x-amigo-intake-signaturestring · max: 512Required

x-amigo-intake-customer-slugstring · max: 63Required

x-amigo-intake-filenamestring · max: 256Required

x-amigo-intake-content-typestring · max: 128OptionalDefault: application/octet-stream

Responses

201

Successful Response

application/json

idstring · uuidRequired

volume_pathstringRequired

sha256stringRequired

size_bytesintegerRequired

scan_statusstringRequired

422

Validation Error

application/json

post

/v1/{workspace_id}/intake/files

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/intake/files HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-amigo-intake-sha256: text
x-amigo-intake-timestamp: text
x-amigo-intake-signature: text
x-amigo-intake-customer-slug: text
x-amigo-intake-filename: text
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "volume_path": "text",
  "sha256": "text",
  "size_bytes": 1,
  "scan_status": "text"
}

List upload links

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Query parameters

include_expiredbooleanOptionalDefault: false

limitinteger · min: 1 · max: 500OptionalDefault: 100

offsetintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/{workspace_id}/intake/links

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/intake/links HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "customer_slug": "text",
    "display_name": "text",
    "upload_url": "text",
    "link_token": "text",
    "status": "active",
    "created_at": "2026-05-12T12:44:04.973Z",
    "expires_at": "2026-05-12T12:44:04.973Z",
    "revoked_at": "2026-05-12T12:44:04.973Z",
    "max_uploads": 1,
    "upload_count": 1,
    "last_upload_at": "2026-05-12T12:44:04.973Z"
  }
]

Generate upload link

post

Create a shareable upload link for a customer.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

customer_slugstring · min: 2 · max: 63RequiredPattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$

display_nameany ofOptional

string · max: 2000Optional

or

nullOptional

expires_in_hoursinteger · min: 1 · max: 720OptionalDefault: 168

max_uploadsinteger · min: 1 · max: 10000OptionalDefault: 100

Responses

201

Successful Response

application/json

idstring · uuidRequired

workspace_idstring · uuidRequired

customer_slugstring · min: 2 · max: 63RequiredPattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$

display_nameany ofRequired

string · min: 1 · max: 256Optional

or

nullOptional

upload_urlstring · max: 512Required

link_tokenstring · min: 32 · max: 128Required

statusstring · enumRequiredPossible values:

created_atstring · date-timeRequired

expires_atstring · date-timeRequired

revoked_atany ofRequired

string · date-timeOptional

or

nullOptional

max_uploadsintegerRequired

upload_countintegerRequired

last_upload_atany ofRequired

string · date-timeOptional

or

nullOptional

422

Validation Error

application/json

post

/v1/{workspace_id}/intake/links

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/intake/links HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "customer_slug": "text",
  "display_name": "text",
  "expires_in_hours": 168,
  "max_uploads": 100
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "customer_slug": "text",
  "display_name": "text",
  "upload_url": "text",
  "link_token": "text",
  "status": "active",
  "created_at": "2026-05-12T12:44:04.973Z",
  "expires_at": "2026-05-12T12:44:04.973Z",
  "revoked_at": "2026-05-12T12:44:04.973Z",
  "max_uploads": 1,
  "upload_count": 1,
  "last_upload_at": "2026-05-12T12:44:04.973Z"
}

Revoke upload link

delete

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

link_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/v1/{workspace_id}/intake/links/{link_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/intake/links/{link_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List uploads for a link

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

link_idstring · uuidRequired

Query parameters

limitinteger · min: 1 · max: 500OptionalDefault: 200

offsetintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/{workspace_id}/intake/links/{link_id}/uploads

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/intake/links/{link_id}/uploads HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "customer_slug": "text",
    "filename": "text",
    "content_type": "text",
    "sha256": "text",
    "size_bytes": 1,
    "received_at": "2026-05-12T12:44:04.973Z",
    "scan_status": "skipped"
  }
]

Download an uploaded file

get

Proxy the raw file bytes from the UC Volume back to the caller.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

link_idstring · uuidRequired

upload_idstring · uuidRequired

Responses

200

File bytes with Content-Disposition: attachment

application/octet-stream

404

Link, upload, or file not found

422

Validation Error

application/json

502

UC Volume storage backend unavailable

get

/v1/{workspace_id}/intake/links/{link_id}/uploads/{upload_id}/download

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/intake/links/{link_id}/uploads/{upload_id}/download HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary