The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

OVID / OpenAPI-Client-OpenAI-0.21 / lib / OpenAPI / Client / OpenAI / Path / uploads-upload_id-complete.pod 

            

              
—
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

              
=encoding utf8
=head1 NAME
OpenAPI::Client::OpenAI::Path::uploads-upload_id-complete - Documentation for the /uploads/{upload_id}/complete path.
=head1 DESCRIPTION
This document describes the API endpoint at C</uploads/{upload_id}/complete>.
=head1 PATHS
=head2 C<POST /uploads/{upload_id}/complete>
Completes the L<Upload|https://platform.openai.com/docs/api-reference/uploads/object>. 
Within the returned Upload object, there is a nested L<File|https://platform.openai.com/docs/api-reference/files/object> object that is ready to use in the rest of the platform.
You can specify the order of the Parts by passing in an ordered list of the Part IDs.
The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
=head3 Operation ID
C<completeUpload>
    $client->completeUpload( ... );
=head3 Parameters
=over 4
=item * C<upload_id> (in path) (Required) - The ID of the Upload.
Type: C<string>
=back
=head3 Request Body
   
=head3 Content Type: C<application/json>
     
       
       
       
Example:
    {
       "part_ids" : [
          null
       ]
    }
              
=head3 Responses
=head4 Status Code: C<200>
OK
=head4 Content Types:
=over 4
=item * C<application/json>
Example (See the L<OpenAI spec for more detail|https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):
    {
      "id": "upload_abc123",
      "object": "upload",
      "bytes": 2147483648,
      "created_at": 1719184911,
      "filename": "training_examples.jsonl",
      "purpose": "fine-tune",
      "status": "completed",
      "expires_at": 1719127296,
      "file": {
        "id": "file-xyz321",
        "object": "file",
        "bytes": 2147483648,
        "created_at": 1719186911,
        "filename": "training_examples.jsonl",
        "purpose": "fine-tune",
      }
    }
=back
=head1 SEE ALSO
L<OpenAPI::Client::OpenAI::Path>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2023-2025 by Nelson Ferraz
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.0 or,
at your option, any later version of Perl 5 you may have available.
=cut