Generate Portal Artifacts Async
Start an asynchronous generation of Portal Artifacts by uploading a Portal Build Input. The build input is your build directory (containing the apimatic.json file, your API specification and your content) compressed into a zip file.
An SDK, a code samples catalog and a getting started guide are generated for every language configured in the build input, plus a context plugin when the build input declares one.
The request returns immediately with an id and links to check the status and download the artifacts. Generation must finish within 25 minutes.
Authorization
Authorization Auth Header. Provide your Auth key in the format X-Auth-Key {auth-key}.
In: header
Header Parameters
Optional absolute HTTP or HTTPS URL. When provided, the server sends a POST request to this URL once generation finishes, with the generation status and, on success, the download link.
uriRequest Body
multipart/form-data
The Portal Build Input, uploaded as a zip file in the file form field.
Multipart form data for a Portal Artifacts generation request.
The Portal Build Input as a zip file (maximum 20 MB). The zip file must contain the build directory, including the apimatic.json file.
binaryResponse Body
application/json
application/json
application/json
application/json
application/json
Callbacks
curl -X POST "https://example.com/portal-artifacts" \ -H "X-APIMatic-CallbackUrl: https://example.com/portal-artifacts-callback" \ -F file="string"{ "id": "019992a4-5c3e-7b21-9f0a-3d6e8c1b2a47", "links": { "status": "https://api.apimatic.io/portal-artifacts/019992a4-5c3e-7b21-9f0a-3d6e8c1b2a47/status", "download": "https://api.apimatic.io/portal-artifacts/019992a4-5c3e-7b21-9f0a-3d6e8c1b2a47/download" }}