Get Portal Artifacts Generation Status
Get the status of a Portal Artifacts generation request.
While generation is running or after it has failed, this endpoint returns 200 with the current status. Once generation completes, it returns a 302 redirect to the download endpoint. HTTP clients that follow redirects automatically will receive the artifacts zip file directly.
Authorization
Authorization Auth Header. Provide your Auth key in the format X-Auth-Key {auth-key}.
In: header
Path Parameters
The id returned by Generate Portal Artifacts Async.
uuidResponse Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/portal-artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/status"{ "status": "ValidationError", "errors": { "buildFile": [ "the build file is not a readable zip archive" ] }}Generate Portal Artifacts Async POST
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.
Download Generated Portal Artifacts GET
Download the generated Portal Artifacts as a zip file. The zip file contains: 1. `sdk/<language>.zip`: the SDK for each configured language 2. `code-samples/<language>.json`: the code samples catalog for each configured language 3. `docs/<language>.json`: the getting started guide for each configured language 4. `plugin.zip`: the context plugin, only when the build input declares one The artifacts are available only after generation completes. Until then, this endpoint returns `400`.