ORorq-ai
Files

Upload a file

Changed on

Files are used to upload documents that can be used with features like Deployments.

post/v2/files

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/files
  • Auth
    HTTP bearer

Request body

filenamestring required

Name to store for the uploaded file, including extension when available.

contentstring bytes required

Base64-encoded file contents.

purpose'FILE_PURPOSE_RETRIEVAL' | 'FILE_PURPOSE_KNOWLEDGE_DATASOURCE' | 'FILE_PURPOSE_BATCH' | 'FILE_PURPOSE_CODE_INTERPRETER'
content_typestring

MIME type of the uploaded content, for example application/pdf.

project_idstring

Project the file is created in. Optional: project-scoped API keys default to the key's bound project; workspace-scoped callers default to the workspace's default project.

Response

OK

Changes

  • 0b4e519a544fRevision changes
    • breaking

      removed the enum value FILE_PURPOSE_UNSPECIFIED of the request property

    • info

      added the non-success response with the status

    • info

      removed the FILE_PURPOSE_UNSPECIFIED enum value from the ///// response property for the response status

  • 732aed62833aRevision changes
    • warning

      added the new FILE_PURPOSE_UNSPECIFIED enum value to the ///// response property for the response status

    • info

      added the new FILE_PURPOSE_UNSPECIFIED enum value to the request property

    • info

      removed the non-success response with the status