For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • GETAttachments list for entity
        • POSTComplete multipart attachment upload
        • POSTDelete attachments
        • GETDownload attachment from MinIO
        • POSTStart multipart attachment upload
        • PUTUpload attachment to MinIO
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceAttachments

Start multipart attachment upload

POST
/v1/private/attachment/upload-start
POST
/api/v1/private/attachment/upload-start
$curl -X POST http://localhost:5173/api/v1/private/attachment/upload-start \
> -H "Content-Type: application/json" \
> -d '{
> "file_name": "string",
> "num_of_file_parts": 1,
> "entity_type": "trace",
> "entity_id": "string",
> "path": "string"
>}'
1{
2 "upload_id": "string",
3 "pre_sign_urls": [
4 "string"
5 ]
6}
Start multipart attachment upload
Was this page helpful?
Previous

Upload attachment to MinIO

Next
Built with

Request

This endpoint expects an object.
file_namestringRequired>=1 character
num_of_file_partsintegerRequired
entity_typeenumRequired
Allowed values:
entity_idstringRequiredformat: "uuid"
pathstringRequired>=1 character
mime_typestringOptional
project_namestringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"
If null, the default project is used

Response

MultipartUploadResponse
upload_idstring>=1 character
pre_sign_urlslist of strings

Errors

401
Unauthorized Error
403
Forbidden Error