Artifacts

List Artifacts

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

namespace_id*Namespace Id

Query Parameters

thread_id?|

Filter by thread

artifact_types?|

Comma-separated types

include_expired?Include Expired

Defaultfalse

limit?Limit

Maximum number of items to return (1-200)

Default50

Range1 <= value <= 200

cursor?|

Cursor for pagination (from previous response's next_cursor)

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/namespaces/string/artifacts"

{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "artifacts": [
    {
      "artifact_id": "string",
      "workspace_id": "string",
      "namespace_id": "string",
      "thread_id": "string",
      "name": "string",
      "description": "string",
      "artifact_type": "string",
      "version": 1,
      "root_artifact_id": "string",
      "is_latest": true,
      "replaced_by_version": 0,
      "content": "string",
      "content_preview": "string",
      "content_text": "string",
      "file_name": "string",
      "mime_type": "string",
      "size_bytes": 0,
      "has_file": false,
      "summary": "string",
      "keywords": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "metadata": {},
      "source": "string",
      "source_execution_id": "string",
      "source_step_id": "string",
      "source_tool": "string",
      "scope": "string",
      "status": "string",
      "ttl_seconds": 0,
      "expires_at": "string",
      "is_pinned": true,
      "is_expired": true,
      "is_indexed": true,
      "indexed_at": "string",
      "index_collection": "string",
      "index_error": "string",
      "index_attempts": 0,
      "embedding_model_id": "string",
      "chunk_count": 0,
      "promoted_to_source_id": "string",
      "created_by": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Create Artifact

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

namespace_id*Namespace Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*Name

Length1 <= length <= 255

description?|null

artifact_type?ArtifactType

Types of artifacts that can be generated

Default"text"

content?string||array<unknown>|null

content_text?string|null

file_name?string|null

mime_type?string|null

thread_id?string|null

scope?ArtifactScope

Lifecycle scope for artifacts

Default"thread"

Value in"execution" | "thread" | "namespace"

ttl_seconds?integer|null

is_pinned?Is Pinned

Defaultfalse

source?ArtifactSource

What created this artifact

Default"system"

Value in"tool_call" | "inference" | "artifact_create" | "system" | "external"

source_execution_id?string|null

source_step_id?string|null

source_tool?string|null

source_tool_action?string|null

extract_summary?Extract Summary

Generate AI summary

Defaulttrue

extract_keywords?Extract Keywords

Extract keywords

Defaulttrue

skip_indexing?Skip Indexing

Skip vector indexing

Defaultfalse

tags?array<string>

metadata?

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/workspaces/string/namespaces/string/artifacts" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{
  "artifact_id": "string",
  "workspace_id": "string",
  "namespace_id": "string",
  "thread_id": "string",
  "name": "string",
  "description": "string",
  "artifact_type": "string",
  "version": 1,
  "root_artifact_id": "string",
  "is_latest": true,
  "replaced_by_version": 0,
  "content": "string",
  "content_preview": "string",
  "content_text": "string",
  "file_name": "string",
  "mime_type": "string",
  "size_bytes": 0,
  "has_file": false,
  "summary": "string",
  "keywords": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "metadata": {},
  "source": "string",
  "source_execution_id": "string",
  "source_step_id": "string",
  "source_tool": "string",
  "scope": "string",
  "status": "string",
  "ttl_seconds": 0,
  "expires_at": "string",
  "is_pinned": true,
  "is_expired": true,
  "is_indexed": true,
  "indexed_at": "string",
  "index_collection": "string",
  "index_error": "string",
  "index_attempts": 0,
  "embedding_model_id": "string",
  "chunk_count": 0,
  "promoted_to_source_id": "string",
  "created_by": "string",
  "created_at": "string",
  "updated_at": "string"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Create Artifact With File

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

namespace_id*Namespace Id

Header Parameters

authorization?string|null

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file*File

name*Name

description?string|null

thread_id?string|null

scope?ArtifactScope

Lifecycle scope for artifacts

Default"thread"

Value in"execution" | "thread" | "namespace"

ttl_seconds?integer|null

is_pinned?Is Pinned

Defaultfalse

source?ArtifactSource

What created this artifact

Default"system"

Value in"tool_call" | "inference" | "artifact_create" | "system" | "external"

source_execution_id?string|null

source_step_id?string|null

source_tool?string|null

extract_summary?Extract Summary

Defaulttrue

extract_keywords?Extract Keywords

Defaulttrue

skip_indexing?Skip Indexing

Defaultfalse

tags?string|null

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/workspaces/string/namespaces/string/artifacts/upload" \  -F file="string" \  -F name="string"

{
  "artifact_id": "string",
  "workspace_id": "string",
  "namespace_id": "string",
  "thread_id": "string",
  "name": "string",
  "description": "string",
  "artifact_type": "string",
  "version": 1,
  "root_artifact_id": "string",
  "is_latest": true,
  "replaced_by_version": 0,
  "content": "string",
  "content_preview": "string",
  "content_text": "string",
  "file_name": "string",
  "mime_type": "string",
  "size_bytes": 0,
  "has_file": false,
  "summary": "string",
  "keywords": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "metadata": {},
  "source": "string",
  "source_execution_id": "string",
  "source_step_id": "string",
  "source_tool": "string",
  "scope": "string",
  "status": "string",
  "ttl_seconds": 0,
  "expires_at": "string",
  "is_pinned": true,
  "is_expired": true,
  "is_indexed": true,
  "indexed_at": "string",
  "index_collection": "string",
  "index_error": "string",
  "index_attempts": 0,
  "embedding_model_id": "string",
  "chunk_count": 0,
  "promoted_to_source_id": "string",
  "created_by": "string",
  "created_at": "string",
  "updated_at": "string"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get Artifact

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

namespace_id*Namespace Id

artifact_id*Artifact Id

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/namespaces/string/artifacts/string"

{
  "artifact_id": "string",
  "workspace_id": "string",
  "namespace_id": "string",
  "thread_id": "string",
  "name": "string",
  "description": "string",
  "artifact_type": "string",
  "version": 1,
  "root_artifact_id": "string",
  "is_latest": true,
  "replaced_by_version": 0,
  "content": "string",
  "content_preview": "string",
  "content_text": "string",
  "file_name": "string",
  "mime_type": "string",
  "size_bytes": 0,
  "has_file": false,
  "summary": "string",
  "keywords": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "metadata": {},
  "source": "string",
  "source_execution_id": "string",
  "source_step_id": "string",
  "source_tool": "string",
  "scope": "string",
  "status": "string",
  "ttl_seconds": 0,
  "expires_at": "string",
  "is_pinned": true,
  "is_expired": true,
  "is_indexed": true,
  "indexed_at": "string",
  "index_collection": "string",
  "index_error": "string",
  "index_attempts": 0,
  "embedding_model_id": "string",
  "chunk_count": 0,
  "promoted_to_source_id": "string",
  "created_by": "string",
  "created_at": "string",
  "updated_at": "string"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Delete Artifact

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

namespace_id*Namespace Id

artifact_id*Artifact Id

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X DELETE "https://loading/v1/orgs/string/workspaces/string/namespaces/string/artifacts/string"

Empty

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update Artifact

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

namespace_id*Namespace Id

artifact_id*Artifact Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|null

description?string|null

content?string||array<unknown>|null

content_text?string|null

scope?|null

ttl_seconds?integer|null

is_pinned?boolean|null

status?|null

tags?array<string>|null

metadata?|null

regenerate_summary?Regenerate Summary

Defaultfalse

regenerate_keywords?Regenerate Keywords

Defaultfalse

reindex?Reindex

Defaultfalse

Response Body

`application/json`

curl -X PUT "https://loading/v1/orgs/string/workspaces/string/namespaces/string/artifacts/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "artifact_id": "string",
  "workspace_id": "string",
  "namespace_id": "string",
  "thread_id": "string",
  "name": "string",
  "description": "string",
  "artifact_type": "string",
  "version": 1,
  "root_artifact_id": "string",
  "is_latest": true,
  "replaced_by_version": 0,
  "content": "string",
  "content_preview": "string",
  "content_text": "string",
  "file_name": "string",
  "mime_type": "string",
  "size_bytes": 0,
  "has_file": false,
  "summary": "string",
  "keywords": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "metadata": {},
  "source": "string",
  "source_execution_id": "string",
  "source_step_id": "string",
  "source_tool": "string",
  "scope": "string",
  "status": "string",
  "ttl_seconds": 0,
  "expires_at": "string",
  "is_pinned": true,
  "is_expired": true,
  "is_indexed": true,
  "indexed_at": "string",
  "index_collection": "string",
  "index_error": "string",
  "index_attempts": 0,
  "embedding_model_id": "string",
  "chunk_count": 0,
  "promoted_to_source_id": "string",
  "created_by": "string",
  "created_at": "string",
  "updated_at": "string"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List Artifact Versions

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

namespace_id*Namespace Id

artifact_id*Artifact Id

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/namespaces/string/artifacts/string/versions"

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get artifact download URL

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

namespace_id*Namespace Id

artifact_id*Artifact Id

Query Parameters

expires_in?Expires In

URL expiration in seconds (1 min to 24 hours)

Default3600

Range60 <= value <= 86400

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/namespaces/string/artifacts/string/download"

{
  "artifact_id": "string",
  "download_url": "string",
  "expires_in": 0,
  "file_name": "string",
  "content_type": "string",
  "file_size_bytes": 0
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List Thread Artifacts

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

namespace_id*Namespace Id

thread_id*Thread Id

Query Parameters

artifact_types?string|null

include_expired?Include Expired

Defaultfalse

limit?Limit

Maximum number of items to return (1-200)

Default50

Range1 <= value <= 200

cursor?|

Cursor for pagination (from previous response's next_cursor)

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/namespaces/string/threads/string/artifacts"

{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "artifacts": [
    {
      "artifact_id": "string",
      "workspace_id": "string",
      "namespace_id": "string",
      "thread_id": "string",
      "name": "string",
      "description": "string",
      "artifact_type": "string",
      "version": 1,
      "root_artifact_id": "string",
      "is_latest": true,
      "replaced_by_version": 0,
      "content": "string",
      "content_preview": "string",
      "content_text": "string",
      "file_name": "string",
      "mime_type": "string",
      "size_bytes": 0,
      "has_file": false,
      "summary": "string",
      "keywords": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "metadata": {},
      "source": "string",
      "source_execution_id": "string",
      "source_step_id": "string",
      "source_tool": "string",
      "scope": "string",
      "status": "string",
      "ttl_seconds": 0,
      "expires_at": "string",
      "is_pinned": true,
      "is_expired": true,
      "is_indexed": true,
      "indexed_at": "string",
      "index_collection": "string",
      "index_error": "string",
      "index_attempts": 0,
      "embedding_model_id": "string",
      "chunk_count": 0,
      "promoted_to_source_id": "string",
      "created_by": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Query Artifacts

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

namespace_id*Namespace Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

query*Query

Length1 <= length

artifact_types?array<>|null

source_tools?array<string>|null

tags?array<string>|null

metadata_filters?|

Filter by custom metadata key-value pairs (exact match)

thread_id?string|null

scope?|null

include_parent_scopes?Include Parent Scopes

If querying thread, also include namespace-scoped artifacts

Defaulttrue

top_k?Top K

Default5

Range1 <= value <= 50

score_threshold?Score Threshold

Default0

Range0 <= value <= 1

include_expired?Include Expired

Defaultfalse

include_content?Include Content

Include full content in results

Defaulttrue

build_combined_context?Build Combined Context

Build combined text context

Defaulttrue

context_separator?Context Separator

Default"\n\n---\n\n"

org_id?|

Organization ID for embedding routing

embedding_model_id?|

Logical model ID for embedding generation

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/workspaces/string/namespaces/string/artifacts/query" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'

{
  "results": [
    {
      "artifact": {
        "artifact_id": "string",
        "workspace_id": "string",
        "namespace_id": "string",
        "thread_id": "string",
        "name": "string",
        "description": "string",
        "artifact_type": "string",
        "version": 1,
        "root_artifact_id": "string",
        "is_latest": true,
        "replaced_by_version": 0,
        "content": "string",
        "content_preview": "string",
        "content_text": "string",
        "file_name": "string",
        "mime_type": "string",
        "size_bytes": 0,
        "has_file": false,
        "summary": "string",
        "keywords": [
          "string"
        ],
        "tags": [
          "string"
        ],
        "metadata": {},
        "source": "string",
        "source_execution_id": "string",
        "source_step_id": "string",
        "source_tool": "string",
        "scope": "string",
        "status": "string",
        "ttl_seconds": 0,
        "expires_at": "string",
        "is_pinned": true,
        "is_expired": true,
        "is_indexed": true,
        "indexed_at": "string",
        "index_collection": "string",
        "index_error": "string",
        "index_attempts": 0,
        "embedding_model_id": "string",
        "chunk_count": 0,
        "promoted_to_source_id": "string",
        "created_by": "string",
        "created_at": "string",
        "updated_at": "string"
      },
      "score": 0,
      "matched_chunk": "string"
    }
  ],
  "combined_context": "string",
  "total_results": 0,
  "query": "string"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Promote Artifact To Source

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

namespace_id*Namespace Id

artifact_id*Artifact Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

source_name?|

Name for the new source (defaults to artifact name)

source_scope?Source Scope

Source scope: namespace or workspace

Default"namespace"

preserve_artifact?Preserve Artifact

Keep artifact after promotion

Defaulttrue

copy_metadata?Copy Metadata

Copy tags and metadata to source

Defaulttrue

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/workspaces/string/namespaces/string/artifacts/string/promote" \  -H "Content-Type: application/json" \  -d '{}'

{
  "artifact_id": "string",
  "source_id": "string",
  "source_name": "string",
  "message": "string"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

200application/json

422application/json

201application/json

422application/json

201application/json

422application/json

200application/json

422application/json

204

422application/json

200application/json

422application/json

200application/json

422application/json

200application/json

422application/json

200application/json

422application/json

200application/json

422application/json

200application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`