PIpipeshub-ai
Agents

Upload agent chat attachments

Changed on

Multipart upload of chat attachment files (the MIME types listed on files) for agent chat: up to 10 files, 5 MiB each. Proxies to the AI backend. Optional conversationId associates uploads with an existing agent thread.

post/agents/{agentKey}/conversations/attachments/upload

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/agents/{agentKey}/conversations/attachments/upload
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: agent:execute

Path parameters

agentKeystring required

Request body multipart/form-data

conversationIdstring

Optional existing agent conversation id. Empty string is treated as unset; any non-empty value must be a 24-character ObjectId.

filesstring[] required

One or more files; field name must be files. Accepted MIME types: application/pdf, image/jpeg, image/jpg, image/png, text/plain, text/markdown, text/mdx, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, text/csv, text/tab-separated-values. Max 5 MiB each.

Response

Success. The gateway proxies the AI-backend JSON envelope after transforming the multipart upload into the backend attachment payload.

conversationIdstring nullable required

Existing conversation id echoed from the request when the upload is tied to a thread; otherwise null.

Changes

  • dbb5e203b445Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

  • 5798f431973aRevision changes
    • info

      added the optional property // to the response with the status

    • info

      response property attachments/items/ocrMode deprecated