APIs.io Engineering Platform Workers AI 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 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
paths:
  /accounts/{account_id}/ai/authors/search:
    get:
      operationId: workers-ai-search-author
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          example: 023e105f4ecef8ad9ca31a8372d0c353
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      type: object
                    type: array
                  messages:
                    items:
                      type: object
                    type: array
                  result:
                    items:
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                - success
                - result
                - errors
                - messages
                type: object
          description: Returns a list of authors
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    type: string
                  success:
                    type: boolean
                required:
                - success
                - error
                type: object
          description: Object not found
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Author Search
      tags:
      - Workers AI
      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
  /accounts/{account_id}/ai/models/schema:
    get:
      operationId: workers-ai-get-model-schema
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          example: 023e105f4ecef8ad9ca31a8372d0c353
          type: string
      - description: Model Name
        in: query
        name: model
        required: true
        schema:
          description: Model Name
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                - success
                - result
                type: object
          description: Model Schema
        '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 Get Model Schema
      tags:
      - Workers AI
      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
  /accounts/{account_id}/ai/models/search:
    get:
      operationId: workers-ai-search-model
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          example: 023e105f4ecef8ad9ca31a8372d0c353
          type: string
      - in: query
        name: per_page
        schema:
          type: integer
      - in: query
        name: page
        schema:
          type: integer
      - description: Filter by Task Name
        in: query
        name: task
        schema:
          description: Filter by Task Name
          example: Text Generation
          type: string
      - description: Filter by Author
        in: query
        name: author
        schema:
          description: Filter by Author
          type: string
      - description: Filter by Source Id
        in: query
        name: source
        schema:
          description: Filter by Source Id
          type: number
      - description: Filter to hide experimental models
        in: query
        name: hide_experimental
        schema:
          description: Filter to hide experimental models
          type: boolean
      - description: Search
        in: query
        name: search
        schema:
          description: Search
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      type: object
                    type: array
                  messages:
                    items:
                      type: object
                    type: array
                  result:
                    items:
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                - success
                - result
                - errors
                - messages
                type: object
          description: Returns a list of models
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    type: string
                  success:
                    type: boolean
                required:
                - success
                - error
                type: object
          description: Object not found
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Model Search
      tags:
      - Workers AI
      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
  /accounts/{account_id}/ai/run/{model_name}:
    post:
      description: 'This endpoint provides users with the capability to run specific AI models on-demand.


        By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI

        model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases.


        Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).'
      operationId: workers-ai-post-run-model
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          example: 023e105f4ecef8ad9ca31a8372d0c353
          type: string
      - in: path
        name: model_name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - properties:
                  text:
                    minLength: 1
                    type: string
                required:
                - text
                title: Text Classification
                type: object
              - properties:
                  guidance:
                    default: 7.5
                    type: number
                  height:
                    maximum: 2048
                    minimum: 256
                    type: integer
                  image:
                    items:
                      type: number
                    type: array
                  image_b64:
                    type: string
                  mask:
                    items:
                      type: number
                    type: array
                  negative_prompt:
                    type: string
                  num_steps:
                    default: 20
                    maximum: 20
                    type: integer
                  prompt:
                    minLength: 1
                    type: string
                  seed:
                    type: integer
                  strength:
                    default: 1
                    type: number
                  width:
                    maximum: 2048
                    minimum: 256
                    type: integer
                required:
                - prompt
                title: Text To Image
                type: object
              - properties:
                  text:
                    oneOf:
                    - minLength: 1
                      type: string
                    - items:
                        minLength: 1
                        type: string
                      maxItems: 100
                      type: array
                required:
                - text
                title: Text Embeddings
                type: object
              - oneOf:
                - format: binary
                  type: string
                - properties:
                    audio:
                      items:
                        type: number
                      type: array
                    source_lang:
                      type: string
                    target_lang:
                      type: string
                  required:
                  - audio
                  type: object
                title: Automatic Speech Recognition
                type: object
              - oneOf:
                - format: binary
                  type: string
                - properties:
                    image:
                      items:
                        type: number
                      type: array
                  required:
                  - image
                  type: object
                title: Image Classification
                type: object
              - oneOf:
                - format: binary
                  type: string
                - properties:
                    image:
                      items:
                        type: number
                      type: array
                  type: object
                title: Object Detection
                type: object
              - oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9999999999.0
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                  - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                        - name
                        - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                        - role
                        - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9999999999.0
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                        - properties:
                            description:
                              type: string
                            name:
                              type: string
                            parameters:
                              properties:
                                properties:
                                  additionalProperties:
                                    properties:
                                      description:
                                        type: string
                                      type:
                                        type: string
                                    required:
                                    - type
                                    - description
                                    type: object
                                  type: object
                                required:
                                  items:
                                    type: string
                                  type: array
                                type:
                                  type: string
                              required:
                              - type
                              - properties
                              type: object
                          required:
                          - name
                          - description
                          - parameters
                        - properties:
                            function:
                              properties:
                                description:
                                  type: string
                                name:
                                  type: string
                                parameters:
                                  properties:
                                    properties:
                                      additionalProperties:
                                        properties:
                                          description:
                                            type: string
                                          type:
                                            type: string
                                        required:
                                        - type
                                        - description
                                        type: object
                                      type: object
                                    required:
                                      items:
                                        type: string
                                      type: array
                                    type:
                                      type: string
                                  required:
                                  - type
                                  - properties
                                  type: object
                              required:
                              - name
                              - description
                              - parameters
                              type: object
                            type:
                              type: string
                          required:
                          - type
                          - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                  - messages
                title: Text Generation
                type: object
              - properties:
                  source_lang:
                    default: en
                    type: string
                  target_lang:
                    type: string
                  text:
                    minLength: 1
                    type: string
                required:
                - text
                - target_lang
                title: Translation
                type: object
              - properties:
                  input_text:
                    minLength: 1
                    type: string
                  max_length:
                    default: 1024
                    type: integer
                required:
                - input_text
                title: Summarization
                type: object
              - oneOf:
                - format: binary
                  type: string
                - not:
                    required:
                    - prompt
                    - messages
                  properties:
                    image:
                      oneOf:
                      - items:
                          type: number
                        type: array
                      - format: binary
                        type: string
                    max_tokens:
                      default: 512
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 6144
                            type: string
                          role:
                            type: string
                        required:
                        - role
                        - content
                        type: object
                      type: array
                    prompt:
                      type: string
                    raw:
                      default: false
                      type: boolean
                    temperature:
                      type: number
                  required:
                  - image
                  type: object
                title: Image To Text
                type: object
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    oneOf:
                    - items:
                        properties:
                          label:
                            type: string
                          score:
                            type: number
                        type: object
                      title: Text Classification
                      type: array
                    - format: binary
                      title: Text To Image
                      type: string
                    - properties:
                        data:
                          items:
                            items:
                              type: number
                            type: array
                          type: array
                        shape:
                          items:
                            type: number
                          type: array
                      title: Text Embeddings
                      type: object
                    - properties:
                        text:
                          type: string
                        vtt:
                          type: string
                        word_count:
                          type: number
                        words:
                          items:
                            properties:
                              end:
                                type: number
                              start:
                                type: number
                              word:
                                type: string
                            type: object
                          type: array
                      required:
                      - text
                      title: Automatic Speech Recognition
                      type: object
                    - items:
                        properties:
                          label:
                            type: string
                          score:
                            type: number
                        type: object
                      title: Image Classification
                      type: array
                    - items:
                        properties:
                          box:
                            properties:
                              xmax:
                                type: number
                              xmin:
                                type: number
                              ymax:
                                type: number
                              ymin:
                                type: number
                            type: object
                          label:
                            type: string
                          score:
                            type: number
                        type: object
                      title: Object Detection
                      type: array
                    - oneOf:
                      - properties:
                          response:
                            type: string
                          tool_calls:
                            items:
                              properties:
                                arguments:
                                  type: object
                                name:
                                  type: string
                              type: object
                            type: array
                        type: object
                      - format: binary
                        type: string
                      title: Text Generation
                      type: object
                    - properties:
                        translated_text:
                          type: string
                      title: Translation
                      type: object
                    - properties:
                        summary:
                          type: string
                      title: Summarization
                      type: object
                    - properties:
                        description:
                          type: string
                      title: Image To Text
                      type: object
                    type: object
                type: object
          description: Model response
        '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 Execute AI model
      tags:
      - Workers AI
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/tasks/search:
    get:
      operationId: workers-ai-search-task
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          example: 023e105f4ecef8ad9ca31a8372d0c353
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      type: object
                    type: array
                  messages:
                    items:
                      type: object
                    type: array
                  result:
                    items:
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                - success
                - result
                - errors
                - messages
                type: object
          description: Returns a list of tasks
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    type: string
                  success:
                    type: boolean
                required:
                - success
                - error
                type: object
          description: Object not found
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Task Search
      tags:
      - Workers AI
      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
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