Activeloop Organization API

openapi: 3.2.0
info:
  title: Fast Organization API
  version: 0.1.0
tags:
- name: Organization
paths:
  /api/organizations/my:
    get:
      tags:
      - Organization
      summary: Get My Organizations
      description: Get the organization of a user.
      operationId: get_my_organizations_api_organizations_my_get
      security:
      - HTTPBearer: []
      parameters:
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/organizations/{id}:
    get:
      tags:
      - Organization
      summary: Get Organization
      description: Get an organization by id.
      operationId: get_organization_api_organizations__id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          title: Id
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Organization
      summary: Update Org
      description: Updates an organization.
      operationId: update_org_api_organizations__id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          title: Id
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/organizations/{organization_id}/remove-member:
    post:
      tags:
      - Organization
      summary: Remove User From Organization
      description: Removes a user from the organization.
      operationId: remove_user_from_organization_api_organizations__organization_id__remove_member_post
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationRemoveMemberModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/organizations/{org_id}/invite-member:
    post:
      tags:
      - Organization
      summary: Invite Member To Org
      description: Invite a member to an organization.
      operationId: invite_member_to_org_api_organizations__org_id__invite_member_post
      security:
      - HTTPBearer: []
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
          title: Org Id
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationInviteMemberModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/organizations/{organization_id}/members:
    get:
      tags:
      - Organization
      summary: Get Organization Members
      description: Get the members of an organization.
      operationId: get_organization_members_api_organizations__organization_id__members_get
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/organizations:
    post:
      tags:
      - Organization
      summary: Create Organization
      description: Creates a new organization.
      operationId: create_organization_api_organizations_post
      security:
      - HTTPBearer: []
      parameters:
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationCreateModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationDataModel'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/organizations/{organization_id}/availability:
    get:
      tags:
      - Organization
      summary: Check Organization Availability
      description: Checks if an organization ID is available.
      operationId: check_organization_availability_api_organizations__organization_id__availability_get
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/organizations/{organization_id}:
    delete:
      tags:
      - Organization
      summary: Delete Organization
      description: Delete an organization.
      operationId: delete_organization_api_organizations__organization_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/organizations/{organization_id}/permissions:
    put:
      tags:
      - Organization
      summary: Update Member Permissions
      description: Change permissions for an organization.
      operationId: update_member_permissions_api_organizations__organization_id__permissions_put
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/organizations/{organization_id}/leave:
    post:
      tags:
      - Organization
      summary: Leave Organization
      description: Leave the organization.
      operationId: leave_organization_api_organizations__organization_id__leave_post
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/organizations/{organization_id}/storage/increment:
    put:
      tags:
      - Organization
      summary: Increment Storage Usage
      description: Add organization storage usage.
      operationId: increment_storage_usage_api_organizations__organization_id__storage_increment_put
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationStorageIncrementModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    OrganizationCreateModel:
      properties:
        id:
          type: string
          maxLength: 34
          minLength: 1
          pattern: ^[a-z0-9]+(?:[-_][a-z0-9]+)*$
          title: Id
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
      type: object
      required:
      - id
      title: OrganizationCreateModel
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OrganizationDataModel:
      properties:
        _id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
        uuid:
          type: string
          format: uuid
          title: Uuid
        name:
          type: string
          title: Name
        repositories:
          items:
            type: string
          type: array
          title: Repositories
          default: []
        plan:
          anyOf:
          - $ref: '#/components/schemas/OrganizationPlanDataModel'
          - type: 'null'
        users:
          items:
            type: string
          type: array
          title: Users
          default: []
        creator:
          type: string
          title: Creator
          default: ''
        about:
          anyOf:
          - type: string
          - type: 'null'
          title: About
        avatar:
          anyOf:
          - type: string
          - type: 'null'
          title: Avatar
        member_count:
          type: integer
          title: Member Count
          default: 0
        name_space:
          anyOf:
          - type: string
            maxLength: 56
            minLength: 5
          - type: 'null'
          title: Name Space
        analytics_enabled:
          type: boolean
          title: Analytics Enabled
          default: true
        stripe_customer_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Stripe Customer Id
        demo_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Demo Type
        storage_usage:
          anyOf:
          - $ref: '#/components/schemas/OrganizationStorageUsageDataModel'
          - type: 'null'
      type: object
      required:
      - name
      title: OrganizationDataModel
      example:
        about: ''
        avatar: ''
        creator: ''
        id: public
        name: public
        repositories:
        - private/public
        - public/public
        - protected/public
        users:
        - public
    ApiVersion:
      type: string
      enum:
      - '2024-02-10'
      - '2024-10-01'
      title: ApiVersion
    OrganizationStorageUsageDataModel:
      properties:
        size_raw:
          type: integer
          title: Size Raw
        size_deep_lake:
          type: integer
          title: Size Deep Lake
      type: object
      required:
      - size_raw
      - size_deep_lake
      title: OrganizationStorageUsageDataModel
    OrganizationInviteMemberModel:
      properties:
        username:
          anyOf:
          - type: string
          - type: string
            format: email
          title: Username
        access_mode:
          $ref: '#/components/schemas/OrganizationAccessMode'
      type: object
      required:
      - username
      - access_mode
      title: OrganizationInviteMemberModel
    OrganizationStorageIncrementModel:
      properties:
        size_raw:
          type: integer
          title: Size Raw
        size_deep_lake:
          type: integer
          title: Size Deep Lake
      type: object
      required:
      - size_raw
      - size_deep_lake
      title: OrganizationStorageIncrementModel
    OrganizationPlanDataModel:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        price_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Price Id
        product_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Product Id
        customer_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Customer Id
        subscription_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Subscription Id
        current_period_start:
          anyOf:
          - type: integer
          - type: 'null'
          title: Current Period Start
        current_period_end:
          anyOf:
          - type: integer
          - type: 'null'
          title: Current Period End
        cancel_at_period_end:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Cancel At Period End
        cancel_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: Cancel At
      type: object
      required:
      - id
      - name
      title: OrganizationPlanDataModel
      example:
        cancel_at: 1722978215
        cancel_at_period_end: true
        current_period_end: 1741894918
        current_period_start: 1739475718
        customer_id: user1234
        id: an_id
        name: Alex
        price_id: pri_1234
        product_id: pro_1234
        subscription_id: sub_12345
    OrganizationAccessMode:
      type: string
      enum:
      - requested
      - contributor
      - read
      - write
      - admin
      title: OrganizationAccessMode
    OrganizationRemoveMemberModel:
      properties:
        username:
          type: string
          title: Username
      type: object
      required:
      - username
      title: OrganizationRemoveMemberModel
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Activeloop
  source: https://app.activeloop.ai/api/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)