Namespaces

List Namespaces

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

app_id*App Id

Query Parameters

search?|

Search by name or description

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/apps/string/namespaces"

{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "namespaces": [
    {
      "namespace_id": "string",
      "name": "string",
      "description": "string",
      "app_id": "string",
      "workspace_id": "string",
      "environment_id": "string",
      "embedding_model_id": "string",
      "extraction_model_id": "string",
      "auto_extract_entities": false,
      "is_private": false,
      "index_threads": false,
      "episodes_enabled": false,
      "episode_config": {},
      "status": "active",
      "context_type": "string",
      "tags": [
        "string"
      ],
      "thread_ids": [
        "string"
      ],
      "source_ids": [
        "string"
      ],
      "memory_vault_id": "string",
      "node_ids": [
        "string"
      ],
      "reindex_status": "string",
      "reindex_started_at": "string",
      "reindex_completed_at": "string",
      "reindex_progress": {},
      "reindex_error": "string",
      "created_by": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

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

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Create Namespace

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

app_id*App Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*Name

The name of the namespace

Length1 <= length <= 100

environment_id*Environment Id

Environment this namespace belongs to

description?|

A brief description of the namespace

context_type?|

The type of context for the namespace

tags?array<string>

Tags associated with the namespace

embedding_model_id?|

Embedding model used for sources/memories in this namespace. If omitted, a workspace default is used.

extraction_model_id?|

Chat model for entity extraction and memory consolidation. If omitted, uses the org default.

is_private?Is Private

If true, this namespace requires namespace-scoped tool instances

Defaultfalse

index_threads?Index Threads

If true, thread messages in this namespace are indexed for semantic search

Defaultfalse

episodes_enabled?Episodes Enabled

If true, threads are evaluated for episodic memory after each execution

Defaultfalse

episode_config?|

Episode configuration overrides (token_threshold, max_summary_tokens)

Response Body

`application/json`

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

{
  "message": "Namespace created successfully",
  "namespace": {
    "namespace_id": "string",
    "name": "string",
    "description": "string",
    "app_id": "string",
    "workspace_id": "string",
    "environment_id": "string",
    "embedding_model_id": "string",
    "extraction_model_id": "string",
    "auto_extract_entities": false,
    "is_private": false,
    "index_threads": false,
    "episodes_enabled": false,
    "episode_config": {},
    "status": "active",
    "context_type": "string",
    "tags": [
      "string"
    ],
    "thread_ids": [
      "string"
    ],
    "source_ids": [
      "string"
    ],
    "memory_vault_id": "string",
    "node_ids": [
      "string"
    ],
    "reindex_status": "string",
    "reindex_started_at": "string",
    "reindex_completed_at": "string",
    "reindex_progress": {},
    "reindex_error": "string",
    "created_by": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

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

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Get Namespace

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

app_id*App Id

namespace_id*Namespace Id

Header Parameters

authorization?string|null

Response Body

`application/json`

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

{
  "namespace_id": "string",
  "name": "string",
  "description": "string",
  "app_id": "string",
  "workspace_id": "string",
  "environment_id": "string",
  "embedding_model_id": "string",
  "extraction_model_id": "string",
  "auto_extract_entities": false,
  "is_private": false,
  "index_threads": false,
  "episodes_enabled": false,
  "episode_config": {},
  "status": "active",
  "context_type": "string",
  "tags": [
    "string"
  ],
  "thread_ids": [
    "string"
  ],
  "source_ids": [
    "string"
  ],
  "memory_vault_id": "string",
  "node_ids": [
    "string"
  ],
  "reindex_status": "string",
  "reindex_started_at": "string",
  "reindex_completed_at": "string",
  "reindex_progress": {},
  "reindex_error": "string",
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

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

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Delete Namespace

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

app_id*App Id

namespace_id*Namespace Id

Header Parameters

authorization?string|null

Response Body

`application/json`

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

{
  "message": "Namespace deleted successfully"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

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

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Update Namespace

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

app_id*App Id

namespace_id*Namespace Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|

The name of the namespace

description?|

A brief description of the namespace

status?|

The status of the namespace

context_type?|

The type of context for the namespace

tags?array<string>|

Tags associated with the namespace

is_private?|

Toggle private namespace mode

auto_extract_entities?|

Toggle auto entity extraction from memories

extraction_model_id?|

Chat model for entity extraction (None = use default)

index_threads?|

Toggle thread message indexing

episodes_enabled?|

Toggle episodic memory for threads

episode_config?|

Episode configuration overrides

Response Body

`application/json`

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

{
  "message": "Namespace updated successfully",
  "namespace": {
    "namespace_id": "string",
    "name": "string",
    "description": "string",
    "app_id": "string",
    "workspace_id": "string",
    "environment_id": "string",
    "embedding_model_id": "string",
    "extraction_model_id": "string",
    "auto_extract_entities": false,
    "is_private": false,
    "index_threads": false,
    "episodes_enabled": false,
    "episode_config": {},
    "status": "active",
    "context_type": "string",
    "tags": [
      "string"
    ],
    "thread_ids": [
      "string"
    ],
    "source_ids": [
      "string"
    ],
    "memory_vault_id": "string",
    "node_ids": [
      "string"
    ],
    "reindex_status": "string",
    "reindex_started_at": "string",
    "reindex_completed_at": "string",
    "reindex_progress": {},
    "reindex_error": "string",
    "created_by": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

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

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Reindex Namespace

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

app_id*App Id

namespace_id*Namespace Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

new_embedding_model_id*New Embedding Model Id

New embedding model to use for reindexing

confirm?Confirm

Must be True to confirm the destructive reindex operation

Defaultfalse

Response Body

`application/json`

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

{
  "namespace_id": "string",
  "name": "string",
  "description": "string",
  "app_id": "string",
  "workspace_id": "string",
  "environment_id": "string",
  "embedding_model_id": "string",
  "extraction_model_id": "string",
  "auto_extract_entities": false,
  "is_private": false,
  "index_threads": false,
  "episodes_enabled": false,
  "episode_config": {},
  "status": "active",
  "context_type": "string",
  "tags": [
    "string"
  ],
  "thread_ids": [
    "string"
  ],
  "source_ids": [
    "string"
  ],
  "memory_vault_id": "string",
  "node_ids": [
    "string"
  ],
  "reindex_status": "string",
  "reindex_started_at": "string",
  "reindex_completed_at": "string",
  "reindex_progress": {},
  "reindex_error": "string",
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

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

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Add Thread To Namespace

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

app_id*App Id

namespace_id*Namespace Id

thread_id*Thread Id

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/workspaces/string/apps/string/namespaces/string/threads/string"

{
  "namespace_id": "string",
  "name": "string",
  "description": "string",
  "app_id": "string",
  "workspace_id": "string",
  "environment_id": "string",
  "embedding_model_id": "string",
  "extraction_model_id": "string",
  "auto_extract_entities": false,
  "is_private": false,
  "index_threads": false,
  "episodes_enabled": false,
  "episode_config": {},
  "status": "active",
  "context_type": "string",
  "tags": [
    "string"
  ],
  "thread_ids": [
    "string"
  ],
  "source_ids": [
    "string"
  ],
  "memory_vault_id": "string",
  "node_ids": [
    "string"
  ],
  "reindex_status": "string",
  "reindex_started_at": "string",
  "reindex_completed_at": "string",
  "reindex_progress": {},
  "reindex_error": "string",
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

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

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Remove Thread From Namespace

Path Parameters

org_id*Org Id

workspace_id*Workspace Id

app_id*App Id

namespace_id*Namespace Id

thread_id*Thread Id

Header Parameters

authorization?string|null

Response Body

`application/json`

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

{
  "namespace_id": "string",
  "name": "string",
  "description": "string",
  "app_id": "string",
  "workspace_id": "string",
  "environment_id": "string",
  "embedding_model_id": "string",
  "extraction_model_id": "string",
  "auto_extract_entities": false,
  "is_private": false,
  "index_threads": false,
  "episodes_enabled": false,
  "episode_config": {},
  "status": "active",
  "context_type": "string",
  "tags": [
    "string"
  ],
  "thread_ids": [
    "string"
  ],
  "source_ids": [
    "string"
  ],
  "memory_vault_id": "string",
  "node_ids": [
    "string"
  ],
  "reindex_status": "string",
  "reindex_started_at": "string",
  "reindex_completed_at": "string",
  "reindex_progress": {},
  "reindex_error": "string",
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

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

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

201application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/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`

`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`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`