APIs.io Engineering Platform Workers AI Finetune API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Workers AI Finetune API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Workers AI Finetune
paths:
  /accounts/{account_id}/ai/finetunes:
    get:
      operationId: workers-ai-list-finetunes
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          example: 023e105f4ecef8ad9ca31a8372d0c353
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      created_at:
                        format: date-time
                        type: string
                      description:
                        type: string
                      id:
                        format: uuid
                        type: string
                      model:
                        type: string
                      modified_at:
                        format: date-time
                        type: string
                      name:
                        type: string
                    required:
                    - id
                    - model
                    - name
                    - created_at
                    - modified_at
                    type: object
                  success:
                    type: boolean
                required:
                - success
                - result
                type: object
          description: Returns all finetunes
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                - result
                - success
                - errors
                type: object
          description: Bad Request
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Finetunes
      tags:
      - Workers AI Finetune
      x-api-token-group:
      - Workers AI Write
      - Workers AI Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      operationId: workers-ai-create-finetune
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          example: 023e105f4ecef8ad9ca31a8372d0c353
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                description:
                  type: string
                model:
                  type: string
                name:
                  type: string
                public:
                  type: boolean
              required:
              - model
              - name
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      created_at:
                        format: date-time
                        type: string
                      description:
                        type: string
                      id:
                        format: uuid
                        type: string
                      model:
                        type: string
                      modified_at:
                        format: date-time
                        type: string
                      name:
                        type: string
                      public:
                        type: boolean
                    required:
                    - id
                    - created_at
                    - modified_at
                    - public
                    - name
                    - model
                    type: object
                  success:
                    type: boolean
                required:
                - success
                - result
                type: object
          description: Returns the created finetune
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: string
                  success:
                    type: boolean
                required:
                - errors
                - success
                type: object
          description: Finetune creation failed
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a new Finetune
      tags:
      - Workers AI Finetune
      x-api-token-group:
      - Workers AI Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/finetunes/{finetune_id}/finetune-assets:
    post:
      operationId: workers-ai-upload-finetune-asset
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          example: 023e105f4ecef8ad9ca31a8372d0c353
          type: string
      - in: path
        name: finetune_id
        required: true
        schema:
          example: bc451aef-f723-4b26-a6b2-901afd2e7a8a
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                file:
                  format: binary
                  type: string
                file_name:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      bucket_name:
                        type: string
                      created_at:
                        format: date-time
                        type: string
                      file_name:
                        type: string
                      finetune_id:
                        example: bc451aef-f723-4b26-a6b2-901afd2e7a8a
                        type: string
                      id:
                        format: uuid
                        type: string
                      modified_at:
                        format: date-time
                        type: string
                    required:
                    - id
                    - finetune_id
                    - file_name
                    - bucket_name
                    - created_at
                    - modified_at
                    type: object
                  success:
                    type: boolean
                required:
                - success
                - result
                type: object
          description: Returns the created finetune asset
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: string
                  success:
                    type: boolean
                required:
                - errors
                - success
                type: object
          description: Finetune creation failed
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Upload a Finetune Asset
      tags:
      - Workers AI Finetune
      x-api-token-group:
      - Workers AI Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/finetunes/public:
    get:
      operationId: workers-ai-list-public-finetunes
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          example: 023e105f4ecef8ad9ca31a8372d0c353
          type: string
      - description: Pagination Limit
        in: query
        name: limit
        schema:
          description: Pagination Limit
          type: number
      - description: Pagination Offset
        in: query
        name: offset
        schema:
          description: Pagination Offset
          type: number
      - description: Order By Column Name
        in: query
        name: orderBy
        schema:
          description: Order By Column Name
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    items:
                      properties:
                        created_at:
                          format: date-time
                          type: string
                        description:
                          type: string
                        id:
                          format: uuid
                          type: string
                        model:
                          type: string
                        modified_at:
                          format: date-time
                          type: string
                        name:
                          type: string
                        public:
                          type: boolean
                      required:
                      - id
                      - model
                      - name
                      - public
                      - created_at
                      - modified_at
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                - success
                - result
                type: object
          description: Returns all public finetunes
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                - result
                - success
                - errors
                type: object
          description: Bad Request
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Public Finetunes
      tags:
      - Workers AI Finetune
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
components:
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true