> ## Documentation Index > Fetch the complete documentation index at: https://docs.canary.effectiveai.app/llms.txt > Use this file to discover all available pages before exploring further. # Start a release bundle upload > Get a signed URL to upload a release bundle: the file built from one commit of the app’s source repository that `createAppDeployment` deploys. Uploading changes nothing the app serves. PUT the bundle to the URL within 15 minutes. When this bundle is already stored for this commit, `uploaded` is true and there is nothing to upload. Repeating the request is safe and returns a fresh URL while the bundle is missing. Needs `publish` permission on the app. Build from a branch you pushed to the app’s `source.gitUrl` (see `getApp`), authenticating with your API key. ## OpenAPI ````yaml /openapi.json post /apps/{appId}/release-uploads openapi: 3.0.3 info: title: Effective API version: 2.0.0 description: The public Effective REST API. Authenticate using an Effective API key. servers: - url: https://api.canary.effectiveai.app/api/v2 description: Canary security: - bearerAuth: [] paths: /apps/{appId}/release-uploads: post: tags: - Apps summary: Start a release bundle upload description: >- Get a signed URL to upload a release bundle: the file built from one commit of the app’s source repository that `createAppDeployment` deploys. Uploading changes nothing the app serves. PUT the bundle to the URL within 15 minutes. When this bundle is already stored for this commit, `uploaded` is true and there is nothing to upload. Repeating the request is safe and returns a fresh URL while the bundle is missing. Needs `publish` permission on the app. Build from a branch you pushed to the app’s `source.gitUrl` (see `getApp`), authenticating with your API key. operationId: createAppReleaseUpload parameters: - schema: type: string maxLength: 63 pattern: ^app-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ description: >- App ID: `app-` followed by lowercase letters, digits and hyphens, ending in a letter or digit. It is part of the app’s hostname, so your organization’s subdomain and the ID together must fit 63 characters. required: true description: >- App ID: `app-` followed by lowercase letters, digits and hyphens, ending in a letter or digit. It is part of the app’s hostname, so your organization’s subdomain and the ID together must fit 63 characters. name: appId in: path requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/V2AppReleaseUploadCreate' responses: '200': description: Where to upload the bundle, or that it is already stored. content: application/json: schema: $ref: '#/components/schemas/V2AppReleaseUpload' '400': description: >- Invalid request, or invalid_release with the reason in details[0].message. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '403': description: >- You lack the permission this needs on the app, or are a read-only member. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '404': description: 'app_not_found: missing, archived, or not an app you can open.' content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '409': description: 'app_not_publishable: the app cannot be deployed from a bundle.' content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '413': description: JSON request body exceeds 64 KiB. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '415': description: Content-Type must be application/json. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '503': description: Temporarily unavailable; retry later. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' security: - bearerAuth: [] components: schemas: V2AppReleaseUploadCreate: type: object properties: sourceSha: type: string pattern: ^(?:[0-9a-f]{40}|[0-9a-f]{64})$ description: >- Full commit ID, in lowercase, of the app’s source repository commit the bundle was built from. bundleSha256: type: string pattern: ^[0-9a-f]{64}$ description: Lowercase hex SHA-256 of the release bundle file. bundleSizeBytes: type: integer minimum: 1 maximum: 73400320 description: Exact size of the release bundle file in bytes, at most 70 MiB. required: - sourceSha - bundleSha256 - bundleSizeBytes additionalProperties: false V2AppReleaseUpload: type: object properties: uploaded: type: boolean description: >- True when this bundle is already stored for this commit; `upload` is then null and you can deploy it. upload: type: object nullable: true properties: method: type: string enum: - PUT url: type: string format: uri description: >- Signed URL to PUT the bundle bytes to. Send no Authorization header. headers: type: object properties: Content-Type: type: string enum: - application/json required: - Content-Type additionalProperties: false description: Headers the PUT must send. expiresAt: type: string format: date-time description: When the URL stops accepting the upload. required: - method - url - headers - expiresAt additionalProperties: false description: Where to upload the bundle, or null when it is already stored. required: - uploaded - upload additionalProperties: false V2CodedError: allOf: - $ref: '#/components/schemas/V2Error' - type: object properties: code: type: string minLength: 1 description: Stable error code. Clients must tolerate unknown future codes. details: type: array items: type: object properties: location: type: string enum: - path - query - header - body path: type: array items: type: string maxLength: 64 maxItems: 12 code: type: string enum: - required - invalid_type - invalid_value - unknown_field message: type: string minLength: 1 maxLength: 200 required: - location - path - code - message minItems: 1 maxItems: 20 description: Bounded safe validation issues; may omit some invalid fields. requestId: type: string minLength: 1 maxLength: 128 description: >- Existing server correlation for this HTTP attempt, when available. dataset: type: string enum: - naic - osha description: Dataset needed for dataset_not_enabled. businessCode: type: string description: The rater’s own refusal code, for business_rejection. violations: type: array items: type: object properties: code: type: string description: Authored or built-in constraint code message: type: string description: Authored message for the failed constraint path: type: string description: Input path of the offending value; empty for the request value: nullable: true description: Offending input value, size-bounded by the runtime constraint: type: string description: The constraint the value failed, as text cite: type: string nullable: true description: >- Filing citation of the constraint, when the source cites one required: - code - message - path - value - constraint - cite additionalProperties: false maxItems: 256 description: >- Each input constraint the submission failed, for invalid_inputs and business_rejection. violationsTruncated: type: boolean description: >- True when the rater reported more violations than violations holds. executionId: type: string description: >- The recorded execution of a failed rating, for rater rating failures. accessUrl: type: string nullable: true format: uri description: >- Where to add the product to your account, for product_access_required. required: - code V2Error: type: object properties: error: type: string minLength: 1 description: Human-readable explanation of the failure. required: - error securitySchemes: bearerAuth: type: http scheme: bearer description: 'Effective API key. Send Authorization: Bearer sk-eai-...' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.