openapi: 3.2.0
info:
  title: AutoGPT Agent Server Transfers API
  summary: AutoGPT Agent Server
  description: This server is used to execute agents that are created by the AutoGPT system.
  version: '0.1'
tags:
- name: Transfers
paths:
  /api/transfers:
    get:
      tags:
      - Transfers
      summary: List transfers for active organization
      operationId: getV2ListTransfersForActiveOrganization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/TransferResponse'
                type: array
                title: Response Getv2List Transfers For Active Organization
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
      security:
      - HTTPBearerJWT: []
      x-operation-id-source: normalized
      x-operation-id-original: getV2List transfers for active organization
    post:
      tags:
      - Transfers
      summary: Create transfer request
      operationId: postV2CreateTransferRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTransferRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferResponse'
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearerJWT: []
      x-operation-id-source: normalized
      x-operation-id-original: postV2Create transfer request
  /api/transfers/{transfer_id}/approve:
    post:
      tags:
      - Transfers
      summary: Approve transfer request
      operationId: postV2ApproveTransferRequest
      security:
      - HTTPBearerJWT: []
      parameters:
      - name: transfer_id
        in: path
        required: true
        schema:
          type: string
          title: Transfer Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferResponse'
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-operation-id-source: normalized
      x-operation-id-original: postV2Approve transfer request
  /api/transfers/{transfer_id}/execute:
    post:
      tags:
      - Transfers
      summary: Execute approved transfer
      operationId: postV2ExecuteApprovedTransfer
      security:
      - HTTPBearerJWT: []
      parameters:
      - name: transfer_id
        in: path
        required: true
        schema:
          type: string
          title: Transfer Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferResponse'
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-operation-id-source: normalized
      x-operation-id-original: postV2Execute approved transfer
  /api/transfers/{transfer_id}/reject:
    post:
      tags:
      - Transfers
      summary: Reject transfer request
      operationId: postV2RejectTransferRequest
      security:
      - HTTPBearerJWT: []
      parameters:
      - name: transfer_id
        in: path
        required: true
        schema:
          type: string
          title: Transfer Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferResponse'
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-operation-id-source: normalized
      x-operation-id-original: postV2Reject transfer request
components:
  responses:
    HTTP401NotAuthenticatedError:
      description: Authentication required
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
  schemas:
    CreateTransferRequest:
      properties:
        resource_type:
          type: string
          title: Resource Type
        resource_id:
          type: string
          title: Resource Id
        target_organization_id:
          type: string
          title: Target Organization Id
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
      type: object
      required:
      - resource_type
      - resource_id
      - target_organization_id
      title: CreateTransferRequest
    TransferResponse:
      properties:
        id:
          type: string
          title: Id
        resource_type:
          type: string
          title: Resource Type
        resource_id:
          type: string
          title: Resource Id
        source_organization_id:
          type: string
          title: Source Organization Id
        target_organization_id:
          type: string
          title: Target Organization Id
        initiated_by_user_id:
          type: string
          title: Initiated By User Id
        status:
          type: string
          title: Status
        source_approved_by_user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Approved By User Id
        target_approved_by_user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Approved By User Id
        completed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completed At
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
      - id
      - resource_type
      - resource_id
      - source_organization_id
      - target_organization_id
      - initiated_by_user_id
      - status
      - source_approved_by_user_id
      - target_approved_by_user_id
      - completed_at
      - reason
      - created_at
      title: TransferResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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:
    APIKeyAuthenticator-X-Postmark-Webhook-Token:
      type: apiKey
      in: header
      name: X-Postmark-Webhook-Token
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBearerJWT:
      type: http
      scheme: bearer
      bearerFormat: jwt