> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.fax.plus/llms.txt
> Use this file to discover all available pages before exploring further.

# Upload a file

> Before sending a fax you need to upload your files using this API. In order to upload your fax file, you have to send a `multipart/form-data` request with your file. Set the `name` to `fax_file`, `filename` to your file's name with extension, and the Content-Type to the file's MIME type. In most cases, the `filename` directive will be automatically added by your library of choice. If the upload was successful you would receive a `file_path` which you can use to send your fax. (Permitted scopes: **fax:all:edit**, **fax:file:edit**)

<RequestExample>
  ```js NodeJS SDK theme={null}
  const axios = require('axios');
  const fs = require('fs');
  const FilesApiFp = require('@alohi/faxplus-api').FilesApiFp;
  const Configuration = require('@alohi/faxplus-api').Configuration;

  const config = new Configuration({
      accessToken: accessToken,
      basePath: 'https://restapi.fax.plus/v3',
      // Header required only when using the OAuth2 token scheme
      baseOptions: {
          headers: {
            "x-fax-clientid": clientId,
          }
      }
  });

  async function uploadFile() {
      // IMPORTANT: fs.createReadStream() requires a local file system path.
      // It does NOT support URLs or remote streams.
      // 
      // If your file is stored remotely (e.g., AWS S3, Google Cloud Storage, or HTTP URL),
      // you must first download it to a local path or load it into memory as a Blob.
      const reqParams = {
          "userId": '13d8z73c',
          "faxFile": fs.createReadStream(FILE_PATH)  // FILE_PATH must be a local file path
      }
      const req = await FilesApiFp(config).uploadFile(reqParams);
      const resp = await req(axios);
  }

  uploadFile()
  ```

  ```python Python SDK theme={null}
  from faxplus import ApiClient, FilesApi
  from faxplus.configuration import Configuration

  conf = Configuration()
  conf.access_token = access_token
  # header_name and header_value required only when using the OAuth2 token scheme
  api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
  api = FilesApi(api_client)
  resp = api.upload_file(
      user_id='13d8z73c',
      fax_file='/path/to/file.pdf'
  )
  ```

  ```java Java theme={null}
  /**
   * Example below uses Apache HTTP Client 4 with Fluent API
   **/

  Map<String, String> pathParams = new HashMap<>();
  pathParams.put("user_id", "'13d8z73c'");

  StrSubstitutor sub = new StrSubstitutor(values, "{", "}");
  String url = sub.replace("https://restapi.fax.plus/v3/accounts/{user_id}/files");

  HttpEntity entity = MultipartEntityBuilder.create()
          .setMode(HttpMultipartMode.BROWSER_COMPATIBLE)
          .setCharset(Charset.forName(CHARSET))
          .addBinaryBody("fax_file", bytes, ContentType.MULTIPART_FORM_DATA, "fax.pdf")
          .build();

  String result = Request
      .Post(url)
       // The x-fax-clientid header is required only when using the OAuth2 token scheme
      .addHeader("x-fax-clientid", "YOUR CLIENT_ID")
      .addHeader("Content-Type", "'multipart/form-data'")
      .addHeader("Accept", "'application/json'")
      .addHeader("Authorization", "'Bearer {access-token}'")
      .body(entity)
      .execute()
      .returnContent().asString();

  System.out.println(result.toString());
  ```

  ```go Go theme={null}
  package main

  import (
         "bytes"
         "net/http"
  )

  func main() {

      headers := map[string][]string{
          // The x-fax-clientid header is required only when using the OAuth2 token scheme
          "Content-Type": []string{"multipart/form-data"},
          "Accept": []string{"application/json"},
          "Authorization": []string{"Bearer {access-token}"},
          "x-fax-clientid": []string{"YOUR CLIENT_ID"}
      }

      body := &bytes.Buffer{}
      writer := multipart.NewWriter(body)
      fax_file_part, err := writer.CreateFormFile('fax_file', filepath.Base('fax.pdf'))
      _, err = io.Copy(part, file)

      req, err := http.NewRequest("POST", "https://restapi.fax.plus/v3/accounts/{user_id}/files", data)
      req.Header = headers

      client := &http.Client{}
      resp, err := client.Do(req)
      // ...
  }
  ```

  ```php PHP theme={null}
  <?php

  require 'vendor/autoload.php';

  $headers = array(
      'Accept' => 'application/json',
      'Authorization' => 'Bearer {access-token}',
      // The x-fax-clientid header is required only when using the OAuth2 token scheme
      'x-fax-clientid' => '{client ID}',
  );

  $client = new GuzzleHttp\Client();

  try {
      $response = $client->request('POST','https://restapi.fax.plus/v3/accounts/{user_id}/files', array(
          'headers' => $headers,
          'multipart' => [
            [
              'name' => 'fax_file',
              'contents' => fopen('fax.pdf', 'r')
            ],
          ],)
      );
      print_r($response->getBody()->getContents());
   }
   catch (GuzzleHttp\Exception\BadResponseException $e) {
      // handle exception or api errors.
      print_r($e->getMessage());
   }

   // ...
  ```

  ```bash cURL theme={null}
  # You can also use wget
  curl -X POST https://restapi.fax.plus/v3/accounts/{user_id}/files \
    -H 'Content-Type: multipart/form-data'  \
    -H 'Accept: application/json'  \
    -H 'Authorization: Bearer {access-token}' \
    # The x-fax-clientid header is required only when using the OAuth2 token scheme
    -H 'x-fax-clientid: "YOUR CLIENT_ID"' \
    -F 'fax_file=@fax.pdf'
  ```
</RequestExample>


## OpenAPI

````yaml post /accounts/{user_id}/files
openapi: 3.0.1
info:
  title: Fax.Plus REST API
  description: >-
    This is the Fax.Plus API v3 developed for third party developers and
    organizations. In order to have a better coding experience with this API,
    let's quickly go through some points:<br /><br /> - This API assumes
    **/accounts** as an entry point with the base url of
    **https://restapi.fax.plus/v3**. <br /><br /> - This API treats all date and
    times sent to it in requests as **UTC**. Also, all dates and times returned
    in responses are in **UTC**<br /><br /> - Once you have an access_token, you
    can easily send a request to the resource server with the base url of
    **https://restapi.fax.plus/v3** to access your permitted resources. As an
    example to get the user's profile info you would send a request to
    **https://restapi.fax.plus/v3/accounts/self** when **Authorization** header
    is set to **Bearer YOUR_ACCESS_TOKEN** and custom header of
    **x-fax-clientid** is set to YOUR_CLIENT_ID
  version: 3.4.0
  contact:
    name: Fax.Plus
    email: info@fax.plus
    url: https://github.com/alohi
servers:
  - url: https://restapi.fax.plus/v3
  - url: /v3
security: []
paths:
  /accounts/{user_id}/files:
    post:
      tags:
        - Files
      summary: Upload a file
      description: >-
        Before sending a fax you need to upload your files using this API. In
        order to upload your fax file, you have to send a `multipart/form-data`
        request with your file. Set the `name` to `fax_file`, `filename` to your
        file's name with extension, and the Content-Type to the file's MIME
        type. In most cases, the `filename` directive will be automatically
        added by your library of choice. If the upload was successful you would
        receive a `file_path` which you can use to send your fax. (Permitted
        scopes: **fax:all:edit**, **fax:file:edit**)
      operationId: uploadFile
      parameters:
        - name: format
          in: query
          required: false
          deprecated: true
          schema:
            $ref: '#/components/schemas/FileType'
          description: Can be 'pdf' or 'tiff'
        - name: user_id
          in: path
          required: true
          schema:
            type: string
            default: self
          description: >-
            User ID. Use 'self' for your own account, or provide a specific user
            ID for corporate member accounts.
          example: self
      requestBody:
        description: >-
          A file to be uploaded. The file can be in PDF, TIFF, Word, Excel, RTF
          or image format.
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/File'
      responses:
        '201':
          $ref: '#/components/responses/FilePath'
        '400':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - oauth2:
            - all
        - personal_access_token:
            - fax:all:edit
            - fax:file:edit
components:
  schemas:
    FileType:
      description: File type
      enum:
        - tiff
        - pdf
      type: string
    File:
      description: File to be uploaded
      properties:
        fax_file:
          description: Path to file to upload
          format: binary
          type: string
      example:
        fax_file: fax.pdf
      required:
        - fax_file
      type: object
      additionalProperties: false
    FilePath:
      description: File path object
      example:
        path: /storage/2937237320213-213-21323
      properties:
        path:
          description: Path of newly uploaded file
          type: string
      required:
        - path
      type: object
      additionalProperties: false
    Error:
      properties:
        description:
          type: string
        error:
          type: string
      additionalProperties: false
  responses:
    FilePath:
      description: Simple object containing path of created file
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FilePath'
    Error:
      description: Error object in case there's a problem with given data
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid_user_id
            description: Invalid user id given
    ServerError:
      description: Error object in case there's a server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: internal_server_error
            description: An unexpected error happened, please contact support
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth2 Authorization Grant
      flows:
        authorizationCode:
          authorizationUrl: >-
            https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
          tokenUrl: https://accounts.fax.plus/token
          refreshUrl: >-
            https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=YOUR_REFRESH_TOKEN
          scopes:
            all: >-
              for now when a user grants permission, all grants will be
              permitted
    personal_access_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Personal Access Token (PAT) is a Bearer token used for secure API calls.
        For direct API calls, the PAT is used in the Authorization header as
        'Bearer {PAT}'. For MCP usage, configure your PAT in your MCP client
        settings (e.g., in your IDE's MCP server configuration) - authentication
        will be handled automatically.

````