{"openapi":"3.1.0","info":{"title":"StateVault API","description":"Public StateVault API documentation for customer-scoped AI memory.","version":"0.1.0"},"paths":{"/healthz":{"get":{"tags":["system"],"summary":"Healthz","operationId":"healthz_healthz_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthOut"}}}}}}},"/version":{"get":{"tags":["system"],"summary":"Versionz","operationId":"versionz_version_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionOut"}}}}}}},"/readyz":{"get":{"tags":["system"],"summary":"Readyz","operationId":"readyz_readyz_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadyOut"}}}}}}},"/v1/vaults":{"get":{"tags":["vaults"],"summary":"List Vaults","operationId":"list_vaults_v1_vaults_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultListOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["vaults"],"summary":"Create Vault","operationId":"create_vault_v1_vaults_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/states":{"get":{"tags":["states"],"summary":"List States","operationId":"list_states_v1_states_get","parameters":[{"name":"project_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Project Id"}},{"name":"vault_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Vault Id"}},{"name":"vault_slug","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Vault Slug"}},{"name":"agent_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Agent Id"}},{"name":"lifecycle_status","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(active|archived|deleted)$"},{"type":"null"}],"title":"Lifecycle Status"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateListOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["states"],"summary":"Create State","operationId":"create_state_v1_states_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/states/{state_id}":{"get":{"tags":["states"],"summary":"Get State","operationId":"get_state_v1_states__state_id__get","parameters":[{"name":"state_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"State Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["states"],"summary":"Patch State","operationId":"patch_state_v1_states__state_id__patch","parameters":[{"name":"state_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"State Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatePatch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/context":{"get":{"tags":["context"],"summary":"Get Context","operationId":"get_context_v1_context_get","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","title":"Query"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":5,"title":"Limit"}},{"name":"agent_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Id"}},{"name":"project_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Id"}},{"name":"vault_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Vault Id"}},{"name":"vault_slug","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Slug"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContextResult"},"title":"Response Get Context V1 Context Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/usage":{"get":{"tags":["usage"],"summary":"Get Usage","operationId":"get_usage_v1_usage_get","parameters":[{"name":"start","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start"}},{"name":"end","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End"}},{"name":"vault_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Vault Id"}},{"name":"vault_slug","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Slug"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/export":{"post":{"tags":["exports"],"summary":"Create Export","operationId":"create_export_v1_export_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportRequest"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/exports/{export_id}":{"get":{"tags":["exports"],"summary":"Get Export","operationId":"get_export_v1_exports__export_id__get","parameters":[{"name":"export_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Export Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/exports/{export_id}/download":{"get":{"tags":["exports"],"summary":"Download Export","operationId":"download_export_v1_exports__export_id__download_get","parameters":[{"name":"export_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Export Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ArtifactIn":{"properties":{"name":{"type":"string","maxLength":240,"minLength":1,"title":"Name"},"content_type":{"type":"string","maxLength":120,"title":"Content Type","default":"application/octet-stream"},"content_base64":{"type":"string","minLength":1,"title":"Content Base64"}},"type":"object","required":["name","content_base64"],"title":"ArtifactIn"},"ContextResult":{"properties":{"state_id":{"type":"string","format":"uuid","title":"State Id"},"score":{"type":"number","title":"Score"},"agent_id":{"type":"string","title":"Agent Id"},"project_id":{"type":"string","title":"Project Id"},"text":{"type":"string","title":"Text"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["state_id","score","agent_id","project_id","text","metadata","created_at"],"title":"ContextResult"},"ExportOut":{"properties":{"export_id":{"type":"string","format":"uuid","title":"Export Id"},"tenant_id":{"type":"string","format":"uuid","title":"Tenant Id"},"vault_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Vault Id"},"vault_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Name"},"vault_slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Slug"},"project_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Id"},"format":{"type":"string","title":"Format"},"status":{"type":"string","title":"Status"},"message":{"type":"string","title":"Message"},"package_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Package Size"},"state_count":{"type":"integer","title":"State Count","default":0},"object_count":{"type":"integer","title":"Object Count","default":0},"operation_count":{"type":"integer","title":"Operation Count","default":0},"auth_event_count":{"type":"integer","title":"Auth Event Count","default":0},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"},"download_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Download Url"}},"type":"object","required":["export_id","tenant_id","format","status","message"],"title":"ExportOut"},"ExportRequest":{"properties":{"project_id":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Project Id"},"vault_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Vault Id"},"vault_slug":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Vault Slug"},"format":{"type":"string","pattern":"^json$","title":"Format","default":"json"}},"type":"object","title":"ExportRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthOut":{"properties":{"status":{"type":"string","title":"Status"},"service":{"type":"string","title":"Service"}},"type":"object","required":["status","service"],"title":"HealthOut"},"ObjectRef":{"properties":{"name":{"type":"string","title":"Name"},"content_type":{"type":"string","title":"Content Type"}},"type":"object","required":["name","content_type"],"title":"ObjectRef"},"ReadyOut":{"properties":{"status":{"type":"string","title":"Status"}},"type":"object","required":["status"],"title":"ReadyOut"},"StateCreate":{"properties":{"agent_id":{"type":"string","maxLength":120,"minLength":1,"title":"Agent Id"},"project_id":{"type":"string","maxLength":120,"minLength":1,"title":"Project Id"},"vault_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Vault Id"},"vault_slug":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Vault Slug"},"source_model":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Source Model"},"context":{"additionalProperties":true,"type":"object","title":"Context"},"text":{"type":"string","maxLength":20000,"minLength":1,"title":"Text"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"},"artifacts":{"items":{"$ref":"#/components/schemas/ArtifactIn"},"type":"array","maxItems":8,"title":"Artifacts"}},"type":"object","required":["agent_id","project_id","text"],"title":"StateCreate"},"StateListOut":{"properties":{"items":{"items":{"$ref":"#/components/schemas/StateOut"},"type":"array","title":"Items"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"count":{"type":"integer","title":"Count"},"total":{"type":"integer","title":"Total"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["items","limit","offset","count","total","next_offset"],"title":"StateListOut"},"StateOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"tenant_id":{"type":"string","format":"uuid","title":"Tenant Id"},"vault_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Vault Id"},"vault_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Name"},"vault_slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Slug"},"agent_id":{"type":"string","title":"Agent Id"},"project_id":{"type":"string","title":"Project Id"},"source_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Model"},"context":{"additionalProperties":true,"type":"object","title":"Context"},"text":{"type":"string","title":"Text"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"},"lifecycle_status":{"type":"string","title":"Lifecycle Status"},"object_refs":{"items":{"$ref":"#/components/schemas/ObjectRef"},"type":"array","title":"Object Refs"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","tenant_id","agent_id","project_id","source_model","context","text","metadata","lifecycle_status","object_refs","created_at","updated_at"],"title":"StateOut"},"StatePatch":{"properties":{"lifecycle_status":{"anyOf":[{"type":"string","pattern":"^(active|archived|deleted)$"},{"type":"null"}],"title":"Lifecycle Status"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","title":"StatePatch"},"UsageCallOut":{"properties":{"method":{"type":"string","title":"Method"},"operation":{"type":"string","title":"Operation"},"count":{"type":"integer","title":"Count"},"vault_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Vault Id"},"vault_slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Slug"},"vault_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Name"}},"type":"object","required":["method","operation","count"],"title":"UsageCallOut"},"UsageOperationOut":{"properties":{"operation":{"type":"string","title":"Operation"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["operation","count"],"title":"UsageOperationOut"},"UsageOut":{"properties":{"tenant_id":{"type":"string","format":"uuid","title":"Tenant Id"},"start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End"},"operations":{"items":{"$ref":"#/components/schemas/UsageOperationOut"},"type":"array","title":"Operations"},"total":{"type":"integer","title":"Total"},"calls":{"items":{"$ref":"#/components/schemas/UsageCallOut"},"type":"array","title":"Calls"},"call_total":{"type":"integer","title":"Call Total","default":0}},"type":"object","required":["tenant_id","start","end","operations","total"],"title":"UsageOut"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VaultCreate":{"properties":{"name":{"type":"string","maxLength":120,"minLength":1,"title":"Name"},"slug":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Slug"},"description":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Description"},"intended_use":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}],"title":"Intended Use"},"environment_label":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Environment Label"}},"type":"object","required":["name"],"title":"VaultCreate"},"VaultListOut":{"properties":{"tenant_id":{"type":"string","format":"uuid","title":"Tenant Id"},"items":{"items":{"$ref":"#/components/schemas/VaultOut"},"type":"array","title":"Items"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["tenant_id","items","count"],"title":"VaultListOut"},"VaultOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"tenant_id":{"type":"string","format":"uuid","title":"Tenant Id"},"name":{"type":"string","title":"Name"},"slug":{"type":"string","title":"Slug"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"intended_use":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intended Use"},"environment_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Environment Label"},"status":{"type":"string","title":"Status"},"state_count":{"type":"integer","title":"State Count","default":0},"api_call_count":{"type":"integer","title":"Api Call Count","default":0},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","tenant_id","name","slug","status","created_at","updated_at"],"title":"VaultOut"},"VersionOut":{"properties":{"service":{"type":"string","title":"Service"},"release":{"type":"string","title":"Release"}},"type":"object","required":["service","release"],"title":"VersionOut"}}}}