Intake Upload

Get Link Info

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

link_tokenstring · max: 64Required

Responses

200

Link metadata

application/json

Public metadata for an intake upload link, returned to the forms app.

display_namestring · max: 512Required

Human-readable display name (falls back to customer slug).

customer_slugstring · max: 128Required

Stable URL-safe customer identifier.

max_upload_bytesintegerRequired

Maximum allowed upload size in bytes.

allowed_content_typesstring[] · max: 64Optional

Allowed Content-Type values for uploads, sorted lexicographically.

400

Invalid token

application/json

404

Link not found

application/json

410

Link expired or exhausted

application/json

422

Validation Error

application/json

429

Rate limited

get

/upload/{link_token}/info

HTTPcURLJavaScriptPython

GET /upload/{link_token}/info HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "display_name": "text",
  "customer_slug": "text",
  "max_upload_bytes": 1,
  "allowed_content_types": [
    "text"
  ]
}

Receive Upload

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

link_tokenstring · max: 64Required

Header parameters

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

x-amigo-intake-content-typestring · max: 128Required

Responses

201

File uploaded successfully

application/json

404

Link not found

410

Link expired

413

File too large

422

Invalid filename or content type

429

Rate limited or upload limit reached

503

Upload service unavailable

post

/upload/{link_token}/files

HTTPcURLJavaScriptPython

POST /upload/{link_token}/files HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-amigo-intake-filename: text
x-amigo-intake-content-type: text
Accept: */*

{
  "id": "text",
  "filename": "text",
  "sha256": "text",
  "size_bytes": 1,
  "scan_status": "text",
  "duplicate_of": {
    "id": "text",
    "received_at": "text"
  }
}