Uploads

Complete an upload session and register a source_file artifact

post/api/artifact-uploads/{upload_id}/complete

Request

  • Base URL: https://courseprofiler.com
  • URL: https://courseprofiler.com/api/artifact-uploads/{upload_id}/complete
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer
    • none

Path parameters

upload_idstring required

Request body

Response

Uploaded file registered as an artifact

request_idstring

Current HTTP request correlation ID, also X-Request-Id; not an idempotency key.

artifact_idstring required
type'source_file' | 'crsprof' | 'usrprof' | 'pdf' | 'json' | 'diagnostics' required
content_typestring required
file_namestring
size_bytesinteger
download_urlstring uri

Private pre-signed URL. May be omitted for expired artifacts.

download_url_expires_atstring date-time
created_atstring date-time required
expires_atstring date-time required
metadataobject

Example response

{
  "artifact_id": "art_01JABCDEF",
  "content_type": "application/vnd.courseprof+json",
  "warnings": [
    {
      "code": "missing_elevation"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.