imagecaption-api/openapi.yaml at main · apiverve/imagecaption-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
openapi: 3.0.4
info:
  title: Image Caption
  description: >-
    Image Caption is an AI-powered tool that generates descriptive captions for
    images. Simply upload an image and receive a natural language description of
    its contents.
  termsOfService: https://apiverve.com/terms/
  contact:
    name: APIVerve Support
    email: hello@apiverve.com
    url: https://apiverve.com/contact
  version: 1.0.0
externalDocs:
  description: Learn more about APIVerve
  url: https://docs.apiverve.com?utm_source=openapi
servers:
  - url: https://api.apiverve.com/
paths:
  /v1/imagecaption:
    post:
      summary: Caption Image
      description: >-
        Image Caption is an AI-powered tool that generates descriptive captions
        for images. Simply upload an image and receive a natural language
        description of its contents.
      operationId: imagecaption
      parameters: []
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: status
                  error:
                    type: string
                    description: error
                  data:
                    type: object
                    description: data
              example:
                status: ok
                error: null
                data:
                  caption: >-
                    A golden retriever running through a grassy field on a sunny
                    day
        '401':
          description: Your request was not authorized, or your API Key was invalid
        '404':
          description: Requested resource was not found
        '500':
          description: A server error has occurred, try again later
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                image:
                  type: string
                  format: binary
                  description: 'File to upload (accepted: .jpg, .jpeg, .png, .gif, max 5MB)'
                  acceptedTypes:
                    - .jpg
                    - .jpeg
                    - .png
                    - .gif
                  maxSizeMB: 5
              required:
                - image
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: x-api-key
      in: header
security:
  - api_key: []
sampleRequest:
  image: >-
    https://upload.wikimedia.org/wikipedia/commons/thumb/3/3a/Cat03.jpg/640px-Cat03.jpg