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

Attachments list for entity

GET
/v1/private/attachment/list
GET
/api/v1/private/attachment/list
$curl -G http://localhost:5173/api/v1/private/attachment/list \
>     -d project_id=project_id \
>     -d entity_type=trace \
>     -d entity_id=entity_id \
>     -d path=path
1{
2  "page": 1,
3  "size": 1,
4  "total": 1,
5  "content": [
6    {
7      "file_name": "string",
8      "file_size": 1,
9      "mime_type": "string",
10      "link": "string"
11    }
12  ],
13  "sortableBy": [
14    "string"
15  ]
16}
Attachments list for entity
Was this page helpful?
Previous

Complete multipart attachment upload

Next
Built with

Query parameters

pageintegerOptional>=1Defaults to 1
sizeintegerOptional>=1Defaults to 100
project_idstringRequiredformat: "uuid"
entity_typeenumRequired
Allowed values:
entity_idstringRequiredformat: "uuid"
pathstringRequired>=1 character

Response

Attachment Resource
pageinteger
sizeinteger
totallong
contentlist of objects
sortableBylist of strings

Errors

401
Unauthorized Error
403
Forbidden Error