Components

Finalize component upload and trigger processing

Triggers processing of a component after client has uploaded to storage via presigned URL.

put/api/v0/components/{component_id}/upload-url

Request

Base URL
https://api.outerport.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/outerport/apis/outerport-api/docs/api/v0/components/:component_id/upload-url/put.ts
A function with typed inputs. Its response is checked against the schema.

component_idstring required

upload_urlstring required

The upload URL that was used

filenamestring nullable

Original filename to preserve

include_descriptionboolean

Whether to include description

baseline_modeboolean

Use baseline mode

detectboolean

For schematic components: run symbol detection on the uploaded image instead of starting from an empty canvas

configobject nullable

Optional config for schematic components

Successful Response

job_status_idstring uuid required

The ID of the job status

statusstring required

The status of the job

error_messagestring nullable required

The error message if the job failed

component_idstring uuid required

The ID of the component

Sep 25, 2026fcd15f6d35b4 Revision changes
- warning
  removed the request property
- warning
  removed the request property