POST
/
attachment
/
v1
/
upload

Upload files that can be referenced in Assistant conversations using their attachment IDs.

To use the API you need an API key. You can create API Keys in your Workspace settings.

​
Request Format

This endpoint accepts multipart/form-data requests with a single file upload.

ParameterTypeRequiredDescription
fileFileYesThe file you want to upload

​
Response Format

The API returns the uploaded file information:

{
  attachmentId: string;
  file: {
    name: string;
    mimeType: string;
    sizeInBytes: number;
  }
}

​
Example

const axios = require("axios");
const FormData = require("form-data");
const fs = require("fs");

async function uploadAttachment() {
  const form = new FormData();
  form.append("file", fs.createReadStream("example.pdf"));

  const response = await axios.post(
    "https://api.langdock.com/attachment/v1/upload",
    form,
    {
      headers: {
        ...form.getHeaders(),
        Authorization: "Bearer YOUR_API_KEY",
      },
    }
  );

  console.log(response.data);
  // {
  //   attachmentId: "550e8400-e29b-41d4-a716-446655440000",
  //   file: {
  //     name: "example.pdf",
  //     mimeType: "application/pdf",
  //     sizeInBytes: 1234567
  //   }
  // }
}

​
Error Handling

try {
  const response = await axios.post('https://api.langdock.com/attachment/v1/upload', ...);
} catch (error) {
  if (error.response) {
    switch (error.response.status) {
      case 400:
        console.error('No file provided');
        break;
      case 401:
        console.error('Invalid API key');
        break;
      case 500:
        console.error('Server error');
        break;
    }
  }
}

The uploaded attachment ID can be used in the Assistant API by including it in the attachmentIds array either at the assistant level or message level.

Body

multipart/form-data
​
file
file
required

The file to upload

Response

200 - application/json
​
attachmentId
string
required

Unique identifier for the uploaded attachment

​
file
object
required

Was this page helpful?

Models for Assistant APIOpenAI Chat completion