---
title: "Create upload portal"
method: POST
path: "/api/organizations/{organizationId}/portals/create"
tags: ["OrganizationPortals"]
---

# Create upload portal

`POST /api/organizations/{organizationId}/portals/create`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/create`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/portals/create/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a new upload portal for the organization.

## Path parameters

- `organizationId` integer, required

## Request body

- CreateOrganizationPortalRequest
  - `name` string, required: The name of the upload portal.
  - `description` string: The purpose and description of the upload portal.
  - `bucketId` integer, required: The S3 bucket id to store the uploaded data. Set to '0' to select a bucket hosted by Edge Impulse.
  - `bucketPath` string, required: The path in the bucket the upload portal will write to.

## Response `200`

OK

- CreateOrganizationPortalResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `id` integer, required: Portal ID for the new upload portal
  - `url` string, required: URL to the portal
  - `signedUrl` string: pre-signed upload URL. Only set if using a non-built-in bucket.
  - `bucketBucket` string: Only set if using a non-built-in bucket.

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)