Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 3.11 KB

File metadata and controls

35 lines (26 loc) · 3.11 KB

InstantiatedTemplateResponse

Response after successful template instantiation. Provides all information needed to start using the newly created namespace, including IDs for API calls and status information. The namespace is immediately ready for use when status is 'ready'. All collections, documents, and feature stores are fully functional. Use Cases: - Retrieve namespace_id for subsequent API calls - Verify instantiation completed successfully - Track which template was used for the namespace - Record creation timestamp for auditing Fields: All fields are REQUIRED and populated by the server.

Properties

Name Type Description Notes
namespace_id str ID of the newly created namespace. REQUIRED. Use this ID in the X-Namespace header for all API calls to this namespace. Format: namespace ID starting with 'ns_'. Permanent identifier for the namespace.
namespace_name str Name of the newly created namespace. REQUIRED. Matches the namespace_name from the request. Human-readable identifier shown in UI. Can be used for namespace lookup via GET /namespaces/{name}.
template_id str ID of the template that was instantiated. REQUIRED. Reference to the source template used for creation. Useful for tracking which template produced this namespace. Format: template ID starting with 'tmpl_'.
status str Instantiation status. REQUIRED. 'cloning' means the namespace is being created and data is being copied. 'ready' means the namespace is fully functional and ready to use. 'failed' means the cloning process encountered an error. Poll GET /namespaces/{namespace_id} to check when status becomes 'ready'. All data is cloned including collections, vectors, retrievers, and taxonomies. [optional] [default to 'cloning']
task_id str Celery task ID for tracking the clone operation. Can be used to poll task status if needed. Format: UUID string. [optional]
created_at datetime Timestamp when namespace was created. REQUIRED. Auto-generated by server. Format: ISO 8601 datetime in UTC. Used for auditing and sorting namespaces by creation time. [optional]

Example

from mixpeek.models.instantiated_template_response import InstantiatedTemplateResponse

# TODO update the JSON string below
json = "{}"
# create an instance of InstantiatedTemplateResponse from a JSON string
instantiated_template_response_instance = InstantiatedTemplateResponse.from_json(json)
# print the JSON string representation of the object
print(InstantiatedTemplateResponse.to_json())

# convert the object into a dict
instantiated_template_response_dict = instantiated_template_response_instance.to_dict()
# create an instance of InstantiatedTemplateResponse from a dict
instantiated_template_response_from_dict = InstantiatedTemplateResponse.from_dict(instantiated_template_response_dict)

[Back to Model list] [Back to API list] [Back to README]